186 lines
8.5 KiB
HTML
186 lines
8.5 KiB
HTML
<html><head><title>Object API/jp</title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><link type='text/css' href='wiki.css' rel='stylesheet'></head><body><h1>Object API/jp</h1></div>
|
||
|
||
<div id="mw-content-text" lang="en" dir="ltr" class="mw-content-ltr"><div class="mw-parser-output"><p>FreeCADのドキュメントオブジェクトはパラメトリックであるため多くの付属プロパティがあります。しかし中には全てのFreeCADドキュメントオブジェクトが持つ基礎的なものもあります。オブジェクトはその名前を使って簡単に取得することができます。
|
||
</p><p>例：
|
||
</p>
|
||
<pre>myObj = FreeCAD.ActiveDocument.myObjectName
|
||
print myObj.PropertiesList
|
||
</pre>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Content</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクトのプロパティのXML表現
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Label</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクトのラベルの取得/設定。UNICODEも使用可能です。
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Name</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクト固有の名前
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Placement</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクトのPlacementの取得/設定。Placementは3D空間での向き（rotation）と位置（base）を定義します。拡大縮小やその他の歪曲が必要でない場合に使用されます。
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Pos</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> Placementの位置情報部分
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>PropertiesList</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクトのプロパティのリスト
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>State</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクトのFreeCADでの状態（つまり再計算を必要としているかどうか）
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>Type</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクトの型を表す文字列
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Property.png" class="image"><img alt="Property.png" src="Property.png" width="16" height="16" /></a> <big><b>ViewObject</b></big></div>
|
||
<div class="description">
|
||
<p><small><b>戻り値</b>:</small> オブジェクトに関連付けられているビュープロバイダ（FreeCADGUIオブジェクト）
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getAllDerivedFrom</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small>
|
||
</p><p><small><b>戻り値</b>:</small> オブジェクトの全ての子クラス
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getDocumentationOfProperty</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small>
|
||
</p><p><small><b>戻り値</b>:</small> クラスのプロパティのドキュメント文字列
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getGroupOfProperty</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small>
|
||
</p><p><small><b>戻り値</b>:</small>
|
||
クラスの中でそのプロパティが属しているグループの名前。プロパティは便利のために異なる名前のグループに保持されています。
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getPropertyByName</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small>
|
||
</p><p><small><b>戻り値</b>:</small> 指定された名前のプロパティの値
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>getTypeOfProperty</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small>
|
||
</p><p><small><b>戻り値</b>:</small> 指定された名前のプロパティの型。Hidden、ReadOnly、Output、またはその組み合わせです。
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>isDerivedFrom</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small>
|
||
</p><p><small><b>戻り値</b>:</small> 与えられた型が親クラスである場合にはTrueを返します。
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>purgeTouched</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small> オブジェクトを変更できないようにマークします。
|
||
</p><p><small><b>戻り値</b>:</small>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p>
|
||
<div class="api">
|
||
<div class="function"><a href="https://www.freecadweb.org/wiki/index.php?title=File:Method.png" class="image"><img alt="Method.png" src="Method.png" width="16" height="16" /></a> <big><b>touch</b></big> ( <i> </i> )</div>
|
||
<div class="description">
|
||
<p><small><b>説明</b>:</small> オブジェクトを変更できるよう（触れることができるように）にマークします。
|
||
</p><p><small><b>戻り値</b>:</small>
|
||
</p>
|
||
</div>
|
||
</div>
|
||
<p><br />
|
||
</p><p><br />
|
||
</p>
|
||
|
||
|
||
|
||
|
||
</div>
|
||
|
||
</div><div class="printfooter">
|
||
Online version: "<a dir="ltr" href="https://www.freecadweb.org/wiki/index.php?title=Object_API/jp&oldid=16188">http://www.freecadweb.org/wiki/index.php?title=Object_API/jp&oldid=16188</a>"</div>
|
||
<div id="catlinks" class="catlinks" data-mw="interface"></div><div class="visualClear"></div>
|
||
</div>
|
||
</div>
|
||
<div id="mw-navigation">
|
||
<h2>Navigation menu</h2>
|
||
|
||
</body></html> |