AlPointConstraint

Synopsis

#include <AlPointConstraint.h> class AlPointConstraint : public AlConstraint AlPointConstraint(); virtual 	~AlPointConstraint(); virtual AlObject*	copyWrapper() const; statusCode	create( AlDagNode*, AlDagNode* ); statusCode	create( AlDagNode*, AlDagNode*, double[2] ); virtual AlObjectType	type() const; statusCode	point( double[3] ) const;

Description

The AlPointConstraint class allows access to the IK point constraint information on an AlJoint. This class is derived from the AlConstraint class.

(See the discussion of skeletons, joints, constraints, ik, and so on, in the Alias manuals for a full description.)

AlPointConstraint::AlPointConstraint()

Description

Constructs an AlPointConstraint wrapper object.

AlPointConstraint::~AlPointConstraint()

Description

Deletes an AlPointConstraint wrapper object.

AlObject *AlPointConstraint::copyWrapper() const

Description

Wrapper object duplicator for AlPointConstraint.

statusCode AlPointConstraint::create( AlDagNode* srcNode, AlDagNode* destNode )

Description

Does all the initialization necessary to attach the constraint node to the DAG node as a point constraint. A DAG node can not be constrained to itself.

Arguments

< srcNode - AlDagNode that this constraint is to be added to

< destNode - the AlDagNode that srcNode will be constrained to

Return Codes

sInvalidArgument - one of the arguments was wrong or tried to constrain a node to itself

sInsufficientMemory - ran out of memory

sFailure - failed to add the constraint

sSuccess - successfully added the constraint

statusCode AlPointConstraint::create( AlDagNode* srcNode, AlDagNode* destNode, double uv[2] )

Description

This method does all the initialization necessary to attach the constraint node to the dag node as an uv point constraint. A dag node can not be constrained to itself. The destNode must be a spline geometry node, for example, a spline curve or a spline surface.

Arguments

< srcNode - AlDagNode this constraint is to be added to.

< destNode - The AlDagNode that srcNode will be constrained to.

< uv[2] - The uv parameter on destNode that srcNode will be constrained to. If the destNode is a curve, only uv[0] is used.

Return Codes

sInvalidArgument - one of the arguments was wrong or tried to constrain a node to itself.

sInsufficientMemory - ran out of memory.

sFailure - failed to add the constraint.

sSuccess - successfully added the constraint.

AlObjectType AlPointConstraint::type() const

Description

Returns the class identifier kPointConstraintType;

AlPointConstraint* AlPointConstraint::asPointConstraintPtr()

Description

This virtual function returns a non-null pointer to itself, indicating that it is safe to cast to an object of this class.

statusCode AlPointConstraint::point( double pnt[3] ) const

Description

Returns the coordinates of the point being constrained to.