aimConstraint

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

Synopsis

aimConstraint [-aimVector float float float] [-maintainOffset] [-name string] [-offset float float float] [-remove] [-skip string] [-targetList] [-upVector float float float] [-weight float] [-weightAliasList] [-worldUpObject name] [-worldUpType string] [-worldUpVector float float float] [target...] object

aimConstraint is undoable, queryable, and editable.

An aimConstraint takes as input one or more "target" DAG transform nodes at which to aim the single "constraint object" DAG transform node. The aimConstraint orients the constrained object such that the aimVector (in the object's local coordinate system) points to the in weighted average of the world space position target objects. The upVector (again the the object's local coordinate system) is aligned in world space with the worldUpVector.

Return value

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

Related

Flags

Long name (short name)	Argument types	Properties
-name(-n)	string
Sets the name of the constraint node to the specified name. Default name is constrainedObjectName_constraintType
-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.
-remove(-rm)
removes the listed target(s) from the constraint.
-targetList(-tl)
Return the list of target objects.
-weightAliasList(-wal)
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
-aimVector(-aim)	float float float
Set the aim vector. This is the vector in local coordinates that points at the target. If not given at creation time, the default value of (1.0, 0.0, 0.0) is used.
-upVector(-u)	float float float
Set local up vector. This is the vector in local coordinates that aligns with the world up vector. If not given at creation time, the default value of (0.0, 1.0, 0.0) is used.
-worldUpVector(-wu)	float float float
Set world up vector. This is the vector in world coordinates that up vector should align with. See -wut/worldUpType (below)for greater detail. If not given at creation time, the default value of (0.0, 1.0, 0.0) is used.
-worldUpObject(-wuo)	name
Set the DAG object use for worldUpType "object" and "objectrotation". See worldUpType for greater detail. The default value is no up object, which is interpreted as world space.
-worldUpType(-wut)	string
Set the type of the world up vector computation. The worldUpType can have one of 5 values: "scene", "object", "objectrotation", "vector", or "none". If the value is "scene", the upVector is aligned with the up axis of the scene and worldUpVector and worldUpObject are ignored. If the value is "object", the upVector is aimed as closely as possible to the origin of the space of the worldUpObject and the worldUpVector is ignored. If the value is "objectrotation" then the worldUpVector is interpreted as being in the coordinate space of the worldUpObject, transformed into world space and the upVector is aligned as closely as possible to the result. If the value is "vector", the upVector is aligned with worldUpVector as closely as possible and worldUpMatrix is ignored. Finally, if the value is "none" no twist calculation is performed by the constraint, with the resulting "upVector" orientation based previous orientation of the constrained object, and the "great circle" rotation needed to align the aim vector with its constraint. The default worldUpType is "vector".
-offset(-o)	float float float
Sets or queries the value of the offset. Default is 0,0,0.
-maintainOffset(-mo)
The offset necessary to preserve the constrained object's initial rotation will be calculated and used as the offset.
-skip(-sk)	string
Specify the axis to be skipped. Valid values are "x", "y", "z" and "none". During creation, "none" is the default.

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.

MEL examples

// Orients the aim vector of cube1 in it's local coordinate space, to point at cone1.
aimConstraint  cone1 cube1;

// Uses the average of the position of cone1 and surf2.
aimConstraint -w .1 cone1 surf2 cube2;

// Sets the weight for cone1's effect on cube2 to 10.
aimConstraint -e -w 10. cone1 cube2;

// Removes surf2 from cube2's aimConstraint.
aimConstraint -e -rm surf2 cube2;

// Adds surf3 to cube2's aimConstraint with the default weight.
aimConstraint surf3 cube2;

// Aim constrain the z-axis only of sph2 to sph1
aimConstraint -skip x -skip y sph1 sph2;