vnnCompound

次へ移動: 概要 |戻り値 |関連項目 | フラグ |Python のサンプル |

概要

vnnCompound( string string , [addBackdrop=string], [addIONode=boolean], [addMetaData=[string, string]], [addNode=string], [addStatePorts=[string, string, string]], [canResetToFactory=string], [clearMetaData=string], [connected=boolean], [connectedTo=string], [connectedToInput=boolean], [connectedToOutput=boolean], [create=string], [createInputPort=[string, string]], [createOutputPort=[string, string]], [deletePort=string], [explode=string], [hidePort=[string, boolean]], [inputPort=boolean], [listNodes=boolean], [listPortChildren=string], [listPorts=boolean], [moveBackdropIn=string], [moveNodeIn=string], [movePort=[string, int]], [movePortToIONode=[string, string]], [nodeType=string], [outputPort=boolean], [portFlags=uint], [portOptions=string[]], [portValues=string], [publish=[string, string, string, boolean]], [publishGraph=[string, string, string, string]], [queryBackdropMetaDataValue=[string, string]], [queryIsImported=boolean], [queryIsReferenced=boolean], [queryMetaData=string], [queryMetaDataAsString=boolean], [queryMetaDatas=boolean], [queryPortDataType=string], [queryPortDefaultValues=string], [queryPortMetaDataValue=[string, string]], [removeBackdrop=string], [removeMetaData=[string, string]], [removeNode=string], [renameBackdrop=[string, string]], [renameNode=[string, string]], [renamePort=[string, string]], [resetPortDefaultValues=string], [resetToFactory=string], [saveAs=string], [setBackdropMetaDataValue=[string, string, string]], [setIsReferenced=boolean], [setMetaData=[string, string[]]], [setMetaDataFromString=string], [setPortDataType=[string, string]], [setPortDefaultValues=[string, string[]]], [setPortMetaDataValue=[string, string, string]], [specializedTypeName=boolean])

注: オブジェクトの名前と引数を表す文字列は、カンマで区切る必要があります。これは概要には示していません。

vnnCompound は取り消しが可能で、照会不可能および編集不可能です。

戻り値

関連項目

フラグ

ロング ネーム(ショート ネーム)	引数タイプ	プロパティ
addBackdrop(ab)	string
コンパウンドにバックドロップを追加します。
addIONode(aio)	boolean
コンパウンドに入力または出力ノードを追加します。
addMetaData(amd)	[string, string]
メタデータに値を追加します。引数の順序は、メタデータ名、追加するメタデータ値です。
addNode(an)	string
コンパウンドにノードを追加します。
addStatePorts(asp)	[string, string, string]
リンクされた新しい入力ポートと出力ポートを追加します。引数の順序は、入力ポート名、出力ポート名、両方のポートに割り当てるデータ タイプです。
canResetToFactory(crf)	string
指定したコンパウンドがその初期状態にリセットできるかどうかを照会します。
clearMetaData(cmd)	string
メタデータのすべての値を削除します。引数はメタデータの名前です。
connected(cn)	boolean
「listNodes」または「listPorts」と一緒に使用すると、引数が true の場合に接続されているノードまたは内部ノードを照会します。 引数が false の場合は、接続されてないすべてのノードを返します。接続の反対側は別のノードまたはポートにできます。
connectedTo(ct)	string
「listNodes」と一緒に使用すると、指定したポートに接続されているすべてのノードが照会されます。
connectedToInput(cti)	boolean
「listNodes」と一緒に使用すると、すべての入力ポートに接続されているすべてのノードが照会されます。
connectedToOutput(cto)	boolean
「listNodes」と一緒に使用すると、すべての出力ポートに接続されているすべてのノードが照会されます。
create(c)	string
指定したコンパウンド内に下位のコンパウンドを作成します。作成された下位のコンパウンドの名前は、指定したコンパウンドの前では使用できません。
createInputPort(cip)	[string, string]
コンパウンド内に入力ポートを作成します。最初の引数はポートの名前です。2 番目の引数は、ポートのデータ タイプです。
createOutputPort(cop)	[string, string]
コンパウンドの出力ポートを作成します。最初の引数はポートの名前です。2 番目の引数は、ポートのデータ タイプです。
deletePort(dp)	string
コンパウンドの入力または出力ポートを削除します。
explode(ec)	string
指定したコンパウンドを分解して、そこからその親にノードを移動します。
hidePort(hp)	[string, boolean]
コンパウンド内の入力ポートを非表示または表示にします。
inputPort(ip)	boolean
「listPorts」と一緒に使用すると、コンパウンドのいずれかの入力ポートに接続されているすべての内部ポートが照会されます。
listNodes(ln)	boolean
コンパウンド内のすべてのノードを表示します。「dataType」、「connectedToInput」などの他のフラグと一緒に使用して、指定されたノードの一部を照会することができます。返される結果はノード名のリストです。
listPortChildren(lpc)	string
指定したポートの子をリストします。
listPorts(lp)	boolean
入力ポートと出力ポートを含む、コンパウンド内のすべての内部ポートを表示します。「output」、「connected」などの他のフラグと一緒に使用して、指定されたポートの一部を照会することができます。
moveBackdropIn(mbi)	string
新しいコンパウンドを作成する場合は、バックドロップごとにこの引数を 1 回使用して、新しいコンパウンドに移動します
moveNodeIn(mi)	string
新しいコンパウンドを作成する場合は、ノードごとにこの引数を 1 回使用して、新しいコンパウンドに移動します
movePort(mp)	[string, int]
コンパウンド内の指定したインデックスにポートを移動します。
movePortToIONode(mpn)	[string, string]
コンパウンドの別の入出力ノードにポートを移動します
nodeType(nt)	string
「listNodes」と一緒に使用すると、コンパウンド内の指定されたノード タイプのすべてのノードが照会されます。
outputPort(op)	boolean
「listPorts」と一緒に使用すると、コンパウンドのいずれかの出力ポートに接続されているすべてのノードが照会されます。
portFlags(cpf)	uint
「createInputPort」または「createOutputPort」と一緒に使用して、ポートのフラグを指定します。vnnPort コマンドを参照してください。
portOptions(cpo)	string[]
「createInputPort」または「createOutputPort」とともに使用して、作成したポートのオプションのリストを指定します。
portValues(cpv)	string
「createInputPort」または「createOutputPort」と一緒に使用して、新しいポートの既定値を指定します。
publish(pub)	[string, string, string, boolean]
コンパウンドをパブリッシュするために使用します。引数は、順に、保存先のファイル パス、コンパウンドを保存するネームスペース、nodedef に使用する名前、コンパウンドがオーバーロード可能かどうかを示すブーリアンです。
publishGraph(pbg)	[string, string, string, string]
コンパウンドをグラフとしてパブリッシュする場合に使用します。引数は、順に、保存先のファイル パス、コンパウンドを保存するネームスペース、nodedef に使用する名前、グラフに関連付けるメタデータが含まれている json プロパティ リストを含む文字列です。json プロパティ リストは、波括弧で囲まれた単純なキー/値ペアのセットである必要があります。
queryBackdropMetaDataValue(qbm)	[string, string]
指定したバックドロップのメタデータ タイプを照会します。1 番目の引数は照会するバックドロップで、2 番目の引数は照会するメタデータのタイプです。
queryIsImported(qii)	boolean
コンパウンドが読み込まれているかどうかを照会します。
queryIsReferenced(qir)	boolean
コンパウンドが参照されているかどうかを照会します。
queryMetaData(qmd)	string
メタデータ値を照会します。
queryMetaDataAsString(mas)	boolean
すべてのメタデータを文字列として取得します。形式は setMetaDataFromString フラグと一緒に説明されています。
queryMetaDatas(qms)	boolean
使用可能なすべてのメタデータを照会します。
queryPortDataType(qpt)	string
指定したポートのデータ タイプを照会します。
queryPortDefaultValues(qpv)	string
指定したポートの既定値を照会します。 スカラー データ タイプ(例: 浮動小数値または文字列)のポートの場合は、単一の文字列値が返されます。構造データ タイプ(例: ベクトル、または浮動小数値、float3/float3x3 の配列)のポートの場合は、文字列値の配列が返されます。
queryPortMetaDataValue(qpm)	[string, string]
指定したポートのメタデータ タイプを照会します。1 番目の引数は照会するポートで、2 番目の引数は照会するメタデータのタイプです。
removeBackdrop(rmb)	string
指定したバックドロップをコンパウンドから除去します。
removeMetaData(rmd)	[string, string]
メタデータから値を削除します。引数の順序は、メタデータ名、削除するメタデータ値です。
removeNode(rmn)	string
指定したノードをコンパウンドから除去します。
renameBackdrop(rb)	[string, string]
コンパウンド内のバックドロップの名前を変更します。最初の引数はバックドロップの古い名前です。2 番目の引数は新しい名前です。
renameNode(rn)	[string, string]
コンパウンド内のノードの名前を変更します。最初の引数はノードの古い名前です。2 番目の引数は新しい名前です。
renamePort(rp)	[string, string]
コンパウンドのポートの名前を変更します。最初の引数はポートの古い名前です。2 番目の引数は新しい名前です。
resetPortDefaultValues(rpv)	string
コンパウンド ポートの既定値をリセットします。このポートは接続できません。引数はポート名です。
resetToFactory(rtf)	string
指定したコンパウンドを初期状態にリセットします。指定したコンパウンドが、リセット可能である必要があります。
saveAs(sa)	string
ノード エディタのコンパウンド(Compound)メニューでコンパウンドを書き出す場合に使用します。引数は保存するファイルのパスです。
setBackdropMetaDataValue(sbm)	[string, string, string]
指定したコンパウンド バックドロップのメタデータ値を設定します。引数の順序は、設定するバックドロップ名、メタデータ名、メタデータ値です。
setIsReferenced(sir)	boolean
コンパウンドの参照ステータスを変更します。-sir/setIsReferenced が true の場合、コンパウンドはパブリック化され、それ以外の場合はその親のコンパウンドにプライベート化されます。
setMetaData(smd)	[string, string[]]
メタデータ値を設定します。引数の順序は、メタデータ名、設定するメタデータ値です。
setMetaDataFromString(mfs)	string
文字列を使用してメタデータを設定します。これにより、メタデータの階層を作成できます。既存のキーの値は、新しい値に置き換えられます。形式は、複数の「キー=値」をセミコロンで区切り、キー/値ペアのサブリストを定義する波括弧を付加したものです。引用符は省略可能ですが、スペースまたは区切り文字を使用する文字列は引用符で囲む必要があります。引用符とバックスラッシュは、バックスラッシュを使用してエスケープできます。Python スタイルの一重引用符は使用できません。形式の例: "house=red;car="blue and green" "house=red,blue,yellow;hat={color=yellow;height="high"};cake={flavor="choco";topping="plenty"}
setPortDataType(spt)	[string, string]
指定したコンパウンド ポートのデータ タイプを設定します。
setPortDefaultValues(spv)	[string, string[]]
指定したポートに既定値を設定します。このポートは接続できません。引数の順序は、ポート名、値です。値の引数は文字列の配列であり、ポートのデータ タイプに応じて適切な数の要素が含まれている必要があります(例: float3 データ タイプの場合は 3 つの要素)。スカラー データ タイプ(例: 浮動小数値または文字列)の場合は、単一の文字列値を使用できます。
setPortMetaDataValue(spm)	[string, string, string]
指定したコンパウンド ポートのメタデータ値を設定します。引数の順序は、設定するポート名、メタデータ名、メタデータ値です。
specializedTypeName(stn)	boolean
「Bifrost_DoWhile」や、標準コンパウンド用の「Compound」など、特殊な実装クラスの名前を照会する場合に使用します。

フラグはコマンドの作成モードで表示できます	フラグはコマンドの編集モードで表示できます
フラグはコマンドの照会モードで表示できます	フラグに複数の引数を指定し、タプルまたはリストとして渡すことができます。

Python のサンプル

import maya.cmds as cmds

import maya.mel as mel
cmds.file(new=1, f=1)
mel.eval("createNewBifrostGraphCmd()")

cmds.vnnCompound("bifrostGraph1", "/", create="liquid")

# Create a sub-compound in the graph
cmds.vnnCompound("bifrostGraph1", "/liquid", create="subCompound")

# Create an output port in the compound
cmds.vnnCompound("bifrostGraph1", "/liquid", createOutputPort=("newOutput", "float"))

# Create an input port in the compound
cmds.vnnCompound("bifrostGraph1", "/liquid", createInputPort=("newInput", "float"))

# Rename a port
cmds.vnnCompound("bifrostGraph1", "/liquid", renamePort=("newOutput", "outputValue"))

# Move a port
cmds.vnnCompound("bifrostGraph1", "/liquid", movePort=("newInput", 0))

# Hide a port
cmds.vnnCompound("bifrostGraph1", "/liquid", hidePort=("newInput", 1))

# set the type of a internal port of the compound
cmds.vnnCompound("bifrostGraph1", "/liquid", setPortDataType=("outputValue", "string"))

# query the data type of a specified port
cmds.vnnCompound("bifrostGraph1", "/liquid", queryPortDataType="outputValue")

# set the default value of specified port for an integer data type
cmds.vnnCompound("bifrostGraph1", "/liquid", setPortDefaultValues=("newInput", "18"))

# set the port default values for a float3 data type
cmds.vnnCompound("bifrostGraph1", "/liquid", createInputPort=("newInput2", "Math::float3"))
cmds.vnnCompound("bifrostGraph1", "/liquid", setPortDefaultValues=("newInput2", "{1.5,1.2,1.3}") )

# Reset the port default value
cmds.vnnCompound("bifrostGraph1", "/liquid", resetPortDefaultValues="newInput")
cmds.vnnCompound("bifrostGraph1", "/liquid", queryPortDefaultValues="newInput")
# Result: 0 0 0 //

# query the default value of specified port for an integer data type
cmds.vnnCompound("bifrostGraph1", "/liquid", queryPortDefaultValues="newInput")
# Result: 18 //

# query the default value of specified port for an float3 data type
cmds.vnnCompound("bifrostGraph1", "/liquid", queryPortDefaultValues="newInput2")
# Result: 1.5 1.2 1.3 //

# set the state value of specified port
cmds.vnnCompound("bifrostGraph1", "/liquid", setPortMetaDataValue=("portName", "metaDataName", "value"))

# query the current state value of specified port
cmds.vnnCompound("bifrostGraph1", "/liquid", queryPortMetaDataValue=("portName", "metaDataName"))

# query the children of a specified port
cmds.vnnCompound("bifrostGraph1", "/liquid", listPortChildren="portName")

# Add a new node into VNN graph of the bifrost container
cmds.vnnCompound("bifrostGraph1", "/liquid", addNode="BifrostGraph,Core::Math,add")

# Create a new input node
cmds.vnnCompound("bifrostGraph1", "/liquid", addIONode=True)

# Create a new output node
cmds.vnnCompound("bifrostGraph1", "/liquid", addIONode=False)

# Rename a node
cmds.vnnCompound("bifrostGraph1", "/liquid", renameNode=("add", "plus"))

# Remove the node
cmds.vnnCompound("bifrostGraph1", "/liquid", addNode="BifrostGraph,Core::Math,plus")
cmds.vnnCompound("bifrostGraph1", "/liquid", removeNode="plus")

# Create two state ports of type float
cmds.vnnCompound("bifrostGraph1", "/liquid", addStatePorts=("in_name", "out_name", "float"))

# Query the specialized type name
cmds.vnnCompound("bifrostGraph1", "/liquid", specializedTypeName=1)

# Query if the compound is referenced
cmds.vnnCompound("bifrostGraph1", "/liquid", queryIsReferenced=1)

# Query if the compound is imported
cmds.vnnCompound("bifrostGraph1", "/liquid", queryIsImported=1)

# Make the compound private
cmds.vnnCompound("bifrostGraph1", "/liquid", setIsReferenced=False)

# List all child nodes in the specified compound
cmds.vnnCompound("bifrostGraph1", "/liquid", listNodes=1)

# List the nodes in the specified compound which are of a specific type
cmds.vnnCompound("bifrostGraph1", "/liquid", nodeType="Math", listNodes=1)

# List all the nodes in the specified compound which have no connections
cmds.vnnCompound("bifrostGraph1", "/liquid", connected=False, listNodes=1)

# List nodes in the specified compound which are connected to the parent's internal input
cmds.vnnCompound("bifrostGraph1", "/liquid", connectedToInput=1, listNodes=1)

# List nodes in the specified compound which are connected to the parent's internal output
cmds.vnnCompound("bifrostGraph1", "/liquid", connectedToOutput=1, listNodes=1)

# List nodes in the specified compound which are connected to both the parent's internal input and output port
cmds.vnnCompound("bifrostGraph1", "/liquid", connectedToOutput=1, connectedToInput=1, listNodes=1)

# Query the name of the node that is connected to a specified port
# It could be either an input port or an output port
cmds.vnnCompound("bifrostGraph1", "/liquid", connectedTo="Solid", listNodes=1)
# Result: SetDescriptorFromObject1.value

# List the names of all compound's internal ports
cmds.vnnCompound("bifrostGraph1", "/liquid", listPorts=1)

# List the names of the compound's internal input ports
cmds.vnnCompound("bifrostGraph1", "/liquid", listPorts=1, inputPort=1)

# List the names of the compound's internal output ports
cmds.vnnCompound("bifrostGraph1", "/liquid", outputPort=1, listPorts=1)

# List all the compound's internal unconnected input and output port
cmds.vnnCompound("bifrostGraph1", "/liquid", listPorts=1, connected=False)

# List all the compound's internal connected input and output port
cmds.vnnCompound("bifrostGraph1", "/liquid", listPorts=1, connected=True)

# Query if the specified compound can be reset to factory
cmds.vnnCompound("bifrostGraph1", "/", canResetToFactory="liquid")

# Reset the specified compound to factory
cmds.vnnCompound("bifrostGraph1", "/", resetToFactory="liquid")