ViewObject API/it: Difference between revisions

Revision as of 22:51, 15 November 2014

When the GUI is up, each object in the FreeCAD document has an associated ViewObject, that resides in the FreeCADGui document counterpart. A view object can be retrieved by two ways. Example:

myViewObj = FreeCAD.ActiveDocument.myObjectName.ViewObject
myViewObj = FreeCADGui.ActiveDocument.myObjectName
print myViewObj.IV

Annotation

Returns: the annotation node of a ViewObject

BoundingBox

Returns: the bounding box

Content

Returns: an XML representation of a ViewObject's properties

DisplayMode

Returns: the current display mode

IV

Returns: an Inventor representation of the ViewObject

Object

Returns: the associated FreeCAD Document Object of this ViewObject

PropertiesList

Returns: a list of properties of this ViewObject

RootNode

Returns: the Inventor node of this ViewObject (pivy.coin object)

Selectable

Returns: True if the object is selectable

Type

Returns: the type of this ViewObject

Visibility

Returns: True if the viewObject is visible

getAllDerivedFrom( )

Description:

Returns: all descentences of this object

getDocumentationOfProperty( )

Description:

Returns: the documentation string of the property of this class.

getGroupOfProperty( )

Description:

Returns: the name of the group which the property belongs to in this class. The properties sorted in differnt named groups for convenience.

getPropertyByName( )

Description:

Returns: the value of a named property.

getTypeOfProperty( )

Description:

Returns: the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination.

hide( )

Description: Hides the object.

Returns:

isDerivedFrom(string)

Description: Checks if this object is derived from the given object type

Returns: True if given type is a father

isVisible( )

Description: Checks if the object is visible

Returns: a boolean

listDisplayModes( )

Description: Shows a list of all display modes

Returns: a list

setTransformation(coin.SoTransform)

Description: Sets a transformation on the Inventor node

Returns: nothing

show( )

Description: Shows the object if hidden

Returns: nothing

toString( )

Description:

Returns: a string representation of the Inventor node

update( )

Description: Updates the view representation of the object

Returns:

Other languages:

@@ Line 1: / Line 1: @@
+When the GUI is up, each object in the FreeCAD document has an associated ViewObject, that resides in the FreeCADGui document counterpart. A view object can be retrieved by two ways. Example:
-=API di ViewObject=
-Quando la GUI è attiva, a ogni oggetto del documento FreeCAD è associato un ViewObject, che risiede nella controparte FreeCADGui del documento. Un oggetto della vista può essere recuperato in due modi. Esempio:
  myViewObj = FreeCAD.ActiveDocument.myObjectName.ViewObject
  myViewObj = FreeCADGui.ActiveDocument.myObjectName
  print myViewObj.IV
 {{APIProperty|Annotation|the annotation node of a ViewObject}}
@@ Line 31: / Line 30: @@
 {{APIFunction|update| |Updates the view representation of the object| }}
+[[Category:API]]
-{{languages/it | {{en|ViewObject_API}} {{es|ViewObject_API/es}} }}
+{{clear}}
-[[Category:API/it]]
+<languages/>