container is undoable, queryable, and editable.
This command can be used to create and query container nodes. It is
also used to perform operations on containers such as:
In query mode, return type is based on queried flag.
Long name (short name) |
Argument types |
Properties |
-name(-n) |
string |
|
|
Sets the name of the newly-created container. |
|
-addNode(-an) |
string[] |
|
|
Specifies the list of nodes to add to container. |
|
-force(-f) |
|
|
|
This flag can be used in conjunction with -addNode flag only.
If specified, then nodes will be disconnected from their current
containers before they are added to new one. |
|
-removeNode(-rn) |
string[] |
|
|
Specifies the list of nodes to remove from container. |
|
-nodeList(-nl) |
|
|
|
When queried, returns a list of nodes in container. |
|
-unsortedOrder(-uso) |
|
|
|
The -nodeList/-nl flag will return a sorted list of nodes. This
flag can be used to get the nodes in the order they were added to
the container. This will also display any reordering done with the
reorderContainer command. |
|
-findContainer(-fc) |
string[] |
|
|
When queried, if all the nodes in nodeList belong to the same
container, returns container's name. Otherwise returns empty
string.
In query mode, this flag needs a value.
|
|
-removeContainer(-rc) |
|
|
|
Disconnects all the nodes from container and deletes container
node. |
|
-connectionList(-cl) |
|
|
|
Returns a list of the exterior connections to the container
node. |
|
-publishConnections(-pc) |
|
|
|
Publish all connections from nodes inside the container to
nodes outside the container. |
|
-publishAttr(-pa) |
string |
|
|
In query mode, can only be used with the -publishName(-pn)
flag, and takes an attribute as an argument; returns the published
name of the attribute, if any.
In query mode, this flag needs a value.
|
|
-publishName(-pn) |
string |
|
|
Publish a name to the interface of the container, and returns
the actual name published to the interface. In query mode, returns
the published names for the container. If the -bindAttr flag is
specified, returns only the names that are bound; if the
-unbindAttr flag is specified, returns only the names that are not
bound; if the -publishAsParent/-publishAsChild flags are specified,
returns only names of published parents/children. if the
-publishAttr is specified with an attribute argument in the
"node.attr" format, returns the published name for that attribute,
if any. |
|
-unpublishName(-un) |
string |
|
|
Unpublish an unbound name from the interface of the
container. |
|
-bindAttr(-ba) |
string string |
|
|
Bind a contained attribute to an unbound published name on the
interface of the container; returns a list of bound published
names. The first string specifies the node and attribute name to be
bound in "node.attr" format. The second string specifies the name
of the unbound published name. In query mode, returns a string
array of the published names and their corresponding attributes.
The flag can also be used in query mode in conjunction with the
-publishName, -publishAsParent, and -publishAsChild flags. |
|
-unbindAttr(-ua) |
string string |
|
|
Unbind a published attribute from its published name on the
interface of the container, leaving an unbound published name on
the interface of the container; returns a list of unbound published
names. The first string specifies the node and attribute name to be
unbound in "node.attr" format, and the second string specifies the
name of the bound published name. In query mode, can only be used
with the -publishName, -publishAsParent and -publishAsChild
flags. |
|
-publishAndBind(-pb) |
string string |
|
|
Publish the given name and bind the attribute to the given
name. First string specifies the node and attribute name in
"node.attr" format. Second string specifies the name it should be
published with. |
|
-unbindAndUnpublish(-ubp) |
string |
|
|
Unbind the given attribute (in "node.attr" format) and
unpublish its associated name. Unbinding a compound may trigger
unbinds of its compound parents/children. So the advantage of using
this one flag is that it will automatically unpublish the names
associated with these automatic unbinds. |
|
-publishAsParent(-pap) |
string string |
|
|
Publish contained node to the interface of the container to
indicate it can be a parent to external nodes. The second string is
the name of the published node. In query mode, returns a string of
array of the published names and the corresponding nodes. If
-publishName flag is used in query mode, only returns the published
names; if -bindAttr flag is used in query mode, only returns the
name of the published nodes. |
|
-publishAsChild(-pac) |
string string |
|
|
Publish contained node to the interface of the container to
indicate it can be a child of external nodes. The second string is
the name of the published node. In query mode, returns a string of
the published names and the corresponding nodes. If -publishName
flag is used in query mode, only returns the published names; if
-bindAttr flag is used in query mode, only returns the name of the
published nodes. |
|
-publishAsRoot(-pro) |
string boolean |
|
|
Publish or unpublish a node as a root. The significance of root
transform node is twofold. When container-centric selection is
enabled, the root transform will be selected if a container node in
the hierarchy below it is selected in the main scene view. Also,
when exporting a container proxy, any published root transformation
attributes such as translate, rotate or scale will be hooked up to
attributes on a stand-in node. In query mode, returns the node that
has been published as root. |
|
-unpublishParent(-upp) |
string |
|
|
Unpublish node published as parent from the interface of the
container |
|
-unpublishChild(-upc) |
string |
|
|
Unpublish node published as child from the interface of the
container |
|
-unbindParent(-unp) |
string |
|
|
Unbind the node published as parent, but do not remove its
published name from the interface of the container. |
|
-unbindChild(-unc) |
string |
|
|
Unbind the node published as child, but do not remove its
published name from the interface of the container. |
|
-nodeNamePrefix(-nnp) |
|
|
|
Specifies that the name of published attributes should be of
the form "node_attr". Must be used with the -publishConnections/-pc
flag. |
|
-includeNetwork(-inc) |
|
|
|
Used to specify that the node network connected to supplied
node list should also be included in the container. Network
traversal will stop at default nodes and nodes which are members of
other containers. |
|
-includeNetworkDetails(-ind) |
string |
|
|
Used to specify specific parts of the network that should be
included. Valid arguments to this flag are: "channels", "sdk",
"constraints", "history" and "expressions", "inputs", "outputs".
The difference between this flag and the includeNetwork flag, is
that it will include all connected nodes regardless of their type.
Note that dag containers include their children, so they will
always include constraint nodes that are parented beneath the
selected objects, even when constraints are not specified as an
input. |
|
-includeHierarchyAbove(-iha) |
|
|
|
Used to specify that the parent hierarchy of the supplied node
list should also be included in the container (or deleted from the
container). Hierarchy inclusion will stop at nodes which are
members of other containers. |
|
-includeHierarchyBelow(-ihb) |
|
|
|
Used to specify that the hierarchy below the supplied node list
should also be included in the container (or delete from the
container). Hierarchy inclusion will stop at nodes which are
members of other containers. |
|
-includeTransform(-it) |
|
|
|
Used to specify that for any shapes selected, their parent
transform will be included in the container (or deleted from the
container). This flag is not necessary when includeHierarchyAbove
is used since the parent transform and all of its parents will
automatically be included. |
|
-includeShapes(-ish) |
|
|
|
Used to specify that for any transforms selected, their direct
child shapes will be included in the container (or deleted from the
container). This flag is not necessary when includeHierarchyBelow
is used since the child shapes and all other descendents will
automatically be included. |
|
-includeShaders(-isd) |
|
|
|
Used to specify that for any shapes included, their shaders
will also be included in the container. |
|
-fileName(-fn) |
string[] |
|
|
Used to query for the assets associated with a given file name.
In query mode, this flag needs a value.
|
|
-current(-c) |
boolean |
|
|
In create mode, specify that the newly created asset should be
current. In edit mode, set the selected asset as current. In query,
return the current asset. |
|
-parentContainer(-par) |
|
|
|
Flag to query the parent container of a specified
container. |
|
-assetMember(-am) |
string |
|
|
Can be used during query in conjunction with the bindAttr flag
to query for the only published attributes related to the specified
node within the container.
In query mode, this flag needs a value.
|
|
-asset(-a) |
string[] |
|
|
When queried, if all the nodes in nodeList belong to the same
container, returns container's name. Otherwise returns empty
string. This flag is functionally equivalent to the findContainer
flag. |
|
-preview(-p) |
|
|
|
This flag is valid in create mode only. It indicates that you
do not want the container to be created, instead you want to
preview its contents. When this flag is used, Maya will select the
nodes that would be put in the container if you did create the
container. For example you can see what would go into the container
with -includeNetwork, then modify your selection as desired, and do
a create container with the selected objects only. |
|
-type(-typ) |
string |
|
|
By default, a container node will be created. Alternatively,
the type flag can be used to indicate that a different type of
container should be created. At the present time, the only other
valid type of container node is "dagContainer". |
|
-isContainer(-isc) |
|
|
|
Return true if the selected or specified node is a container
node. If multiple containers are queried, only the state of the
first will be returned. |
|