FreeCAD API/de

Other languages:
(October 2019) Diese Seite nicht bearbeiten. Die Informationen sind unvollständig und veraltet. Die neueste API findest du in der autogenerated API documentation, oder du generierst die Dokumentation selbst, siehe Quelldokumentation.

Dies ist das Hauptmodul (root) von FreeCAD. Es kann auch mit "App" aus dem FreeCAD Interpreter aufgerufen werden. Es enthält alles, was zur Manipulation von Dokumenten und deren Inhalt (Objekte) benötigt wird.

Beispiel: 

import FreeCAD
print FreeCAD.listDocuments()
mydoc = FreeCAD.activeDocument()
ConfigDump( )

Description: Druckt ein Dictionary (Wörterbuch), das die gesamte FreeCAD-Konfigurationsumgebung enthält.

Returns:

ConfigGet([string])

Description: Gibt den Wert des angegebenen Schlüssels zurück. Wenn kein Schlüssel angegeben ist, wird die vollständige Konfiguration zurückgegeben

Returns: Eine Zeichenfolge.

ConfigSet(string, string)

Description: Setze den angegebenen Schlüssel (erste Zeichenfolge) auf den angegebenen Wert (zweite Zeichenfolge).

Returns:

Version( )

Description: Gibt die FreeCAD-Version aus.

Returns:

activeDocument( )

Description: Gibt das aktive Dokument zurück oder None, wenn kein aktives Dokument vorhanden ist.

Returns: Ein FreeCAD-Dokument.

addExportType(string, string)

Description: Fügt einen neuen Exportdateityp zu FreeCAD hinzu. Die erste Zeichenfolge muss wie in diesem Beispiel formatiert sein: "Word-Dokument (*.doc)". Die zweite Zeichenfolge ist der Name eines Python-Skripts/Moduls, das eine export()-Funktion enthält.

Returns:

addImportType(string, string)

Description: Fügt einen neuen Importdateityp zu FreeCAD hinzu, funktioniert genauso wie addExportType, das Python-Modul muss eine open()- und/oder eine import()-Funktion enthalten.

Returns:

closeDocument(Dokumentname)

Description: Schließt das angegebene Dokument.

Returns:

getDocument(Dokumentname )

Description: Gibt ein Dokument zurück oder löst eine Ausnahme aus, wenn kein Dokument mit dem angegebenen Namen vorhanden ist.

Returns:

getExportType(string)

Description: Gibt den Namen des Moduls zurück, das den angegebenen Dateityp exportieren kann.

Returns: Eine Zeichenfolge.

getImportType(string)

Description: Gibt den Namen des Moduls zurück, das den angegebenen Dateityp importieren kann.

Returns: Eine Zeichenfolge.

listDocuments( )

Description: Gibt ein Dictionary (Wörterbuch) mit Namen und Objektzeigern aller Dokumente zurück.

Returns: Ein Dictionary (Wörterbuch) mit Namen und Objektzeigern.

newDocument([string], [hidden=False])

Description: Erstellt und gibt ein neues Dokument mit einem bestimmten Namen zurück. Der Dokumentname muss eindeutig sein, was automatisch überprüft wird. Wenn kein Name angegeben wird, erhält das Dokument den Namen "Untitled". Wenn hidden=True übergeben wird, zeigt FreeCAD im GUI-Modus das Dokument nicht an und zeigt keine Registerkarte für das Dokument an. Dies ermöglicht die Durchführung automatischer Operationen an einem temporären Dokument (oder das Erstellen und Speichern eines Dokuments), ohne die Benutzeroberfläche zu stören. Das neu erstellte Dokument.

Returns: {{{4}}}

open(string)

Description: Siehe openDocument

Returns:

openDocument(filepath, [hidden])

Description: Erstellt und gibt ein Dokument zurück und lädt eine Projektdatei in das Dokument. Das String-Argument muss auf eine vorhandene Datei verweisen. Wenn die Datei nicht vorhanden ist oder nicht geladen werden kann, wird eine E/A-Ausnahme ausgelöst. In diesem Fall bleibt das erstellte Dokument erhalten, ist jedoch leer. Wenn hidden=True übergeben wurde, dann zeigt FreeCAD im GUI-Modus das Dokument nicht an und zeigt auch keine Registerkarte für das Dokument an. Dadurch können automatische Vorgänge an einem Dokument durchgeführt und dieses geschlossen werden, ohne die Benutzeroberfläche zu stören. Das geöffnete FreeCAD-Dokument.

Returns: {{{4}}}

setActiveDocument(Dokumentname)

Description: Legt das aktive Dokument anhand seines Namens fest.

Returns:

Anwenderdokumentation