pymel.core.animation.cluster

cluster(*args, **kwargs)

The cluster command creates a cluster or edits the membership of an existing cluster. The command returns the name of the cluster node upon creation of a new cluster. After creating a cluster, the cluster’s weights can be modified using the percent command or the set editor window.

Flags:

Long name (short name)		Argument Types	Properties
after (af)		bool
	If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node after the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
afterReference (ar)		bool
	The -afterReference flag is used to specify deformer ordering in a hybrid way that choses between -before and -after automatically. If the geometry being deformed is referenced then -after mode is used in adding the new deformer otherwise -before mode is used. The net effect when using -afterReference to build deformer chains is that internal shape nodes in the deformer chain will only appear at reference file boundaries, leading to lightweight deformer networks that may be more amicable to reference swapping.
before (bf)		bool
	If the default behavior for insertion/appending into/onto the existing chain is not what you want then you can use this flag to force the command to stick the deformer node before the selected node in the chain even if a new geometry shape has to be created in order to do so. Works in create mode (and edit mode if the deformer has no geometry added yet).
bindState (bs)		bool
	When turned on, this flag adds in a compensation to ensure the clustered objects preserve their spatial position when clustered. This is required to prevent the geometry from jumping at the time the cluster is created in situations when the cluster transforms at cluster time are not identity.
deformerTools (dt)		bool
	Returns the name of the deformer tool objects (if any) as string string ...
envelope (en)		float
	Set the envelope value for the deformer. Default is 1.0
exclusive (ex)		unicode
	Puts the deformation set in a deform partition.
frontOfChain (foc)		bool
	This command is used to specify that the new deformer node should be placed ahead (upstream) of existing deformer and skin nodes in the shape’s history (but not ahead of existing tweak nodes). The input to the deformer will be the upstream shape rather than the visible downstream shape, so the behavior of this flag is the most intuitive if the downstream deformers are in their reset (hasNoEffect) position when the new deformer is added. Works in create mode (and edit mode if the deformer has no geometry added yet).
geometry (g)		unicode
	The specified object will be added to the list of objects being deformed by this deformer object, unless the -rm flag is also specified. When queried, this flag returns string string string ...
geometryIndices (gi)		bool
	Complements the -geometry flag in query mode. Returns the multi index of each geometry.
ignoreSelected (ignoreSelected)		bool
	Tells the command to not deform objects on the current selection list
name (n)		unicode
	Used to specify the name of the node being created
parallel (par)		bool
	Inserts the new deformer in a parallel chain to any existing deformers in the history of the object. A blendShape is inserted to blend the parallel results together. Works in create mode (and edit mode if the deformer has no geometry added yet).
prune (pr)		bool
	Removes any points not being deformed by the deformer in its current configuration from the deformer set.
relative (rel)		bool
	Enable relative mode for the cluster. In relative mode, Only the transformations directly above the cluster are used by the cluster. Default is off.
remove (rm)		bool
	Specifies that objects listed after the -g flag should be removed from this deformer.
resetGeometry (rg)		bool
	Reset the geometry matrices for the objects being deformed by the cluster. This flag is used to get rid of undesirable effects that happen if you scale an object that is deformed by a cluster.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
split (sp)		bool
	Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing chain. Works in create mode (and edit mode if the deformer has no geometry added yet).
weightedNode (wn)		unicode, unicode
	Transform node in the DAG above the cluster to which all percents are applied. The second DAGobject specifies the descendent of the first DAGobject from where the transformation matrix is evaluated. Default is the cluster handle.

Derived from mel command maya.cmds.cluster

Example:

import pymel.core as pm

# Create a cluster which uses the transformation of elbow1
#
pm.joint(p=(2,0,0),name="elbow1")
# Result: nt.Joint(u'elbow1') #
pm.joint(p=(4,0,0),name="wrist1")
# Result: nt.Joint(u'wrist1') #

pm.sphere()
# Result: [nt.Transform(u'nurbsSphere1'), nt.MakeNurbSphere(u'makeNurbSphere1')] #
pm.cluster( wn=('elbow1', 'elbow1') )
# Result: [nt.Cluster(u'cluster1'), nt.Joint(u'elbow1')] #

# Edit cluster1 to use the transformation of wrist1.
#
pm.cluster( 'cluster1', e=True, bs=1, wn=('wrist1', 'wrist1') )

# Create a relative cluster with its own cluster handle. The
# cluster handle is drawn as the letter "C".
#
pm.cluster( rel=True )

# Modify the membership of an existing cluster. First, find
# the name of the cluster's associated set, then use the sets
# command to edit the set membership (add a cube and remove a plane).
#
pm.listConnections( 'cluster1', type="objectSet" )
# Result: cluster1Set
pm.sets( 'pCube1', add='cluster1Set' )
pm.sets( 'pPlane1', rm='cluster1Set' )