Object API: Difference between revisions
mNo edit summary |
Wandererfan (talk | contribs) m (Removed Pos property) |
||
Line 8: | Line 8: | ||
{{APIProperty|Name|the unique name of an object.}} |
{{APIProperty|Name|the unique name of an object.}} |
||
{{APIProperty|Placement|Gets/sets the Placement of an object. A placement defines an orientation (rotation) and a position (base) in 3D space. It is used when no scaling or other distortion is needed.}} |
{{APIProperty|Placement|Gets/sets the Placement of an object. A placement defines an orientation (rotation) and a position (base) in 3D space. It is used when no scaling or other distortion is needed.}} |
||
{{APIProperty|Pos|the position part of the placement}} |
|||
{{APIProperty|PropertiesList|a list of the properties of an object}} |
{{APIProperty|PropertiesList|a list of the properties of an object}} |
||
{{APIProperty|State|the FreeCAD state of an object (ie. if it needs to be recomputed)}} |
{{APIProperty|State|the FreeCAD state of an object (ie. if it needs to be recomputed)}} |
Revision as of 15:57, 14 April 2013
Being parametric, document objects in FreeCAD can have a lot of additional properties, but these are the basic ones, present in every FreeCAD Document Object. Objects can be retrieved simply by their name. Example:
myObj = FreeCAD.ActiveDocument.myObjectName print myObj.PropertiesList
Returns: Gets/sets the Placement of an object. A placement defines an orientation (rotation) and a position (base) in 3D space. It is used when no scaling or other distortion is needed.
Description:
Returns: the documentation string of the property of this class.
Description:
Returns: the name of the group which the property belongs to in this class. The properties sorted in differnt named groups for convenience.
Description:
Returns: the type of a named property. This can be (Hidden,ReadOnly,Output) or any combination.