FreeCAD API

From FreeCAD Documentation
Revision as of 10:47, 24 January 2019 by Luc (talk | contribs) (Created page with "FreeCADの主要(ルート)モジュールです。FreeCADのインタプリタからは"App"によって呼び出すことも可能です。ドキュメントとその内...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

FreeCADの主要(ルート)モジュールです。FreeCADのインタプリタからは"App"によって呼び出すことも可能です。ドキュメントとその内容(オブジェクト)を操作するのに必要な全てが含まれています。

Example:

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


ConfigDump( )

Description: Prints a dictionary containing all the FreeCAD configuration environment.

Returns:

ConfigGet([string])

Description: Returns the value of the given key. If no key is given, the complete configuration is returned

Returns: A string.

ConfigSet(string, string)

Description: Set the given key (first string) to the given value (second string).

Returns:

Version( )

Description: Prints the FreeCAD version.

Returns:

activeDocument( )

Description: Return the active document or None if there is no active document.

Returns: A FreeCAD Document.

addExportType(string, string)

Description: Adds a new export file type to FreeCAD. The first string must be formatted like this example: "Word Document (*.doc)". The second string is the name of a python script/module containing an export() function.

Returns:

addImportType(string, string)

Description: Adds a new import file type to FreeCAD, works the same way as addExportType, the handling python module must contain an open() and/or an import() function.

Returns:

closeDocument(Document name)

Description: Closes the given document

Returns:

getDocument(Document name)

Description: Returns a document or raise an exception if there is no document with the given name.

Returns:

getExportType(string)

Description: Returns the name of the module that can export the specified filetype.

Returns: A string.

getImportType(string)

Description: Returns the name of the module that can import the specified filetype.

Returns: A string.

listDocuments( )

Description: Returns a dictionary of names and object pointers of all documents.

Returns: A dictionary of names and object pointers.

newDocument([string])

Description: Creates and returns a new document with a given name. The document name must be unique, which is checked automatically. If no name is supplied, the document will be named "Untitled".

Returns: The newly created document.

open(string)

Description: See openDocument

Returns:

openDocument(filepath)

Description: Creates and returns a document and load a project file into the document. The string argument must point to an existing file. If the file doesn't exist or the file cannot be loaded an I/O exception is thrown. In this case the created document is kept, but will be empty.

Returns: The opened FreeCAD Document.

setActiveDocument(Document name)

Description: Set the active document by its name.

Returns: