class cymel.core.cyobjects.reference.Reference

class cymel.core.cyobjects.reference.Reference(*args, **kwargs)

ベースクラス: Node

reference ノードタイプラッパークラス。

固定引数無しでのクラスインスタンス生成時のノード生成をサポート。

Methods:

associatedNS()	associatedNamespace の別名。
associatedNamespace()	関連付けられたネームスペースを得る。
byFilename(fname[, all])	解決済みのファイル名からリファレンスノードを得る。
children()	子リファレンスノードのリストを得る。
containsNode(node)	指定ノードを含んでいるかどうか。
containsNodeExactly(node)	指定ノードを直接含んでいるかどうか。
editAttrs([command, fail, success])	編集コマンドのアトリビュート名リストを得る。
editNodes([command, fail, success])	編集コマンドのノードリストを得る。
editPlugs([command, fail, success])	編集コマンドのプラグリストを得る。
editStrings([command, fail, success, namespace])	編集コマンドリストを得る。
fileName([unresolved, withoutPath, ...])	filename の別名。
filename([unresolved, withoutPath, ...])	ファイル名を得る。
importReference()	リファレンスをインポートする。
isExportEditsFile()	リファレンス編集ファイル (editMA や editMB) かどうか。
isLoaded()	リファレンスがロードされているかどうか。
isLocked()	ロックされているかどうか。
isReferenceLocked()	リファレンスがロックされているかどうか。
isRoot()	ルートリファレンスノードかどうか。
iterBreadthFirst()	リファレンス階層を幅優先反復する。
iterDepthFirst()	リファレンス階層を深さ優先反復する。
load()	ロードする。
lockReference([val])	リファレンスをロック、又はアンロックする。
nodes()	含まれているノードのリストを得る。
parent()	親リファレンスノードを得る。
referenceNode()	parent の別名。
removeReference()	リファレンスを削除する。
root()	ルートリファレンスノードを得る。
unload()	アンロードする。
unlockReference()	リファレンスをアンロックする。

Methods Details:

associatedNS()

associatedNamespace の別名。

associatedNamespace()

関連付けられたネームスペースを得る。

戻り値の型:

Namespace

classmethod byFilename(fname, all=False)

解決済みのファイル名からリファレンスノードを得る。

パラメータ:

• fname (str) -- 解決済みのファイル名。

• all (bool) -- コピー番号なしのファイル名を指定して、 それに対応する全てのリストを得る。

戻り値の型:

Referemce or None

children()

子リファレンスノードのリストを得る。

戻り値の型:

list

containsNode(node)

指定ノードを含んでいるかどうか。

パラメータ:

node (Node) -- チェックするノード。

戻り値の型:

bool

containsNodeExactly(node)

指定ノードを直接含んでいるかどうか。

パラメータ:

node (Node) -- チェックするノード。

戻り値の型:

bool

editAttrs(command=None, fail=False, success=True)

編集コマンドのアトリビュート名リストを得る。

パラメータ:

• command (str) -- コマンドの種類を指定する。 有効な値は、'addAttr'、'connectAttr'、'deleteAttr'、'disconnectAttr'、 'parent'、'setAttr'、'lock'、および'unlock'である。

• fail (bool) -- 失敗したコマンドを得るかどうか。

• success (bool) -- 成功したコマンドを得るかどうか。

戻り値の型:

list

editNodes(command=None, fail=False, success=True)

編集コマンドのノードリストを得る。

可能な限り cymel のノードオブジェクトが返されるが、 見つからない場合は文字列のまま返される。

パラメータ:

• command (str) -- コマンドの種類を指定する。 有効な値は、'addAttr'、'connectAttr'、'deleteAttr'、'disconnectAttr'、 'parent'、'setAttr'、'lock'、および'unlock'である。

• fail (bool) -- 失敗したコマンドを得るかどうか。

• success (bool) -- 成功したコマンドを得るかどうか。

戻り値の型:

list

editPlugs(command=None, fail=False, success=True)

編集コマンドのプラグリストを得る。

可能な限り cymel のプラグオブジェクトが返されるが、 見つからない場合は文字列のまま返される。

パラメータ:

• command (str) -- コマンドの種類を指定する。 有効な値は、'addAttr'、'connectAttr'、'deleteAttr'、'disconnectAttr'、 'parent'、'setAttr'、'lock'、および'unlock'である。

• fail (bool) -- 失敗したコマンドを得るかどうか。

• success (bool) -- 成功したコマンドを得るかどうか。

戻り値の型:

list

editStrings(command=None, fail=False, success=True, namespace=True)

編集コマンドリストを得る。

パラメータ:

• command (str) -- コマンドの種類を指定する。 有効な値は、'addAttr'、'connectAttr'、'deleteAttr'、'disconnectAttr'、 'parent'、'setAttr'、'lock'、および'unlock'である。

• fail (bool) -- 失敗したコマンドを得るかどうか。

• success (bool) -- 成功したコマンドを得るかどうか。

• namespace (bool) -- リファレンスによるネームスペースを付加するかどうか。 付加されるのは、親リファレンスのローカルネームスペースまで。

戻り値の型:

list

fileName(unresolved=False, withoutPath=False, withoutCopyNumber=False)

filename の別名。

filename(unresolved=False, withoutPath=False, withoutCopyNumber=False)

ファイル名を得る。

パラメータ:

• unresolved (bool) -- 指定されているファイル名をそのまま得る。 環境変数を含んでいたり、実際は存在しないパスの場合が有り得る。

• withoutPath (bool) -- パスを含まないファイル名のみを得る。

• withoutCopyNumber (bool) -- 同名ファイルの2つめ以降に付加されるコピー番号を含めない。

戻り値の型:

str

importReference()

リファレンスをインポートする。

isExportEditsFile()

リファレンス編集ファイル (editMA や editMB) かどうか。

戻り値の型:

bool

isLoaded()

リファレンスがロードされているかどうか。

戻り値の型:

bool

isLocked()

ロックされているかどうか。

戻り値の型:

bool

isReferenceLocked()

リファレンスがロックされているかどうか。

戻り値の型:

bool

isRoot()

ルートリファレンスノードかどうか。

戻り値の型:

bool

iterBreadthFirst()

リファレンス階層を幅優先反復する。

戻り値の型:

yield Reference

iterDepthFirst()

リファレンス階層を深さ優先反復する。

戻り値の型:

yield Reference

load()

ロードする。

lockReference(val=True)

リファレンスをロック、又はアンロックする。

パラメータ:

val (bool) -- ロック状態値。

nodes()

含まれているノードのリストを得る。

戻り値の型:

list

parent()

親リファレンスノードを得る。

戻り値の型:

Reference or None

referenceNode()

parent の別名。

removeReference()

リファレンスを削除する。

root()

ルートリファレンスノードを得る。

戻り値の型:

Reference

unload()

アンロードする。

unlockReference()

リファレンスをアンロックする。