Object API/de

(November 2018) Diese Information kann unvollständig und veraltet sein. Für die letzte API siehe die (engl.) autogenerierte API-Dokumentation.

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:

Anwenderdokumentation

• Installation: Installieren auf Windows, Installieren auf Linux, Installieren auf MacOSX; Erste Schritte
• Grundlagen: Über FreeCAD, Arbeitsbereiche, Programmeinstellungen, Dokumentstruktur, Graphische Oberfläche anpassen, Objekteigenschaften, Mausbedienung; Tutorials
• Arbeitsbereiche: Arch, Draft, FEM, Image, Inspection, Mesh, OpenSCAD, Part, PartDesign, Path, Plot, Points, Raytracing, Reverse Engineering, Robot, Ship, Sketcher, Spreadsheet, Start, Surface, TechDraw, Test Framework, Web

---

• Scripting: Allgemein: Einführung in Python, FreeCAD scripting tutorial, FreeCAD Scripting Basics, Wie installiere ich Makros?, Gui Command, Units Module: Builtin modules, Erstellung von Arbeitsbereichen, Weitere Workbenches installieren Meshes (Netze): Mesh Scripting, Arbeitsbereich Mesh Teile: Arbeitsbereich Part, Topological data scripting, PythonOCC, Mesh to Part Coin scenegraph: The Coin/Inventor scenegraph, Pivy Qt-Interface: PySide, Using the FreeCAD GUI, Dialog creation Parametrische Objekte: Scripted objects Andere: Code-Schnipsel, Linienzeichnungsfunktion, Einbetten von FreeCAD, FreeCAD-Bibliothek für Vektormathematik, Übersicht für erfahrene Anwender, Grundlagen der FreeCAD-Skripterstellung, Topologisches Daten-Scripting

---

• Veraltete Arbeitsbereiche: Complete, Drawing