ViewObject_API.md

ViewObject API

(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the [https://www.freecadweb.org/api autogenerated API documentation], or generate the documentation yourself, see Source documentation.

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

{{APIProperty|Annotation|the annotation node of a ViewObject}}

{{APIProperty|BoundingBox|the bounding box}}

{{APIProperty|Content|an XML representation of a ViewObject's properties}}

{{APIProperty|DisplayMode|the current display mode}}

{{APIProperty|IV|an Inventor representation of the ViewObject}}

{{APIProperty|Object|the associated FreeCAD Document Object of this ViewObject}}

{{APIProperty|PropertiesList|a list of properties of this ViewObject}}

{{APIProperty|RootNode|the Inventor node of this ViewObject (pivy.coin object)}}

{{APIProperty|Selectable|True if the object is selectable}}

{{APIProperty|Type|the type of this ViewObject}}

{{APIProperty|Visibility|True if the viewObject is visible}}

{{APIFunction|getAllDerivedFrom| | |all descentences of this object}}

{{APIFunction|getDocumentationOfProperty| | |the documentation string of the property of this class.}}

{{APIFunction|getGroupOfProperty| | |the name of the group which the property belongs to in this class. The properties sorted in differnt named groups for convenience.}}

{{APIFunction|getPropertyByName| | |the value of a named property.}}

{{APIFunction|getTypeOfProperty| | |the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination.}}

{{APIFunction|hide| |Hides the object.| }}

{{APIFunction|isDerivedFrom|string|Checks if this object is derived from the given object type|True if given type is a father}}

{{APIFunction|isVisible| |Checks if the object is visible|a boolean}}

{{APIFunction|listDisplayModes| |Shows a list of all display modes|a list}}

{{APIFunction|setTransformation|coin.SoTransform|Sets a transformation on the Inventor node|nothing}}

{{APIFunction|show| |Shows the object if hidden|nothing}}

{{APIFunction|toString| | |a string representation of the Inventor node}}

{{APIFunction|update| |Updates the view representation of the object| }}

---

⏵ documentation index > API > [Poweruser Documentation](Category_Poweruser Documentation.md) > ViewObject API