Object API/de

From FreeCAD Documentation
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
This page is a translated version of the page Object API and the translation is 25% complete.
(Oktober 2019) Bearbeite diese Seiten nicht. Die Informationen sind unvollständig und veraltet. Die neueste API findest Du in der autogenerierten API-Dokumentation oder generiere die Dokumentation selbst, siehe Quelldokumentation.

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: