Go to: Synopsis. Return value. Related. Flags. Python examples.
pointOnPolyConstraint(
[target...] [object]
, [layer=string], [maintainOffset=boolean], [name=string], [offset=[float, float, float]], [remove=boolean], [skip=string], [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.
pointOnPolyConstraint is undoable, queryable, and editable.
Constrain an object's position to the position of the target object or
to the average position of a number of targets.
A pointOnPolyConstraint takes as input one or more "target" DAG transform
nodes at which to position the single "constraint object" DAG
transform node. The pointOnPolyConstraint positions the constrained object
at the weighted average of the world space position target
objects.
| string[] | Name of the created constraint node |
In query mode, return type is based on queried flag.
aimConstraint, geometryConstraint, normalConstraint, orientConstraint, parentConstraint, poleVectorConstraint, scaleConstraint, tangentConstraint
layer, maintainOffset, name, offset, remove, skip, targetList, weight, weightAliasList
| Long name (short name) |
Argument types |
Properties |
|
layer(l)
|
string
|
 
|
|
Specify the name of the animation layer where the constraint should be added.
|
|
maintainOffset(mo)
|
boolean
|
|
|
The offset necessary to preserve the constrained
object's initial position will be calculated and used as the
offset.
|
|
name(n)
|
string
|
|
|
Sets the name of the constraint node to the specified
name. Default name is constrainedObjectName_constraintType
|
|
offset(o)
|
[float, float, float]
|
|
|
Sets or queries the value of the offset. Default is 0,0,0.
|
|
remove(rm)
|
boolean
|
|
|
removes the listed target(s) from the constraint.
|
|
skip(sk)
|
string
|
|
|
Specify the axis to be skipped. Valid values are "x", "y", "z" and "none". During creation, "none" is the default. This flag is multi-use.
|
|
targetList(tl)
|
boolean
|
|
|
Return the list of target objects.
|
|
weight(w)
|
float
|
|
|
Sets the weight value for the specified target(s).
If not given at creation time, the default value of 1.0 is used.
|
|
weightAliasList(wal)
|
boolean
|
|
|
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
|
|
|
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
# Position cube1 at the location of cone1.
cmds.pointOnPolyConstraint( 'cone1', 'cube1' )
# Uses the average of the position of cone1 and surf2.
cmds.pointOnPolyConstraint( 'cone1', 'surf2', 'cube2', w=.1 )
# Sets the weight for cone1's effect on cube2 to 10.
cmds.pointOnPolyConstraint( 'cone1', 'cube2', e=True, w=10.0 )
# Removes surf2 from cube2's pointOnPolyConstraint
cmds.pointOnPolyConstraint( 'surf2', 'cube2', e=True, rm=True )
# Adds surf3 to cube2's pointOnPolyConstraint with the default weight
cmds.pointOnPolyConstraint( 'surf3', 'cube2' )
# Constrain the y & z translation of sph2 to sph1
cmds.pointOnPolyConstraint( 'sph1', 'sph2', skip="x" )