Object API/de

(Oktober 2019) Diese Seite nicht ändern. Diese Information ist unvollständig und veraltet. Für die letzte API siehe die (engl.) autogenerierte API-Dokumentation oder generiere die Dokumentation selbst, siehe Quellendokumentation.

Da sie parametrisch sind, können Dokumentobjekte in FreeCAD viele zusätzliche Eigenschaften haben, aber dies sind die grundlegenden Eigenschaften, die in jedem FreeCAD-Dokumentobjekt vorhanden sind. Objekte können einfach anhand ihres Namens abgerufen werden. Beispiel:

myObj = FreeCAD.ActiveDocument.myObjectName
print myObj.PropertiesList
Content

Returns: Eine XML-Darstellung der Eigenschaften eines Objekts.

Label

Returns: Ruft die Bezeichnung des Objekts ab/legt sie fest. Die Zeichenfolge kann Unicode sein.

Name

Returns: Der eindeutige Name eines Objekts.

Placement

Returns: Ruft die Platzierung eines Objekts ab/legt sie fest. Eine Platzierung definiert eine Ausrichtung (Drehung) und eine Position (Basis) im 3D-Raum. Sie wird verwendet, wenn keine Skalierung oder andere Verzerrung erforderlich ist.

PropertiesList

Returns: Eine Liste der Eigenschaften eines Objekts

State

Returns: Der FreeCAD-Status eines Objekts (d. h. ob es neu berechnet werden muss)

Type

Returns: Eine Zeichenkette, die den Typ eines Objekts beschreibt

ViewObject

Returns: Der zugehörige View Provider (FreeCADGUI-Objekt) eines Objekts

getAllDerivedFrom( )

Description:

Returns: Alle Nachkommen dieses Objekts

getDocumentationOfProperty( )

Description:

Returns: Die Dokumentationszeichenkette der Eigenschaft dieser Klasse.

getGroupOfProperty( )

Description:

Returns: Der Name der Gruppe, zu der die Eigenschaft in dieser Klasse gehört. Die Eigenschaften sind der Einfachheit halber in verschiedenen benannten Gruppen sortiert.

getPropertyByName( )

Description:

Returns: Der Wert einer benannten Eigenschaft.

getTypeOfProperty( )

Description:

Returns: Der Typ einer benannten Eigenschaft. Dies kann (Hidden, ReadOnly, Output) oder eine beliebige Kombination sein.

isDerivedFrom( )

Description:

Returns: True, wenn der angegebene Typ ein Vater ist

purgeTouched( )

Description: Markiert das Objekt als unverändert

Returns:

touch( )

Description: Markiert das Objekt als geändert (berührt)

Returns: