Go to: Synopsis. Return value. Related. Flags. Python examples.
vnnCompound(
string string
, [addBackdrop=string], [addIONode=boolean], [addMetaData=[string, string]], [addNode=string], [addStatePorts=[string, string, string]], [canResetToFactory=string], [clearMetaData=string], [connectTo=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], [moveAnnotationIn=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]], [queryAnnotationMetaDataValue=[string, string]], [queryIsImported=boolean], [queryIsReferenced=boolean], [queryMetaData=string], [queryMetaDataAsString=boolean], [queryMetaDatas=boolean], [queryPortDataType=string], [queryPortDefaultValues=string], [queryPortMetaDataValue=[string, string]], [removeAnnotation=string], [removeMetaData=[string, string]], [removeNode=string], [renameAnnotation=[string, string]], [renameNode=[string, string]], [renamePort=[string, string]], [resetPortDefaultValues=string], [resetToFactory=string], [saveAs=string], [setAnnotationMetaDataValue=[string, string, string]], [setIsReferenced=boolean], [setMetaData=[string, string[]]], [setMetaDataFromString=string], [setPortDataType=[string, string]], [setPortDefaultValues=[string, string[]]], [setPortMetaDataValue=[string, string, string]], [specializedTypeName=boolean])
Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.
vnnCompound is undoable, NOT queryable, and NOT editable.
The vnnCompound command is used to operate compound and its VNN graph.
The first parameter is the full name of the DG node that contains the VNN graph.
The second parameter is the name of the compound.
| string | The result of the operation |
vnn, vnnConnect
addBackdrop, addIONode, addMetaData, addNode, addStatePorts, canResetToFactory, clearMetaData, connectTo, connected, connectedTo, connectedToInput, connectedToOutput, create, createInputPort, createOutputPort, deletePort, explode, hidePort, inputPort, listNodes, listPortChildren, listPorts, moveAnnotationIn, moveNodeIn, movePort, movePortToIONode, nodeType, outputPort, portFlags, portOptions, portValues, publish, publishGraph, queryAnnotationMetaDataValue, queryIsImported, queryIsReferenced, queryMetaData, queryMetaDataAsString, queryMetaDatas, queryPortDataType, queryPortDefaultValues, queryPortMetaDataValue, removeAnnotation, removeMetaData, removeNode, renameAnnotation, renameNode, renamePort, resetPortDefaultValues, resetToFactory, saveAs, setAnnotationMetaDataValue, setIsReferenced, setMetaData, setMetaDataFromString, setPortDataType, setPortDefaultValues, setPortMetaDataValue, specializedTypeName
| Long name (short name) |
Argument types |
Properties |
|
addBackdrop(ab)
|
string
|
 
|
|
Add a backdrop into the compound.
|
|
addIONode(aio)
|
boolean
|
|
|
Add an input or an output node into the compound.
|
|
addMetaData(amd)
|
[string, string]
|
|
|
Add a value to a metatada.
The arguments are, in order, metadata name, metadata value to be added.
|
|
addNode(an)
|
string
|
|
|
Add a node into the compound.
|
|
addStatePorts(asp)
|
[string, string, string]
|
|
|
Add new input and output ports, linked together.
The arguments are, in order, the input port name, the output port name
and the data type to assign to both ports.
|
|
canResetToFactory(crf)
|
string
|
|
|
Query if the specified compound can be reset to its initial status.
|
|
clearMetaData(cmd)
|
string
|
|
|
Remove all the values of a metatada.
The argument is the metadata name.
|
|
connectTo(cot)
|
string
|
|
|
Used with addNode and addIONode, use to connect - when possible,
the newly created node to the given upstream node.
|
|
connected(cn)
|
boolean
|
|
|
Used with "listNodes" or "listPorts" to query the nodes
or internal ports that have connections when the argument is true.
If the arguments is false, return all nodes which
have no connection. The other side of the connection could be
another node or port.
|
|
connectedTo(ct)
|
string
|
|
|
Used with "listNodes" to query all nodes that
connect to the specified ports.
|
|
connectedToInput(cti)
|
boolean
|
|
|
Used with "listNodes" to query all nodes which
connect to any input ports.
|
|
connectedToOutput(cto)
|
boolean
|
|
|
Used with "listNodes" to query all nodes that
connect to any output ports.
|
|
create(c)
|
string
|
|
|
Create a sub compound in the specified compound.
The name of the created sub compound cannot be
used before in the specified compound.
|
|
createInputPort(cip)
|
[string, string]
|
|
|
Create an input port in the compound. The first
argument is the name of the port. The second argument
is the data type of the port.
|
|
createOutputPort(cop)
|
[string, string]
|
|
|
Create an output port in the compound. The first
argument is the name of the port. The second argument is the
data type of the port.
|
|
deletePort(dp)
|
string
|
|
|
Delete a input or output port from the compound.
|
|
explode(ec)
|
string
|
|
|
Explode a specified compound and move the nodes from it to its parent.
|
|
hidePort(hp)
|
[string, boolean]
|
|
|
Hide or display an input port of a compound
|
|
inputPort(ip)
|
boolean
|
|
|
Used with "listPorts" to query all internal ports which
connect to any input ports in the compound.
|
|
listNodes(ln)
|
boolean
|
|
|
List all nodes in the compound. Can be used with
other flags, such as "dataType", "connectedToInput" to
query some specified nodes. The returned result is
a list of node names.
|
|
listPortChildren(lpc)
|
string
|
|
|
List the children of specified port.
|
|
listPorts(lp)
|
boolean
|
|
|
List all internal ports in the compound, including
input and output ports.
Can be used with other flags, such as "output",
"connected" to query some specified ports.
|
|
moveAnnotationIn(mai)
|
string
|
|
|
When creating a new compound, use this argument once for every annotation to move into the new compound
|
|
moveNodeIn(mi)
|
string
|
|
|
When creating a new compound, use this argument once for every node to move into the new compound
|
|
movePort(mp)
|
[string, int]
|
|
|
Move a port to the specified index in the compound
|
|
movePortToIONode(mpn)
|
[string, string]
|
|
|
Move a port to another i/o node of the compound
|
|
nodeType(nt)
|
string
|
|
|
Used with "listNodes" to query all nodes which are
specified node type in the compound.
|
|
outputPort(op)
|
boolean
|
|
|
Used with "listPorts" to query all nodes which
connect to any output ports in the compound.
|
|
portFlags(cpf)
|
uint
|
|
|
Used with "createInputPort" or "createOutputPort" to specify
the flags on the port. See vnnPort command.
|
|
portOptions(cpo)
|
string[]
|
|
|
Used with "createInputPort" or "createOutputPort" to specify
a list of options on the created port.
|
|
portValues(cpv)
|
string
|
|
|
Used with "createInputPort" or "createOutputPort" to specify the default value of a new port
|
|
publish(pub)
|
[string, string, string, boolean]
|
|
|
Used to publish the compound.
The arguments are, in order, the file path where to save,
the namespace where to store the compound, the name to use for
the nodedef, and a boolean to indicate whether the compound is
overloadable or not.
|
|
publishGraph(pbg)
|
[string, string, string, string]
|
|
|
Used to publish the compound as a graph.
The arguments are, in order, the file path where to save,
the namespace where to store the compound, the name to use for
the nodedef, and a string containing a json property list which
will contain the metadata to be associated with the graph.
The json property list must be a simple set of key value pairs enclosed in
curly braces.
|
|
queryAnnotationMetaDataValue(qam)
|
[string, string]
|
|
|
Query the metadata value of a specified annotation.
The first argument is the annotation to query, the second is the type of metadata to query.
|
|
queryIsImported(qii)
|
boolean
|
|
|
Query if the compound is imported.
|
|
queryIsReferenced(qir)
|
boolean
|
|
|
Query if the compound is referenced.
|
|
queryMetaData(qmd)
|
string
|
|
|
Query the value(s) of a metadata.
|
|
queryMetaDataAsString(mas)
|
boolean
|
|
|
Gets all metadata as a string. The format is documented with the setMetaDataFromString flag
|
|
queryMetaDatas(qms)
|
boolean
|
|
|
Query all the available metadatas.
|
|
queryPortDataType(qpt)
|
string
|
|
|
Query the data type of a specified port.
|
|
queryPortDefaultValues(qpv)
|
string
|
|
|
Query the default value(s) of a specified port.
For ports of scalar data type (ie. float or string),
this will return a single string value,
For ports of structure data type (ie. vector or matrix of floats - float3/float3x3),
this will return an array of string values.
|
|
queryPortMetaDataValue(qpm)
|
[string, string]
|
|
|
Query the metadata value of a specified port.
The first argument is the port to query, the second is the type of metadata
to query.
|
|
removeAnnotation(rma)
|
string
|
|
|
Remove the specified annotation from the compound.
|
|
removeMetaData(rmd)
|
[string, string]
|
|
|
Remove a value from a metatada.
The arguments are, in order, metadata name, metadata value to be removed.
|
|
removeNode(rmn)
|
string
|
|
|
Remove the specified node from the compound.
|
|
renameAnnotation(ra)
|
[string, string]
|
|
|
Rename an annotation in the compound. The first argument
is the old name of the annotation. The second argument is
the new name.
|
|
renameNode(rn)
|
[string, string]
|
|
|
Rename a node in the compound. The first argument
is the old name of the node. The second argument is
the new name.
|
|
renamePort(rp)
|
[string, string]
|
|
|
Rename a port of the compound. The first argument
is the old name of the port. The second argument is
the new name.
|
|
resetPortDefaultValues(rpv)
|
string
|
|
|
Resets the default value(s) of a compound port
The port cannot be connected.
The argument is the port name.
|
|
resetToFactory(rtf)
|
string
|
|
|
Reset the specified compound to its initial status.
The specified compound must be able to be reset.
|
|
saveAs(sa)
|
string
|
|
|
Used to export Compound in the Compound menu of the Node Editor.
The argument is the file path to save.
|
|
setAnnotationMetaDataValue(sam)
|
[string, string, string]
|
|
|
Set the metadata value of a specified compound annotation. The arguments are, in order,
annotation name, metadata name, metadata value to be set.
|
|
setIsReferenced(sir)
|
boolean
|
|
|
Change the referenced status of the compound.
If -sir/setIsReferenced is true, the compound will be made public,
else the compound will be made private to its parent compound.
|
|
setMetaData(smd)
|
[string, string[]]
|
|
|
Set the value of a metatada.
The arguments are, in order, metadata name, metadata values to be set.
|
|
setMetaDataFromString(mfs)
|
string
|
|
|
Set metadata using a string. This allows creating hierarchies of metadata.
The values of keys that already exist will be replaced with the new values.
The format is key=values separated by semi-colons, and braces
to define a sub-list of key/value pairs. Quotes are optional, but strings
using spaces or separators must be quoted. Quotes and backslashes can be escaped
with a backslash. Python-style single quotes are not accepted.
Example of format:
"house=red;car="blue and green"
"house=red,blue,yellow;hat={color=yellow;height="high"};cake={flavor="choco";topping="plenty"}
|
|
setPortDataType(spt)
|
[string, string]
|
|
|
Set the data type of a specified compound port.
|
|
setPortDefaultValues(spv)
|
[string, string[]]
|
|
|
Set the default value(s) to a specified port
The port cannot be connected.
The arguments are, in order, the port name and the value(s).
The value argument is an array of string that must contain the proper number of
element depending of the data type of the port (ie. 3 elements for a float3 data type).
For scalar data types ((ie. float or string) a single string value can be used.
|
|
setPortMetaDataValue(spm)
|
[string, string, string]
|
|
|
Set the metadata value of a specified compound port. The arguments are, in order,
port name, metadata name, metadata value to be set.
|
|
specializedTypeName(stn)
|
boolean
|
|
|
Used to query the specialized implementation class names
such as "Bifrost_DoWhile", or "Compound" for a normal compound
|
|
|
Flag can appear in Create mode of command
|
Flag can appear in Edit mode of command
|
Flag can appear in Query mode of command
|
Flag can have multiple arguments, passed either as a tuple or a list.
|
import maya.cmds as cmds
import maya.mel as mel
cmds.file(new=1, f=1)
mel.eval("createNewBifrostGraphCmd()")
cmds.vnnCompound("bifrostGraphShape1", "/", create="liquid")
# Create a sub-compound in the graph
cmds.vnnCompound("bifrostGraphShape1", "/liquid", create="subCompound")
# Create an output port in the compound
cmds.vnnCompound("bifrostGraphShape1", "/liquid", createOutputPort=("newOutput", "float"))
# Create an input port in the compound
cmds.vnnCompound("bifrostGraphShape1", "/liquid", createInputPort=("newInput", "float"))
# Rename a port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", renamePort=("newOutput", "outputValue"))
# Move a port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", movePort=("newInput", 0))
# Hide a port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", hidePort=("newInput", 1))
# set the type of a internal port of the compound
cmds.vnnCompound("bifrostGraphShape1", "/liquid", setPortDataType=("outputValue", "string"))
# query the data type of a specified port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", queryPortDataType="outputValue")
# set the default value of specified port for an integer data type
cmds.vnnCompound("bifrostGraphShape1", "/liquid", setPortDefaultValues=("newInput", "18"))
# set the port default values for a float3 data type
cmds.vnnCompound("bifrostGraphShape1", "/liquid", createInputPort=("newInput2", "Math::float3"))
cmds.vnnCompound("bifrostGraphShape1", "/liquid", setPortDefaultValues=("newInput2", "{1.5,1.2,1.3}") )
# Reset the port default value
cmds.vnnCompound("bifrostGraphShape1", "/liquid", resetPortDefaultValues="newInput")
cmds.vnnCompound("bifrostGraphShape1", "/liquid", queryPortDefaultValues="newInput")
# Result: 0 0 0 //
# query the default value of specified port for an integer data type
cmds.vnnCompound("bifrostGraphShape1", "/liquid", queryPortDefaultValues="newInput")
# Result: 18 //
# query the default value of specified port for an float3 data type
cmds.vnnCompound("bifrostGraphShape1", "/liquid", queryPortDefaultValues="newInput2")
# Result: 1.5 1.2 1.3 //
# set the state value of specified port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", setPortMetaDataValue=("portName", "metaDataName", "value"))
# query the current state value of specified port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", queryPortMetaDataValue=("portName", "metaDataName"))
# query the children of a specified port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", listPortChildren="portName")
# Add a new node into VNN graph of the bifrost container
cmds.vnnCompound("bifrostGraphShape1", "/liquid", addNode="BifrostGraph,Core::Math,add")
# Add a new node in the bifrost container and connect it to upstream 'thatNode'; thatNode -> newNode
cmds.vnnCompound("bifrostGraphShape1", "/liquid", addNode="BifrostGraph,Core::Math,add", connectTo="thatNode")
# Create a new input node
cmds.vnnCompound("bifrostGraphShape1", "/liquid", addIONode=True)
# Create a new output node
cmds.vnnCompound("bifrostGraphShape1", "/liquid", addIONode=False)
# Rename a node
cmds.vnnCompound("bifrostGraphShape1", "/liquid", renameNode=("add", "plus"))
# Remove the node
cmds.vnnCompound("bifrostGraphShape1", "/liquid", addNode="BifrostGraph,Core::Math,plus")
cmds.vnnCompound("bifrostGraphShape1", "/liquid", removeNode="plus")
# Create two state ports of type float
cmds.vnnCompound("bifrostGraphShape1", "/liquid", addStatePorts=("in_name", "out_name", "float"))
# Query the specialized type name
cmds.vnnCompound("bifrostGraphShape1", "/liquid", specializedTypeName=1)
# Query if the compound is referenced
cmds.vnnCompound("bifrostGraphShape1", "/liquid", queryIsReferenced=1)
# Query if the compound is imported
cmds.vnnCompound("bifrostGraphShape1", "/liquid", queryIsImported=1)
# Make the compound private
cmds.vnnCompound("bifrostGraphShape1", "/liquid", setIsReferenced=False)
# List all child nodes in the specified compound
cmds.vnnCompound("bifrostGraphShape1", "/liquid", listNodes=1)
# List the nodes in the specified compound which are of a specific type
cmds.vnnCompound("bifrostGraphShape1", "/liquid", nodeType="Math", listNodes=1)
# List all the nodes in the specified compound which have no connections
cmds.vnnCompound("bifrostGraphShape1", "/liquid", connected=False, listNodes=1)
# List nodes in the specified compound which are connected to the parent's internal input
cmds.vnnCompound("bifrostGraphShape1", "/liquid", connectedToInput=1, listNodes=1)
# List nodes in the specified compound which are connected to the parent's internal output
cmds.vnnCompound("bifrostGraphShape1", "/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("bifrostGraphShape1", "/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("bifrostGraphShape1", "/liquid", connectedTo="Solid", listNodes=1)
# Result: SetDescriptorFromObject1.value
# List the names of all compound's internal ports
cmds.vnnCompound("bifrostGraphShape1", "/liquid", listPorts=1)
# List the names of the compound's internal input ports
cmds.vnnCompound("bifrostGraphShape1", "/liquid", listPorts=1, inputPort=1)
# List the names of the compound's internal output ports
cmds.vnnCompound("bifrostGraphShape1", "/liquid", outputPort=1, listPorts=1)
# List all the compound's internal unconnected input and output port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", listPorts=1, connected=False)
# List all the compound's internal connected input and output port
cmds.vnnCompound("bifrostGraphShape1", "/liquid", listPorts=1, connected=True)
# Query if the specified compound can be reset to factory
cmds.vnnCompound("bifrostGraphShape1", "/", canResetToFactory="liquid")
# Reset the specified compound to factory
cmds.vnnCompound("bifrostGraphShape1", "/", resetToFactory="liquid")