Go to: Synopsis. Return value. Related. Flags. Python examples.
jointCluster(
string
, [aboveBound=float], [aboveCluster=boolean], [aboveDropoffType=string], [aboveValue=float], [belowBound=float], [belowCluster=boolean], [belowDropoffType=string], [belowValue=float], [deformerTools=boolean], [joint=string], [name=string])
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.
string | Name of the new jointCluster node |
In query mode, return type is based on queried flag.
connectJoint, ikHandle, ikHandleDisplayScale, ikSolver, ikSystem, ikSystemInfo, insertJoint, joint, jointDisplayScale, jointLattice, mirrorJoint, removeJoint, removeJoint
aboveBound, aboveCluster, aboveDropoffType, aboveValue, belowBound, belowCluster, belowDropoffType, belowValue, deformerTools, joint, name
Long name (short name) |
Argument types |
Properties |
aboveBound(ab)
|
float
|
|
|
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.
|
|
belowBound(bb)
|
float
|
|
|
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.
|
|
aboveValue(av)
|
float
|
|
|
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.
|
|
belowValue(bv)
|
float
|
|
|
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.
|
|
joint(j)
|
string
|
|
|
Specifies the joint that the cluster should act about.
|
|
aboveDropoffType(adt)
|
string
|
|
|
Specifies the type of percentage drop-off in the direction
of the bone above this joint. Valid values are "linear",
"exponential", "sine" and "none". Default is linear.
|
|
belowDropoffType(bdt)
|
string
|
|
|
Specifies the type of type of percentage drop-off in the direction
of the bone below this joint. Valid values are "linear",
"exponential", "sine" and "none".
Default is linear.
|
|
aboveCluster(ac)
|
boolean
|
|
|
Returns the name of the cluster associated with the bone
above this joint.
|
|
belowCluster(bc)
|
boolean
|
|
|
Returns the name of the cluster associated with this joint.
|
|
deformerTools(dt)
|
boolean
|
|
|
Used to query for the helper nodes associated with the jointCluster.
|
|
name(n)
|
string
|
|
|
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.
|
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 )