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


poleVectorConstraint( [target ...] [object] , [layer=string], [name=string], [remove=boolean], [targetList=boolean], [weight=float], [weightAliasList=boolean])

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

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.

Return value

string[]name of the created constraint node

In query mode, return type is based on queried flag.


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


layer, 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
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.
remove(rm) boolean edit
removes the listed target(s) from the constraint.
targetList(tl) boolean query
Return the list of target objects.
weightAliasList(wal) boolean 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
layer(l) string createedit
Specify the name of the animation layer where the constraint should be added.

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.

Python examples

import maya.cmds as cmds

# aims the pole vector of handle1 at cone1.
cmds.poleVectorConstraint( 'cone1', 'handle1' )

# uses the average of the position of cone1 and surf2.
cmds.poleVectorConstraint( 'cone1', 'surf2', 'handle2', w=.1 )

# sets the weight for cone1's effect on handle2's poleVector to 10.
cmds.poleVectorConstraint( 'cone1', 'handle2', e=True, w=10. )

# removes surf2 from handle2's poleVectorConstraint.
cmds.poleVectorConstraint( 'surf2', 'handle2', e=True, rm=True )

# adds surf3 to handle2's poleVectorConstraint with the default weight.
cmds.poleVectorConstraint( 'surf3', 'handle2' )