class cymel.core.cyobjects.plug_c.Plug_c

Inheritance diagram of Plug_c
class cymel.core.cyobjects.plug_c.Plug_c(src)

ベースクラス: CyObject

Plug クラスでサポートする機能の中核。

Methods:

addProxy(name[, node])

このプラグに対するプロキシアトリビュートを生成する。

affectedAttrs([worldSpace, pcls])

このプラグが同一ノード内で影響を与えるプラグのリストを得る。

affectingAttrs([worldSpace, pcls])

このプラグが同一ノード内で影響を受けるプラグのリストを得る。

alias()

別名を得る。

apiGetSetNullProc()

undoに対応せずに Null をセットするための関数を得る。

apiGetUndoSetProc()

undoに対応せずに現在の値をセットするための関数を得る。

apiSetDefault(val[, reset, force])

undoに対応せずにアトリビュートのデフォルト値を内部単位でセットする。

apiSetDefaultu(val[, reset, force])

undoに対応せずにアトリビュートのデフォルト値をUI設定単位でセットする。

apiSetLocked(val)

undoに対応せずにプラグのロック状態をセットする。

array()

要素からマルチアトリビュートを得る。

attrName()

ノード名を含まずに、ドットから始まるプラグ名を得る。

child(idx)

コンパウンドアトリビュートの idx 番目の子を得る。

childNames([long])

コンパウンドアトリビュートの子アトリビュート名リストを得る。

children()

コンパウンドアトリビュートの子のリストを得る。

connectedElement(idx)

マルチアトリビュートのコネクトされている要素を物理インデックスで得る。

connectedElementIndices()

マルチアトリビュートのコネクトされている要素のインデックスのリストを得る。

connectedElements()

マルチアトリビュートのコネクトされている要素リストを得る。

connections([s, d, c, t, et, scn, source, ...])

コネクトされているプラグやノードのリストを得る。

default()

デフォルト値を内部単位で得る。

defaultu()

デフォルト値をUI設定単位で得る。

destinations(**kwargs)

unitConversionノードをスキップしつつ、出力先のプラグかノードのリストを得る。

destinationsWithConversions(**kwargs)

unitConversionノードをスキップせずに、出力先のプラグかノードのリストを得る。

disconnectBehavior()

マルチアトリビュートの要素の削除時の振る舞いを得る。

element(idx)

マルチアトリビュートの要素を物理インデックスで得る。

elementExists([idx])

マルチアトリビュートの要素が存在しているかどうか。

elements()

マルチアトリビュートの要素のリストを得る。

enumName(val)

enum アトリビュートの値から名前を得る。

enumValue(key)

enum アトリビュートの名前から値を得る。

evaluate()

このプラグを評価する。

evaluateNumElements()

マルチアトリビュートを評価した上で要素数を得る。

evaluator()

呼び出すとプラグを評価できる関数を得る。

get()

アトリビュート値を内部単位で得る。

getEnumName()

enum 型アトリビュートから現在の値の名前を得る。

getM()

matrix 型アトリビュートから matrix 値を得る。

getProxies()

関連付けられたプロキシアトリビュートを全て得る。

getu()

アトリビュート値をUI設定単位で得る。

hasMax()

最大値を持っているかどうか。

hasMin()

最小値を持っているかどうか。

hasNodeFn(fn)

ノードが指定ファンクションタイプと互換性があるかどうか。

hasProxy()

関連付けられたプロキシアトリビュートを持つかどうか。

hasSoftMax()

ソフト最大値を持っているかどうか。

hasSoftMin()

ソフト最小値を持っているかどうか。

hasTransformation()

matrix 型アトリビュートが Transformation 値を持つかどうか。

index()

マルチアトリビュートの要素の論理インデックスを得る。

indexMatters()

マルチ要素のインデックスが意味を持つかどうか。

indices()

マルチアトリビュートの論理インデックスのリストを得る。

inputs(**kwargs)

上流のコネクションを得る。

isAffectsAppearance()

ビューポートに影響を与えるかどうか。

isAffectsWorldSpace()

ワールドスペースに影響を与えるかどうか。

isArray()

マルチアトリビュートかどうか。

isAttrFromReferencedFile()

アトリビュートがリファレンスファイルのものかどうか。

isCached([static])

値がデータブロックにキャッシュされるかどうか。

isCaching([static])

値がデータブロックにキャッシュされるかどうか。

isChannelBox([static])

Keyable でなくてもチャンネルボックスに出すかどうか。

isChild()

コンパウンドの子アトリビュートかどうか。

isCompound()

コンパウンドアトリビュートかどうか。

isConnectable()

コネクト可能かどうか。

isConnected([ancestors, children])

入力か出力のコネクションを持つかどうか。

isConnectedTo(dst)

このプラグから指定プラグへ向かう接続が在るかどうか検査する。

isDestination([ancestors, children])

入力コネクションを持つかどうか。

isDynamic()

ダイナミックアトリビュートかどうか。

isElement()

マルチアトリビュートの要素かどうか。

isEnforcingUniqueName()

これが固有のアトリビュート名であることをノードに強制しているかどうか。

isExtension()

拡張アトリビュートかどうか。

isFreeToChange([ancestors, children])

プラグの値が変更可能な状態にあるかどうか検査する。

isFromReferencedFile([ancestors, children])

リファレンスファイルで作られた入力コネクションを持つかどうか。

isHidden()

隠しアトリビュートかどうか。

isIgnoredWhenRendering()

レンダリング中にはコネクションが無視されるかどうか。

isIndeterminant()

Hint to DG that this attr may not always be used when computing the attrs which are dependent upon it.

isIndexMatters()

indexMatters の別名。

isInternal()

インターナルアトリビュートかどうか。

isKeyable()

Keyable かどうか。

isLocked([ancestors, children])

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

isMulti()

isArray の別名。

isNewAttr()

isNewAttribute の別名。

isNewAttribute()

リファレンスではないアトリビュートかどうか。

isNodeFromReferencedFile()

ノードがリファレンスファイルのものかどうか。

isNodeType(typename)

ノードが指定タイプの派生型かどうか。

isNotInstanced()

解決されていないマルチアトリビュート要素が含まれているかどうか。

isProcedural()

Maya が内部的に使用する手続き型プラグかどうか。

isProxy()

プロキシアトリビュートかどうか。

isReadable()

読めるか（値をゲットしたりコネクションの入力元と成り得るか）どうか。

isRenderSource()

レンダーソースかどうか。

isSettable([ancestors, children])

isWritableNow の別名。

isSource([ancestors, children])

出力コネクションを持つかどうか。

isStorable()

ファイルに保存されるかどうか。

isUsedArrayDataBuilder()

API の MArrayDataBuilder が使われるかどうか。

isUsedAsColor()

カラーとして使われるものかどうか。

isUsedAsFilename()

ファイル名として使われるものかどうか。

isValidWorldElement()

isWorldSpace な要素プラグの場合にインデックスがDAGノードのインスタンス番号と矛盾が無いかどうか。

isWorldSpace()

DAGノードインスタンスに結びついたマルチアトリビュートかどうか。

isWritable()

書き込めるか（値をセットしたりコネクションの出力先と成り得るか）どうか。

isWritableNow([ancestors, children])

プラグの値が変更可能な状態にあるか。

leaves([evaluate])

マルチやコンパウンドの階層を下って、リーフのプラグのリストを得る。

longName()

アトリビュートのロング名を得る。

max()

アトリビュートに設定されている最大値を内部単位で得る。

maxu()

アトリビュートに設定されている最大値をUI設定単位で得る。

mfn()

Python API 2 のファンクションセットを得る。

mfn1()

Python API 1 のファンクションセットを得る。

mfn1_()

checkValid を省略して、 Python API 1 のファンクションセットを得る。

mfn_()

checkValid を省略して、 Python API 2 のファンクションセットを得る。

min()

アトリビュートに設定されている最小値を内部単位で得る。

minu()

アトリビュートに設定されている最小値をUI設定単位で得る。

mplug()

Python API 2 の MPlug を得る。

mplug1()

Python API 1 の MPlug を得る。

mplug1_()

checkValid を省略して、 Python API 1 の MPlug を得る。

mplug_()

checkValid を省略して、 Python API 2 の MPlug を得る。

multi()

array の別名。

newObject(data)

内部データとともにインスタンスを生成する。

nextAvailable([start, asPlug, checkLocked, ...])

マルチプラグの入力の次の空きインデックスを得る。

niceName([noWorldIndex])

ナイス名を得る。

node()

ノードを得る。

nodeName()

ノード名を得る。

nodeType()

ノードタイプ名を得る。

noderef()

ノードの弱参照ラッパーを得る。

numChildren()

コンパウンドアトリビュートの子の数を得る。

numConnectedElements()

マルチアトリビュートの接続を持つ要素数を得る。

numElements()

マルチアトリビュートの評価済みの要素数を得る。

outputs(**kwargs)

下流のコネクションを得る。

parent()

親のコンパウンドアトリビュートを得る。

pathName([useLongName, useCompression])

アトリビュートのユニークなパス名を返す。インデックスは含まない。

plug(name)

下位のプラグを得る。

plugName([short, fullAttrPath])

プラグ名を得る。

plug_(name)

checkValid を省略して、下位のプラグを得る。

proxyMaster()

プロキシアトリビュートのマスタープラグを得る。

root([completely])

コンパウンドのルートプラグを得る。

shortName()

アトリビュートのショート名を得る。

softMax()

アトリビュートに設定されているソフト最大値を内部単位で得る。

softMaxu()

アトリビュートに設定されているソフト最大値をUI設定単位で得る。

softMin()

アトリビュートに設定されているソフト最小値を内部単位で得る。

softMinu()

アトリビュートに設定されているソフト最小値をUI設定単位で得る。

source(**kwargs)

unitConversionノードをスキップしつつ、入力しているプラグかノードを得る。

sourceWithConversion(**kwargs)

unitConversionノードをスキップせずに、入力しているプラグかノードを得る。

subType()

数値コンパウンド（ double3 等）アトリビュートの要素のタイプ名を得る。

type()

アトリビュートタイプ名を得る。判別できないタイプは '' になる。

worldElement()

isWorldSpace なプラグの適切な要素を得る。

Attributes:

CLASS_TYPE = 2

ラッパークラスの種類が Plug であることを表す。

Methods Details:

addProxy(name, node=None, **kwargs)

このプラグに対するプロキシアトリビュートを生成する。

パラメータ:

  • name (str) -- アトリビュートのロング名。

  • node (Node) -- アトリビュートを追加するノード。 省略すると、このプラグのノードになる。

  • kwargs -- その他に Node.addAttr のオプション引数を指定可能。

戻り値の型:

None or Plug

affectedAttrs(worldSpace=False, pcls=None)

このプラグが同一ノード内で影響を与えるプラグのリストを得る。

逆に、影響元を得る場合は affectingAttrs が利用できる。

また、このメソッドは実際のプラグからプラグを得られるが、 実際のノードやプラグではなくノードタイプとアトリビュート名から調べるには ユーティリティ関数 affectedAttrNames が利用できる。

パラメータ:

worldSpace (bool) --

ワールドスペースアトリビュートの依存関係も確実に得るかどうか。

デフォルトの False だと、 例えば transform ノードの translate が影響を与えるアトリビュートとして matrix は得られるが worldMatrix は得ることができない。

戻り値の型:

list

affectingAttrs(worldSpace=False, pcls=None)

このプラグが同一ノード内で影響を受けるプラグのリストを得る。

逆に、影響先を得る場合は affectedAttrs が利用できる。

また、このメソッドは実際のプラグからプラグを得られるが、 実際のノードやプラグではなくノードタイプとアトリビュート名から調べるには ユーティリティ関数 affectingAttrNames が利用できる。

パラメータ:

worldSpace (bool) --

ワールドスペースアトリビュートの依存関係も確実に得るかどうか。

デフォルトの False だと、 例えば transform ノードの worldMatrix が影響を受けるアトリビュートとして translate 等を得ることはできない。

戻り値の型:

list

alias()

別名を得る。

戻り値の型:

str

apiGetSetNullProc()

undoに対応せずに Null をセットするための関数を得る。

得られる関数はこのオブジェクトの参照を保持しない。

戻り値の型:

callable

apiGetUndoSetProc()

undoに対応せずに現在の値をセットするための関数を得る。

得られる関数はこのオブジェクトの参照を保持しない。

戻り値の型:

callable

apiSetDefault(val, reset=False, force=False)

undoに対応せずにアトリビュートのデフォルト値を内部単位でセットする。

パラメータ:

  • val -- セットする値。

  • reset (bool) -- 現在の値もリセットする。

  • force (bool) -- ダイナミックアトリビュートでなくても許容する。 つまり、このプラグ以外にも影響する操作を許容するかどうか。

apiSetDefaultu(val, reset=False, force=False)

undoに対応せずにアトリビュートのデフォルト値をUI設定単位でセットする。

パラメータ:

  • val -- セットする値。

  • reset (bool) -- 現在の値もリセットする。

  • force (bool) -- ダイナミックアトリビュートでなくても許容する。 つまり、このプラグ以外にも影響する操作を許容するかどうか。

apiSetLocked(val)

undoに対応せずにプラグのロック状態をセットする。

パラメータ:

val (bool) -- セットする値。

array()

要素からマルチアトリビュートを得る。

戻り値の型:

Plug

attrName()

ノード名を含まずに、ドットから始まるプラグ名を得る。

プラグを特定する最短の名前からノード名を除去したものである。

shortName との違いは、 マルチ要素のインデックスが含まれることと、 それによるコンパウンド階層が含まれる場合もあることである。

戻り値の型:

str

child(idx)

コンパウンドアトリビュートの idx 番目の子を得る。

パラメータ:

idx (int) -- 得たい子のインデックス

戻り値の型:

Plug

childNames(long=False)

コンパウンドアトリビュートの子アトリビュート名リストを得る。

パラメータ:

long (bool) -- ロング名で得るかどうか。

戻り値の型:

list

children()

コンパウンドアトリビュートの子のリストを得る。

戻り値の型:

list

connectedElement(idx)

マルチアトリビュートのコネクトされている要素を物理インデックスで得る。

論理インデックスの並びは昇順となる。

インデックスを得たいだけなら connectedElementIndices の方が効率が良い。

パラメータ:

idx (int) -- 0 ～ numConnectedElements ()-1 の範囲の物理インデックス。

戻り値の型:

Plug

注釈

API の MPlug.connectionByPhysicalIndex(i) で得られるプラグの並び順は、 接続操作を繰り返した後は乱れていることがあり、シーンを開き直したときに整列されるようだ。 しかし、このメソッドでは、論理インデックスの昇順に得られることを保証する。

connectedElementIndices()

マルチアトリビュートのコネクトされている要素のインデックスのリストを得る。

論理インデックスの並びは昇順となる。

インデックスを得たいだけなら connectedElement や connectedElements より効率が良い。

戻り値の型:

list

注釈

API の MPlug.connectionByPhysicalIndex(i) で得られるプラグの並び順は、 接続操作を繰り返した後は乱れていることがあり、シーンを開き直したときに整列されるようだ。 しかし、このメソッドでは、論理インデックスの昇順に得られることを保証する。

connectedElements()

マルチアトリビュートのコネクトされている要素リストを得る。

論理インデックスの並びは昇順となる。

インデックスを得たいだけなら connectedElementIndices の方が効率が良い。

戻り値の型:

list

注釈

API の MPlug.connectionByPhysicalIndex(i) で得られるプラグの並び順は、 接続操作を繰り返した後は乱れていることがあり、シーンを開き直したときに整列されるようだ。 しかし、このメソッドでは、論理インデックスの昇順に得られることを保証する。

connections(s=True, d=True, c=False, t=None, et=False, scn=False, source=True, destination=True, connections=False, type=None, exactType=False, skipConversionNodes=False, asPair=False, asNode=False, checkChildren=True, checkElements=True, index=None, pcls=None)

コネクトされているプラグやノードのリストを得る。

パラメータ:

  • s|source (bool) -- 上流のコネクションを得る。

  • d|destination (bool) -- 下流のコネクションを得る。

  • c|connections|asPair (bool) -- コネクト元のプラグもエアで得る。

  • t|type (str) -- 指定したノードタイプに限定する。

  • et|exactType (bool) -- type指定の場合に、派生タイプを許容せずに 指定タイプとの厳密な一致のみとするかどうか。

  • scn|skipConversionNodes (bool) -- unitConversion 系ノードをスキップするかどうか。

  • asNode (bool) -- コネクト先をプラグではなくノードで得る。

  • checkChildren (bool) -- コンパウンドの下層もチェックする。 デフォルトで True なので False を明示すると無効化できる。

  • checkElements (bool) -- マルチプラグの要素もチェックする。 デフォルトで True なので False を明示すると無効化できる。

  • index (int) -- 結果を1つだけ得る場合にインデックスを指定する。 負数も指定可能。 結果は list ではなく単一となる（得られない場合は None ）。 範囲外を指定してもエラーにはならず None となる。

  • pcls -- 得たいプラグオブジェクトのクラス。 省略時はこのオブジェクト自身と同じクラスになる。

戻り値の型:

list

default()

デフォルト値を内部単位で得る。

defaultu()

デフォルト値をUI設定単位で得る。

destinations(**kwargs)

unitConversionノードをスキップしつつ、出力先のプラグかノードのリストを得る。

outputs に以下のオプションを指定することと同等であり、 その他のオプションは全て指定可能。

  • skipConversionNodes=True

  • checkChildren=False

  • checkElements=False

戻り値の型:

list

destinationsWithConversions(**kwargs)

unitConversionノードをスキップせずに、出力先のプラグかノードのリストを得る。

outputs に以下のオプションを指定することと同等であり、 その他のオプションは全て指定可能。

  • checkChildren=False

  • checkElements=False

戻り値の型:

list

disconnectBehavior()

マルチアトリビュートの要素の削除時の振る舞いを得る。

戻り値の型:

int

element(idx)

マルチアトリビュートの要素を物理インデックスで得る。

論理インデックスの並びは昇順となる。

パラメータ:

idx (int) -- 得たい要素の物理インデックス

戻り値の型:

Plug

elementExists(idx=None)

マルチアトリビュートの要素が存在しているかどうか。

パラメータ:

idx (int) -- 自身がマルチのとき、調べるインデックスを指定する。 自身が要素（実在は不明）のときは省略する。

戻り値の型:

bool

elements()

マルチアトリビュートの要素のリストを得る。

論理インデックスの並びは昇順となる。

戻り値の型:

list

enumName(val)

enum アトリビュートの値から名前を得る。

パラメータ:

val (int) -- enum値。

戻り値の型:

str

enumValue(key)

enum アトリビュートの名前から値を得る。

パラメータ:

key (str) -- enum名。

戻り値の型:

int

evaluate()

このプラグを評価する。

注釈

これによって、起こる変化の undo はできないことに注意。 たとえば、マルチアトリビュートの要素を評価することで 要素が追加されても undo できない。 それをやりたい場合は Plug.addElement が利用できる。

evaluateNumElements()

マルチアトリビュートを評価した上で要素数を得る。

戻り値の型:

int

警告

このメソッドは numElements より効率が悪いと思われるが、 numElements よりも信頼性がある。 なお、このメソッドを呼び出した後は numElements も同じ値を 返すようになる。

ただし、出力コネクションのプラグはこれでもカウントされない場合がある。 コネクトされた要素数を知りたい場合は numConnectedElements を利用すること。

evaluator()

呼び出すとプラグを評価できる関数を得る。

evaluate そのものが得られるとも言えるが、 自身への参照を保持していない点で異なる。

戻り値の型:

callable

get()

アトリビュート値を内部単位で得る。

MEL の場合と同様に、 isWorldSpace なアトリビュートで 要素を指定していない場合は自動的に補完される。

戻り値:

アトリビュート値。

getEnumName()

enum 型アトリビュートから現在の値の名前を得る。

getM()

matrix 型アトリビュートから matrix 値を得る。

データ型 matrix アトリビュートは、 マトリックスだけでなく トランスフォーメーション情報形式での値の保存が可能で、 get メソッドでは、保持されている値の形式に応じて Matrix か Transformation が得られる。

一方、こちらのメソッドを使用すると、 保持されている値の形式にかかわらず、常に Matrix で得ることができる。

戻り値の型:

Matrix or None

getProxies()

関連付けられたプロキシアトリビュートを全て得る。

戻り値の型:

list

getu()

アトリビュート値をUI設定単位で得る。

MEL の場合と同様に、 isWorldSpace なアトリビュートで 要素を指定していない場合は自動的に補完される。

戻り値:

アトリビュート値。

hasMax()

最大値を持っているかどうか。

戻り値の型:

bool

hasMin()

最小値を持っているかどうか。

戻り値の型:

bool

hasNodeFn(fn)

ノードが指定ファンクションタイプと互換性があるかどうか。

パラメータ:

fn (int) -- MFn タイプ。

戻り値の型:

bool

hasProxy()

関連付けられたプロキシアトリビュートを持つかどうか。

戻り値の型:

bool

hasSoftMax()

ソフト最大値を持っているかどうか。

戻り値の型:

bool

hasSoftMin()

ソフト最小値を持っているかどうか。

戻り値の型:

bool

hasTransformation()

matrix 型アトリビュートが Transformation 値を持つかどうか。

戻り値の型:

bool

index()

マルチアトリビュートの要素の論理インデックスを得る。

戻り値の型:

int

indexMatters()

マルチ要素のインデックスが意味を持つかどうか。

この値と isReadable が False の場合に connectAttr -na が使える。

戻り値の型:

bool

indices()

マルチアトリビュートの論理インデックスのリストを得る。

論理インデックスの並びは昇順となる。

戻り値の型:

list

inputs(**kwargs)

上流のコネクションを得る。

connections に s=True, d=False を指定することと同等であり、 その他のオプションは全て指定可能。

isAffectsAppearance()

ビューポートに影響を与えるかどうか。

戻り値の型:

bool

isAffectsWorldSpace()

ワールドスペースに影響を与えるかどうか。

戻り値の型:

bool

isArray()

マルチアトリビュートかどうか。

戻り値の型:

bool

isAttrFromReferencedFile()

アトリビュートがリファレンスファイルのものかどうか。

ノードがリファレンスファイルのものであっても、 その上に追加されたアトリビュートなら False となる。

isNewAttribute の逆の結果が得られる。

戻り値の型:

bool

isCached(static=False)

値がデータブロックにキャッシュされるかどうか。

パラメータ:

static (bool) -- 静的な設定をチェックする。

戻り値の型:

bool

isCaching(static=False)

値がデータブロックにキャッシュされるかどうか。

パラメータ:

static (bool) -- 静的な設定をチェックする。

戻り値の型:

bool

isChannelBox(static=False)

Keyable でなくてもチャンネルボックスに出すかどうか。

戻り値の型:

bool

isChild()

コンパウンドの子アトリビュートかどうか。

戻り値の型:

bool

isCompound()

コンパウンドアトリビュートかどうか。

戻り値の型:

bool

isConnectable()

コネクト可能かどうか。

戻り値の型:

bool

isConnected(ancestors=False, children=False)

入力か出力のコネクションを持つかどうか。

パラメータ:

  • ancestors (bool) -- 上位プラグもチェックするかどうか。

  • children (bool) -- 下位プラグもチェックするかどうか。

戻り値の型:

bool

isConnectedTo(dst)

このプラグから指定プラグへ向かう接続が在るかどうか検査する。

パラメータ:

dst (Plug) --

接続を検査する下流プラグ。

isIndexMatters が False のマルチプラグが指定された場合、 各要素とのコネクションの有無もチェックされる。

戻り値の型:

bool

isDestination(ancestors=False, children=False)

入力コネクションを持つかどうか。

パラメータ:

  • ancestors (bool) -- 上位プラグもチェックするかどうか。

  • children (bool) -- 下位プラグもチェックするかどうか。

戻り値の型:

bool

isDynamic()

ダイナミックアトリビュートかどうか。

戻り値の型:

bool

isElement()

マルチアトリビュートの要素かどうか。

戻り値の型:

bool

isEnforcingUniqueName()

これが固有のアトリビュート名であることをノードに強制しているかどうか。

Maya 2025 以降はアトリビュートごとの設定値（デフォルトは True）が返され、 それより前のバージョンだと常に True が返される。

戻り値の型:

bool

isExtension()

拡張アトリビュートかどうか。

戻り値の型:

bool

注釈

拡張アトリビュートとは 2011 で追加された 既存ノードタイプにスタティックアトリビュートを追加する機能。

isFreeToChange(ancestors=True, children=True)

プラグの値が変更可能な状態にあるかどうか検査する。

戻り値の意味は以下の通り。

  • 0 ... 変更可能。

  • 1 ... そのプラグが変更不可。

  • 2 ... 下位プラグが変更不可（children=True 指定時のみチェック）。

children=True を指定した場合にのみ

パラメータ:

  • ancestors (bool) -- 上位プラグもチェックするかどうか。

  • children (bool) -- 下位プラグもチェックするかどうか。

戻り値の型:

int

警告

戻り値 bool として評価しないこと。 戻り値は enum であり、 0 は変更可能である。

静的な writable フラグはチェックされないため、 そもそもこのアトリビュートが変更不可であっても 0 が返される点も注意。

静的な状態も考慮する場合は isWritableNow メソッドが利用できる。

isFromReferencedFile(ancestors=False, children=False)

リファレンスファイルで作られた入力コネクションを持つかどうか。

パラメータ:

  • ancestors (bool) -- 上位プラグもチェックするかどうか。

  • children (bool) -- 下位プラグもチェックするかどうか。

戻り値の型:

bool

注釈

アトリビュートそのものがリファレンスファイル由来のものかどうかを チェックするには isAttrFromReferencedFile が利用できる。

isHidden()

隠しアトリビュートかどうか。

戻り値の型:

bool

isIgnoredWhenRendering()

レンダリング中にはコネクションが無視されるかどうか。

戻り値の型:

bool

isIndeterminant()

Hint to DG that this attr may not always be used when computing the attrs which are dependent upon it.

戻り値の型:

bool

isIndexMatters()

indexMatters の別名。

isInternal()

インターナルアトリビュートかどうか。

戻り値の型:

bool

isKeyable()

Keyable かどうか。

戻り値の型:

bool

isLocked(ancestors=True, children=False)

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

パラメータ:

  • ancestors (bool) -- 上位プラグもチェックするかどうか。

  • children (bool) -- 下位プラグもチェックするかどうか。

戻り値の型:

bool or int

警告

デフォルトは ancestors=True であるため、 上位プラグがロックされていればロック扱いとなる。

また、仮に False を指定したとしても、 Maya の API の制限により、 厳密なチェックはできない場合が多くある。 そのため、上位でロックされているものの、 そのプラグそのものがロックされているかどうか不明な場合は True ではなく 1 が返される。

isMulti()

isArray の別名。

isNewAttr()

isNewAttribute の別名。

isNewAttribute()

リファレンスではないアトリビュートかどうか。

そもそもノードがリファレンスファイルのものでないか、 ファイルリファレンスした後に追加されたアトリビュートの場合に True となる。

isAttrFromReferencedFile の逆の結果が得られる。

戻り値の型:

bool

isNodeFromReferencedFile()

ノードがリファレンスファイルのものかどうか。

戻り値の型:

bool

isNodeType(typename)

ノードが指定タイプの派生型かどうか。

パラメータ:

typename (str) -- ノードタイプ名。

戻り値の型:

bool

isNotInstanced()

解決されていないマルチアトリビュート要素が含まれているかどうか。

要素化されていなかったり -1 の要素が含まれている場合に True となる。

戻り値の型:

bool

isProcedural()

Maya が内部的に使用する手続き型プラグかどうか。

戻り値の型:

bool

isProxy()

プロキシアトリビュートかどうか。

戻り値の型:

bool

isReadable()

読めるか（値をゲットしたりコネクションの入力元と成り得るか）どうか。

戻り値の型:

bool

isRenderSource()

レンダーソースかどうか。

戻り値の型:

bool

isSettable(ancestors=True, children=True)

isWritableNow の別名。

isSource(ancestors=False, children=False)

出力コネクションを持つかどうか。

パラメータ:

  • ancestors (bool) -- 上位プラグもチェックするかどうか。

  • children (bool) -- 下位プラグもチェックするかどうか。

戻り値の型:

bool

isStorable()

ファイルに保存されるかどうか。

戻り値の型:

bool

isUsedArrayDataBuilder()

API の MArrayDataBuilder が使われるかどうか。

戻り値の型:

bool

isUsedAsColor()

カラーとして使われるものかどうか。

戻り値の型:

bool

isUsedAsFilename()

ファイル名として使われるものかどうか。

戻り値の型:

bool

isValidWorldElement()

isWorldSpace な要素プラグの場合にインデックスがDAGノードのインスタンス番号と矛盾が無いかどうか。

そもそも isWorldSpace でなかったり、要素プラグでない場合や 未解決なインデックス要素(-1)の場合にも True が返される。

戻り値の型:

bool

isWorldSpace()

DAGノードインスタンスに結びついたマルチアトリビュートかどうか。

戻り値の型:

bool

isWritable()

書き込めるか（値をセットしたりコネクションの出力先と成り得るか）どうか。

戻り値の型:

bool

isWritableNow(ancestors=True, children=True)

プラグの値が変更可能な状態にあるか。

パラメータ:

  • ancestors (bool) -- 上位プラグもチェックするかどうか。

  • children (bool) -- 下位プラグもチェックするかどうか。

戻り値の型:

bool

leaves(evaluate=False)

マルチやコンパウンドの階層を下って、リーフのプラグのリストを得る。

パラメータ:

evaluate (bool) -- 未評価のマルチ要素プラグを取りこぼさないように、 マルチプラグを評価する。

戻り値の型:

list

longName()

アトリビュートのロング名を得る。

戻り値の型:

str

max()

アトリビュートに設定されている最大値を内部単位で得る。

maxu()

アトリビュートに設定されている最大値をUI設定単位で得る。

mfn()

Python API 2 のファンクションセットを得る。

戻り値の型:

MFnAttribute の派生

mfn1()

Python API 1 のファンクションセットを得る。

戻り値の型:

MFnAttribute の派生

mfn1_()

checkValid を省略して、 Python API 1 のファンクションセットを得る。

戻り値の型:

MFnAttribute の派生

mfn_()

checkValid を省略して、 Python API 2 のファンクションセットを得る。

戻り値の型:

MFnAttribute の派生

min()

アトリビュートに設定されている最小値を内部単位で得る。

minu()

アトリビュートに設定されている最小値をUI設定単位で得る。

mplug()

Python API 2 の MPlug を得る。

戻り値の型:

MPlug

mplug1()

Python API 1 の MPlug を得る。

戻り値の型:

MPlug

mplug1_()

checkValid を省略して、 Python API 1 の MPlug を得る。

戻り値の型:

MPlug

mplug_()

checkValid を省略して、 Python API 2 の MPlug を得る。

戻り値の型:

MPlug

multi()

array の別名。

classmethod newObject(data)

内部データとともにインスタンスを生成する。

内部データはブラックボックスであるものとし、 本メソッドをオーバーライドする場合も、 基底メソッドを呼び出して処理を完遂させなければならない。

内部データを拡張する場合は internalData も オーバーライドすること。

パラメータ:

  • cls (type) -- 生成するインスタンスのクラス。

  • data -- インスタンスにセットする内部データ。

戻り値の型:

指定クラス

nextAvailable(start=-1, asPlug=False, checkLocked=True, checkChildren=True)

マルチプラグの入力の次の空きインデックスを得る。

isIndexMatters 設定に限らず利用できる。

パラメータ:

  • start (int) -- 検索を開始するインデックス。 デフォルトだと、最後のコネクションの次のインデックスからとなる。 途中のインデックスも見つけるなら 0 などを指定する。

  • asPlug (bool) -- 結果を Plug で得る。

  • checkLocked (bool) -- ロックされたプラグをスキップする。

  • checkChildren (bool) -- コンパウンドの子やその中のマルチもチェックする。

戻り値の型:

int or Plug

niceName(noWorldIndex=False)

ナイス名を得る。

戻り値の型:

str

node()

ノードを得る。

戻り値の型:

Node 派生クラス

nodeName()

ノード名を得る。

戻り値の型:

str

nodeType()

ノードタイプ名を得る。

戻り値の型:

str

noderef()

ノードの弱参照ラッパーを得る。

戻り値の型:

ObjectRef

numChildren()

コンパウンドアトリビュートの子の数を得る。

戻り値の型:

int

numConnectedElements()

マルチアトリビュートの接続を持つ要素数を得る。

この数に基づいて要素を得るには connectedElement を利用できる。

戻り値の型:

int

注釈

接続数を得たい場合に最も確実なメソッドである。 numElements や evaluateNumElements ではアクセス出来ない 場合がある出力のみのプラグもカウントされる。

numElements()

マルチアトリビュートの評価済みの要素数を得る。

この数に基づいて要素を得るには element を利用できる。

戻り値の型:

int

警告

コネクトされていても未評価のプラグはカウントされない点に注意。

評価を保証したい場合は evaluateNumElements を使用すること。 evaluateNumElements を呼び出した後は、このメソッドも同じ値を 返すようになり、これに依存した操作も期待通り動作する。

outputs(**kwargs)

下流のコネクションを得る。

connections に s=False, d=True を指定することと同等であり、 その他のオプションは全て指定可能。

parent()

親のコンパウンドアトリビュートを得る。

戻り値の型:

Plug

pathName(useLongName=True, useCompression=True)

アトリビュートのユニークなパス名を返す。インデックスは含まない。

Maya 2025 以降で非ユニーク名なら . (ドット) で区切られたパスが返される。 ユニーク名で且つ useCompression=True (デフォルト) か、 2024 以前なら常に単一のアトリビュート名が返される。

パラメータ:

  • useLongName (bool) -- デフォルトの True だとロング名が使用される。 False を指定するとショート名が使用される。

  • useCompression (bool) -- デフォルトの True だと可能な限り短いパス名が返される （DAGパスでいうところの partial path name ）。 False を指定するとトップレベルからのパス名が返されるが、 ユニークである限り先頭のドットは付加されない（APIの挙動）。

戻り値の型:

str

plug(name)

下位のプラグを得る。

Python属性としても同じように取得できるが、 Pythonの名前と衝突する場合のためにこのメソッドがある。

パラメータ:

name (str) -- アトリビュート名。

戻り値の型:

Plug

plugName(short=False, fullAttrPath=False)

プラグ名を得る。

パラメータ:

  • short (bool) -- アトリビュート名をショート名で得るかどうか。

  • fullAttrPath (bool) -- コンパウンドアトリビュート階層をフルパスで得るかどうか。

戻り値の型:

str

plug_(name)

checkValid を省略して、下位のプラグを得る。

Python属性としても同じように取得できるが、 Pythonの名前と衝突する場合のためにこのメソッドがある。

パラメータ:

name (str) -- アトリビュート名。

戻り値の型:

Plug

proxyMaster()

プロキシアトリビュートのマスタープラグを得る。

プロキシでなければ自身が返され、 マスターがコネクトされていないプロキシなら None が返される。

戻り値の型:

Plug

root(completely=False)

コンパウンドのルートプラグを得る。

パラメータ:

completely (bool) -- ルートがマルチ要素プラグの場合は、そこからさらにマルチプラグを得る。

戻り値の型:

Plug

shortName()

アトリビュートのショート名を得る。

戻り値の型:

str

softMax()

アトリビュートに設定されているソフト最大値を内部単位で得る。

softMaxu()

アトリビュートに設定されているソフト最大値をUI設定単位で得る。

softMin()

アトリビュートに設定されているソフト最小値を内部単位で得る。

softMinu()

アトリビュートに設定されているソフト最小値をUI設定単位で得る。

source(**kwargs)

unitConversionノードをスキップしつつ、入力しているプラグかノードを得る。

inputs に以下のオプションを指定することと同等であり、 その他のオプションは全て指定可能。

  • skipConversionNodes=True

  • checkChildren=False

  • checkElements=False

  • index=0

戻り値の型:

Plug, Node, or None

sourceWithConversion(**kwargs)

unitConversionノードをスキップせずに、入力しているプラグかノードを得る。

inputs に以下のオプションを指定することと同等であり、 その他のオプションは全て指定可能。

  • checkChildren=False

  • checkElements=False

  • index=0

戻り値の型:

Plug, Node, or None

subType()

数値コンパウンド（ double3 等）アトリビュートの要素のタイプ名を得る。

一般コンパウンドでも数値コンパウンドと同等に扱うべきタイプの場合もそのタイプが返される。 たとえば、quatNodes プラグインのクォータニオンアトリビュートは一般コンパウンドだが double となる。

戻り値の型:

str or None

type()

アトリビュートタイプ名を得る。判別できないタイプは '' になる。

戻り値の型:

str

worldElement()

isWorldSpace なプラグの適切な要素を得る。

自身がマルチでなく、その要素プラグやコンパウンドの子プラグの場合は 補正されたものが得られる。

isWorldSpace でない場合や、既に適切な要素な場合は、自身が得られる。

戻り値の型:

Plug