FreeCAD API

From FreeCAD Documentation
Jump to: navigation, search
This page is a translated version of the page FreeCAD API and the translation is 83% complete.

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎română
(October 2019) Do not edit this page. The information is incomplete and outdated. For the latest API, see the autogenerated API documentation, or generate the documentation yourself, see Source documentation.


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

例:

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

説明: 全てのFreeCAD環境設定が格納された辞書を表示します。

戻り値:



Method.png ConfigGet ( [string] )

説明: 与えられたキーの値を返します。キーが与えられていない場合は全ての設定が返されます。

戻り値: 文字列



Method.png ConfigSet ( string, string )

説明: 与えられたキー(一番目の文字列)に対して与えられた値(二番目の文字列)を設定します。.

戻り値:



Method.png Version ( )

説明: FreeCADのバージョンを表示します。

戻り値:



Method.png activeDocument ( )

説明: アクティブなドキュメントを返します。アクティブなドキュメントが存在しない場合はNoneを返します。

戻り値: FreeCADドキュメント



Method.png addExportType ( string, string )

説明: FreeCADに新しいエクスポートファイル形式を追加します。一番目の文字列は"Word Document (*.doc)"といった形式でなければなりません。二番目の文字列はexport()関数が定義されたPythonスクリプト/モジュールの名前です。

戻り値:



Method.png addImportType ( string, string )

説明: addExportTypeと同様に新しいインポートファイル形式を追加します。ハンドリング用Pythonモジュールには少なくともopen()関数、import()関数のどちらかが定義されていなければなりません。

戻り値:



Method.png closeDocument ( Document name )

説明: 与えられたドキュメントを閉じます。

戻り値:



Method.png getDocument ( Document name )

説明: ドキュメントを返します。与えられた名前のドキュメントが存在しない場合は例外を発生させます。

戻り値:



Method.png getExportType ( string )

説明: 指定されたファイル形式をエクスポートできるモジュールの名前を返します。

戻り値: 文字列



Method.png getImportType ( string )

説明: 指定されたファイル形式をインポートできるモジュールの名前を返します。

戻り値: 文字列



Method.png listDocuments ( )

説明: 全ドキュメント名のリストを返します。

戻り値: 名前のリスト



Method.png newDocument ( [string] )

説明: 与えられた名前のドキュメントを新しく作成して返します。ドキュメント名は固有のものでなければならず、これは自動的にチェックされます。名前を指定しない場合、ドキュメントには"Untitled"という名前が付けられます。

戻り値: 新しく作成されたドキュメント



Method.png open ( string )

説明: openDocumentを参照

戻り値:



Method.png openDocument ( filepath )

説明: ドキュメントを作成し、そのドキュメントにプロジェクトファイルを読み込んで返します。引数の文字列は存在するファイルを指していなければなりません。ファイルが存在しない場合、またはファイルを読み込めない場合にはI/O例外が投げられます。その場合に、作成されたドキュメントはそのままですが、空の状態になります。

戻り値: 開かれるFreeCADドキュメント



Method.png setActiveDocument ( Document name )

説明: 名前を使ってアクティブなドキュメントを設定します。

戻り値: