Go to: Synopsis. Flags. Return value. Related. Python examples.

Synopsis

jointCluster( [jointName] , [aboveBound=double], [aboveCluster=boolean], [aboveDropoffType=linear|exponential|sine|none], [aboveValue=double], [belowBound=double], [belowCluster=boolean], [belowDropoffType=linear|exponential|sine|none], [belowValue=double], [joint=DAGobject])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

jointCluster is undoable, queryable, and editable.

The joint cluster command adds high-level controls to manage the cluster percentage values on a bound skin around a joint. JointClusters are one way to create smooth bending behaviour on skin when joints rotate. 

.                a <---- aboveBound
.    ____________a_________
.                a         \
.     Joint1     a       Joint2
.   _____________a_______    \
.                a       \    \     b  <--- belowBound
.                a        \    \  b
.                          \    b
.                           \ b  \
.                           b\    \
.                         b   \ Joint3
CVs/vertices between Joint1 and aaaaa (aboveBound) receive only translation/rotation/scale from Joint1. CVs vertices between aaaa and bbbb transition between translation/rotatation/scale from Joint1 and Joint2. CV2 beyand bbbbb (below bound) receive only translation/ rotation scale from Joint3.

Flags

aboveBound, aboveCluster, aboveDropoffType, aboveValue, belowBound, belowCluster, belowDropoffType, belowValue, joint
Long name (short name) [argument types] Properties
aboveBound(ab) double createqueryedit
Specifies the where the drop-off begins in the direction of the bone above the joint. A value of 100 indicates the entire length of the bone. The default value is 10.

In query mode, this flag needs a value.
belowBound(bb) double createqueryedit
Specifies where the drop-off ends in the direction of the bone below the joint. A value of 100 indicates the entire length of the bone. The default value is 10.

In query mode, this flag needs a value.
aboveValue(av) double createqueryedit
Specifies the drop-off percentage of the joint cluster in the direction of the bone above the cluster. A value of 100 indicates the entire length of the bone. The default value is 50.

In query mode, this flag needs a value.
belowValue(bv) double createqueryedit
Specifies the drop-off percentage of the joint cluster in the direction of the joint below the cluster. A value of 100 indicates the entire length of the bone. The default value is 50.

In query mode, this flag needs a value.
joint(j) DAGobject create
Specifies the joint that the cluster should act about.
aboveDropoffType(adt) linear|exponential|sine|none createqueryedit
Specifies the type of percentage drop-off in the direction of the bone above this joint. Default is linear.

In query mode, this flag needs a value.
belowDropoffType(bdt) linear|exponential|sine|none createqueryedit
Specifies the type of type of percentage drop-off in the direction of the bone below this joint. Default is linear.

In query mode, this flag needs a value.
aboveCluster(ac) boolean query
Returns the name of the cluster associated with the bone above this joint.

In query mode, this flag needs a value.
belowCluster(bc) boolean query
Returns the name of the cluster associated with this joint.

In query mode, this flag needs a value.
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.

Return value


[string] naming the new jointCluster node

Related

connectJoint, ikHandle, ikHandleDisplayScale, ikSolver, ikSystem, ikSystemInfo, insertJoint, joint, jointDisplayScale, jointLattice, mirrorJoint, removeJoint, removeJoint

Python examples

import maya.cmds as cmds

# To add a joint cluster to a rigidly bound skin.
# Note the skin should be at bind pose when the cluster is added.
#
cmds.jointCluster( j='joint2', ab=20, bb=20 )