Object API: Difference between revisions

From FreeCAD Documentation
No edit summary
((November 2018) This information may be incomplete and outdated. For the latest API, see the autogenerated API documentation)
Line 1: Line 1:
<languages/>
<languages/>
<translate>
<translate>
{{VeryImportantMessage|(November 2018) This information may be incomplete and outdated. For the latest API, see the [https://www.freecadweb.org/api autogenerated API documentation].}}

<!--T:1-->
<!--T:1-->
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:
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:
Line 9: Line 11:
}}
}}
<translate>
<translate>



<!--T:3-->
<!--T:3-->

Revision as of 00:01, 27 November 2018

(November 2018) This information may be incomplete and outdated. For the latest API, see the autogenerated API documentation.

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
Content

Returns: An XML representation of the properties of an object.

Label

Returns: Gets/sets the objects label. The string can be unicode.

Name

Returns: The unique name of an object.

Placement

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.

PropertiesList

Returns: A list of the properties of an object

State

Returns: The FreeCAD state of an object (ie. if it needs to be recomputed)

Type

Returns: A string describing the type of an object

ViewObject

Returns: The associated View Provider (FreeCADGUI object) of an object

getAllDerivedFrom( )

Description:

Returns: All descendants 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 are sorted in different 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.

isDerivedFrom( )

Description:

Returns: True if given type is a father

purgeTouched( )

Description: Marks the object as unchanged

Returns:

touch( )

Description: Marks the object as changed (touched)

Returns: