class cymel.core.cyobjects.node.Node

Inheritance diagram of Node
class cymel.core.cyobjects.node.Node(*args, **kwargs)

ベースクラス: Node_c

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

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

Methods:

addAttr([longName, type, subType, ...])

アトリビュートを追加する。

aliases()

別名が定義されているアトリビュートのリストを得る。

assignUUID(val[, py])

UUID をアサインする。

delete()

ノードを削除する。

listAliases()

aliases の別名。

listAttr(**kwargs)

plugs の別名。

lock([val])

setLocked の別名。

namespace()

ネームスペースを得る。

plugs(**kwargs)

指定した条件にマッチするプラグのリストを得る。

referenceNode()

ノードがリファレンスの場合、それを管理する reference ノードを得る。

rename(name[, ignoreShape])

リネームする。

setLocked([val])

ロック、又はアンロックする。

setNamespace(ns[, ignoreShape])

ネームスペースをセットする。

unlock()

アンロックする。

uuid([new, py])

UUID を得る。

Methods Details:

addAttr(longName='', type=None, subType=None, channelBox=False, childNames=None, childShortNames=None, childSuffixes=None, proxy=None, getPlug=False, **kwargs)

アトリビュートを追加する。

addAttr コマンドを使いやすくするラッパーである。

  • 型名の指定で -at と -dt を使い分ける煩わしさから解放。

  • コンパウンドの子の自動生成（特に double3 等の数値コンパウンド）。

  • proxy 指定の簡易化。

  • デフォルト値や最大値や最小値の指定を改善。

    • -dt 型でもデフォルト値を指定可能。

    • matrix 型は Matrix でも Transformation でも指定可能。

    • 数値コンパウンドでは list 形式での子の値を指定可能。

    • addAttr コマンドの振る舞いの通り、 内部単位（例えば角度ならラジアン）で指定する。

  • addAttr コマンドのオプションも全て利用可能。

パラメータ:

  • longName|ln (str) -- アトリビュートのロング名。 最低限、ロング名のショート名のどちらかの指定が必要。

  • type (str) --

    アトリビュートのタイプ名。省略時は double となる。

    attibuteType(at)系とdataType(dt)系の違いを気にせずに 指定することができる。 中にはどちらにも同じ型名が存在するものがあるが、 その場合はより一般的な方が採用される （例えば matrix は dt となり、double3 は at となる）。

    タイプ名に at: か dt: の接頭辞を付加することで どちらの型かを明示することができる。 ちなみに Plug.type は、 同じ型名が2バージョン存在する場合はこの形式で返す。

    このオプションではなく、本来の attibuteType(at) か dataType(dt) を使用して明示することもできる。

    proxy を指定した場合は、このオプションは無効となり、 強制的にそれと同じタイプになる。

    double3 等の数値コンパウンドタイプの場合は、 子アトリビュートも自動生成される。 子のタイプや名前も自動決定されるが、 subType、childNames、childShortNames、childSuffixes で明示することもできる。

    一般コンパウンドタイプ(compound)の場合でも、 subType（デフォルトは double ）が共通の場合に限り、 childNames、childShortNames、childSuffixes のいずれかを指定することで、子を自動生成できる。

  • subType (str) --

    コンパウンドの子が自動生成される場合の、共通の子タイプを指定する。 attibuteType(at)系のみを指定可能。

    double3 等の数値コンパウンドの子のタイプ名を明示することを 主目的とするオプションだが、その場合 doubleLinear や doubleAngle などの単位付きアトリビュートと したい場合だけ明示すれば良い。

  • channelBox|cb (bool) -- channelBox フラグを指定する。

  • childNames (sequence) -- コンパウンドの子アトリビュートのロング名を指定するリスト。 省略すると childSuffixes から自動で決まる。

  • childShortNames (sequence) -- コンパウンドの子アトリビュートのショート名を指定するリスト。 省略すると childSuffixes から自動で決まる。

  • childSuffixes (sequence) -- コンパウンドの子アトリビュート名を親名に準じた名前に 自動指定するためのロング名用の接尾辞リスト。 ショート名用には小文字化されたものになる。 省略すると usedAsColor かどうかによって XYZW か RGBA になる。

  • proxy|pxy -- プロキシアトリビュートを追加する場合のマスターアトリビュートを指定する。 これを指定した場合は usedAsProxy(uac) オプションは自動指定されるので 指定不要である。

  • getPlug (bool) -- 戻り値として Plug を得るかどうか。

  • kwargs -- その他、 addAttr コマンドのオプションを指定可能。

戻り値の型:

None or Plug

aliases()

別名が定義されているアトリビュートのリストを得る。

別名と Plug のペアのリストが得られる。

戻り値の型:

list

assignUUID(val, py=False)

UUID をアサインする。

パラメータ:

  • val (UUID) -- アサインする UUID を指定する。 py=True の場合は None を指定して消去することもできる。

  • py (bool) --

    Maya 標準機能ではなく Python の機能を使って生成する UUID は uuid という名前のアトリビュートに保存される。 2016 未満では常に True 扱いとなる。

    2016 以降では、 それ以前に作られたファイルをリファレンスしていると シーンを開くたびにUUIDが変わってしまう問題を 回避する目的で利用できる。

delete()

ノードを削除する。

listAliases()

aliases の別名。

listAttr(**kwargs)

plugs の別名。

lock(val=True)

setLocked の別名。

namespace()

ネームスペースを得る。

戻り値の型:

Namespace

plugs(**kwargs)

指定した条件にマッチするプラグのリストを得る。

listAttr コマンドの単純なラッパーであり、 オプションで条件を指定しなければ、 ノードの全アトリビュートが得られる。

ただし、 m=True を指定しなければマルチ要素は得られない。 また、 worldSpace アトリビュートの場合は、 m=True を指定しても要素は得られない （worldSpace の場合はインデックスを明示しない方が良いため）。

戻り値の型:

list

referenceNode()

ノードがリファレンスの場合、それを管理する reference ノードを得る。

戻り値の型:

Reference or None

rename(name, ignoreShape=False)

リネームする。

パラメータ:

  • name (str) -- 新しい名前。

  • ignoreShape (bool) -- シェイプの名前は維持する。

setLocked(val=True)

ロック、又はアンロックする。

パラメータ:

val (bool) -- True だとロック、 False だとアンロック。

setNamespace(ns, ignoreShape=False)

ネームスペースをセットする。

パラメータ:

  • ns (str) -- ネームスペース。

  • ignoreShape (bool) -- シェイプの名前は維持する。

unlock()

アンロックする。

uuid(new=False, py=False)

UUID を得る。

パラメータ:

  • new (bool) -- 既存の ID 破棄して新しい ID を割り当てる。

  • py (bool) --

    Maya 標準機能ではなく Python の機能を使って生成する UUID は uuid という名前のアトリビュートに保存される。 2016 未満では常に True 扱いとなる。

    2016 以降では、 それ以前に作られたファイルをリファレンスしていると シーンを開くたびにUUIDが変わってしまう問題を 回避する目的で利用できる。

戻り値の型:

UUID

注釈

指定UUIDをアサインするには assignUUID 、 UUIDからノードを得るには CyObject.byUUID を利用する。