pymel.core.general.container

container(*args, **kwargs)

This command can be used to create and query container nodes. It is also used to perform operations on containers such as: add and remove nodes from the containerpublish attributes from nodes inside the containerreplace the connections and values from one container onto another oneremove a container without removing its member nodes

Modifications:

• returns a list of PyNode objects for flags: (query and (nodeList or connectionList))
• returns a PyNode object for flags: (query and (findContainer or asset))
• <lambda>(result) for flags: (query and bindAttr and not (publishName or publishAsParent or publishAsChild))
• f(result) for flags: (query and unbindAttr and not (publishName or publishAsParent or publishAsChild))

Flags:

Long name (short name)		Argument Types	Properties
addNode (an)		<type ‘unicode’>, ...
	Specifies the list of nodes to add to container.
asset (a)		<type ‘unicode’>, ...
	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.
assetMember (am)		unicode
	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.
bindAttr (ba)		unicode, unicode
	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.
connectionList (cl)		bool
	Returns a list of the exterior connections to the container node.
current (c)		bool
	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.
fileName (fn)		<type ‘unicode’>, ...
	Used to query for the assets associated with a given file name.
findContainer (fc)		<type ‘unicode’>, ...
	When queried, if all the nodes in nodeList belong to the same container, returns container’s name. Otherwise returns empty string.
force (f)		bool
	This flag can be used in conjunction with -addNode and -removeNode flags only. If specified with -addNode, nodes will be disconnected from their current containers before they are added to new one. If specified with -removeNode, nodes will be removed from all containers, instead of remaining in the parent container if being removed from a nested container.
includeHierarchyAbove (iha)		bool
	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)		bool
	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.
includeNetwork (inc)		bool
	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)		unicode
	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.
includeShaders (isd)		bool
	Used to specify that for any shapes included, their shaders will also be included in the container.
includeShapes (ish)		bool
	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.
includeTransform (it)		bool
	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.
isContainer (isc)		bool
	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.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
name (n)		unicode
	Sets the name of the newly-created container.
nodeList (nl)		bool
	When queried, returns a list of nodes in container. The list will be sorted in the order they were added to the container. This will also display any reordering done with the reorderContainer command.
nodeNamePrefix (nnp)		bool
	Specifies that the name of published attributes should be of the form “node_attr”. Must be used with the -publishConnections/-pc flag.
parentContainer (par)		bool
	Flag to query the parent container of a specified container.
preview (p)		bool
	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.
publishAndBind (pb)		unicode, unicode
	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.
publishAsChild (pac)		unicode, unicode
	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.
publishAsParent (pap)		unicode, unicode
	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.
publishAsRoot (pro)		unicode, bool
	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.
publishAttr (pa)		unicode
	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.
publishConnections (pc)		bool
	Publish all connections from nodes inside the container to nodes outside the container.
publishName (pn)		unicode
	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.
removeContainer (rc)		bool
	Disconnects all the nodes from container and deletes container node.
removeNode (rn)		<type ‘unicode’>, ...
	Specifies the list of nodes to remove from container. If node is a member of a nested container, it will be added to the parent container. To remove from all containers completely, use the -force flag.
type (typ)		unicode
	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”.
unbindAndUnpublish (ubp)		unicode
	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.
unbindAttr (ua)		unicode, unicode
	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.
unbindChild (unc)		unicode
	Unbind the node published as child, but do not remove its published name from the interface of the container.
unbindParent (unp)		unicode
	Unbind the node published as parent, but do not remove its published name from the interface of the container.
unpublishChild (upc)		unicode
	Unpublish node published as child from the interface of the container
unpublishName (un)		unicode
	Unpublish an unbound name from the interface of the container.
unpublishParent (upp)		unicode
	Unpublish node published as parent from the interface of the container
unsortedOrder (uso)		bool
	This flag has no effect on the operation of the container command (OBSOLETE).

Derived from mel command maya.cmds.container

Example:

import pymel.core as pm

# Create a container holding a locator transform only (not its shape)
#
loc = pm.spaceLocator()
con1 = pm.container(addNode=[loc[0]])

# Select the nodes that would be in the container, but don't create it
#
pm.container(preview=True,addNode=[cone[0]],includeNetwork=True,includeHierarchyBelow=True)


# Create a container holding a polygon shape, its transform and its
# history node. Publish its tx attr.
#
cone = pm.polyCone()
con2 = pm.container(addNode=[cone[0]],includeNetwork=True,includeHierarchyBelow=True)

# Publish the cone's tx and the locator's tx with the same name
#
pm.container(con1,edit=True,publishName='main_tx')
pm.container(con1,edit=True,bindAttr=['%s.tx' % loc[0],'main_tx'])
pm.container(con2,edit=True,publishName='main_tx')
pm.container(con2,edit=True,bindAttr=['%s.tx' % cone[0],'main_tx'])

# Publish the name "sam", but don't bind it to anything
#
pm.container(con1,edit=True,publishName='sam')

# Query the bound publications
#
pm.container(con1,query=True,bindAttr=1)
[u'locator1.translateX', u'main_tx']

# Query all the published names:
#
pm.container(con1,query=True,publishName=1)
[u'main_tx' u'sam']

# Query just the bound published names:
#
pm.container(con1,query=True,publishName=1,bindAttr=1)
[u'main_tx']

# Query just the unbound published names:
#
pm.container(con1,query=True,publishName=1,unbindAttr=1)
[u'sam']

# Query just the published name for the published attribute locator1.translateX
#
pm.container(con1,query=True,publishName=1,publishAttr='locator1.translateX')
[u'main_tx']

# keyframe the cone's tx
#
pm.currentTime(0)
coneTx = '%s.tx' % cone[0]
pm.setKeyframe(coneTx)
pm.currentTime(4)
pm.setAttr(coneTx,10.0)
pm.setKeyframe(coneTx)

# Query the nodes in the container
#
nodes = pm.container(con2,query=True,nodeList=True)

# Remove a node from the container
#
pm.container(con2,edit=True,removeNode=nodes[2])

# Remove the container without deleting the nodes within it
#
pm.container(con2,edit=True,removeContainer=True)

# query a referenced scenes for its assets
#
pm.container(q=True,fileName='C:/My Documents/maya/projects/default/scenes/refFile.mb')