pymel.core.animation.pointOnPolyConstraint

pointOnPolyConstraint(*args, **kwargs)

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.

Maya Bug Fix:

• when queried, angle offsets would be returned in radians, not current angle unit

Modifications:

• added new syntax for querying the weight of a target object, by passing the constraint first:

  aimConstraint( 'pCube1_aimConstraint1', q=1, weight ='pSphere1' )
  aimConstraint( 'pCube1_aimConstraint1', q=1, weight =['pSphere1', 'pCylinder1'] )
  aimConstraint( 'pCube1_aimConstraint1', q=1, weight =[] )
  

Flags:

Long name (short name)		Argument Types	Properties
layer (l)		unicode
	Specify the name of the animation layer where the constraint should be added.
maintainOffset (mo)		bool
	The offset necessary to preserve the constrained object’s initial position will be calculated and used as the offset.
name (n)		unicode
	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)		bool
	removes the listed target(s) from the constraint.
skip (sk)		unicode
	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.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.
targetList (tl)		bool
	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)		bool
	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

Derived from mel command maya.cmds.pointOnPolyConstraint

Example:

import pymel.core as pm

# Position cube1 at the location of cone1.
pm.pointOnPolyConstraint( 'cone1', 'cube1' )

# Uses the average of the position of cone1 and surf2.
pm.pointOnPolyConstraint( 'cone1', 'surf2', 'cube2', w=.1 )

# Sets the weight for cone1's effect on cube2 to 10.
pm.pointOnPolyConstraint( 'cone1', 'cube2', e=True, w=10.0 )

# Removes surf2 from cube2's pointOnPolyConstraint
pm.pointOnPolyConstraint( 'surf2', 'cube2', e=True, rm=True )

# Adds surf3 to cube2's pointOnPolyConstraint with the default weight
pm.pointOnPolyConstraint( 'surf3', 'cube2' )

# Constrain the y "amp; z translation of sph2 to sph1
pm.pointOnPolyConstraint( 'sph1', 'sph2', skip="x" )