Go to: Return value. Related commands. Flags. Examples.

Synopsis

cluster [flags] [objects]

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.

Return value

[string []] (the cluster node name and the cluster handle name)

Related commands

lattice, sculpt, deformer, flexor, wire, wrinkle, percent

Flags

after, before, bindState, deformerTool, envelope, exclusive, frontOfChain, geometry, ignoreSelected, name, prune, relative, remove, resetGeometry, split, weightedNode

Long name (short name)[argument types]Properties
-name (-n) string
Used to specify the name of the node being created
-geometry (-g) stringqueryedit
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 ...
-remove (-rm) edit
Specifies that objects listed after the -g flag should be removed from this deformer.
-before (-bf) create
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
-after (-af) create
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
-split (-sp) create
Branches off a new chain in the dependency graph instead of inserting/appending the deformer into/onto an existing chain.
-frontOfChain (-foc) create
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.
-ignoreSelected (-is) create
Tells the command to not deform objects on the current selection list
-deformerTool (-dt) query
Returns the name of the deformer tool objects (if any) as string string ...
-prune (-pr) edit
Removes any points not being deformed by the deformer in its current configuration from the deformer set.
-exclusive (-ex) querycreate
Puts the deformation set in a deform partition.
-weightedNode (-wn) nodeName fromNodequerycreateedit
Transform node in the DAG above the cluster to which all percents are applied. fromNode specifies the descendent of nodeName from where the transformation matrix is evaluated. Default is the cluster handle.
-bindState (-bs) create
Specifying 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.
-envelope (-en) doublequerycreateedit
Set the envelope value for the deformer. Default is 1.0
-relative (-rel) create
Enable relative mode for the cluster. In relative mode, Only the transformations directly above the cluster are used by the cluster. Default is off.
-resetGeometry (-rg) edit
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 command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can be used more than once in a command

Examples


		// Create a cluster which uses the transformation of elbow1
		//
		cluster -wn elbow1 elbow1;

		// Edit cluster1 to use the transformation of wrist1.
		//
		cluster -bs 1 -wn wrist1 wrist1 cluster1;

		// Create a relative cluster with its own cluster handle. The
		// cluster handle is drawn as the letter "C".
		//
		cluster -rel;

		// 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).
		//
		listConnections -type objectSet cluster1;
		// Result: cluster1Set
		sets -add cluster1Set pCube1;
		sets -rm cluster1Set pPlane1;