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

Synopsis

poleVectorConstraint [-name string] [-remove] [-targetList] [-weight float] [-weightAliasList] [target ...] [object]

poleVectorConstraint is undoable, queryable, and editable.

Constrains the poleVector of an ikRPsolve handle to point at a target object or at the average position of a number of targets. An poleVectorConstraint takes as input one or more "target" DAG transform nodes at which to aim pole vector for an IK handle using the rotate plane solver. The pole vector is adjust such that the in weighted average of the world space position target objects lies is the "rotate plane" of the handle.

Flags

name, remove, targetList, weight, weightAliasList
Long name (short name) [argument types] Properties
-name(-n) string createqueryedit
Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType

In query mode, this flag needs a value.
-weight(-w) float createqueryedit
Sets the weight value for the specified target(s). If not given at creation time, the default value of 1.0 is used.

In query mode, this flag needs a value.
-remove(-rm) edit
removes the listed target(s) from the constraint.
-targetList(-tl) query
Return the list of target objects.

In query mode, this flag needs a value.
-weightAliasList(-wal) query
Returns the names of the attributes that control the weight of the target objects. Aliases are returned in the same order as the targets are returned by the targetList flag

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 be used more than once in a command

Return value


[string [] ] ( name of the created constraint node)

Related

aimConstraint, geometryConstraint, normalConstraint, orientConstraint, pointConstraint, scaleConstraint, tangentConstraint

MEL examples

// aims the pole vector of handle1 at cone1.
poleVectorConstraint  cone1 handle1;

// uses the average of the position of cone1 and surf2.
poleVectorConstraint -w .1 cone1 surf2 handle2;

// sets the weight for cone1's effect on handle2's poleVector to 10.
poleVectorConstraint -e -w 10. cone1 handle2;

// removes surf2 from handle2's poleVectorConstraint.
poleVectorConstraint -e -rm surf2 handle2;

// adds surf3 to handle2's poleVectorConstraint with the default weight.
poleVectorConstraint surf3 handle2;