Bookshelf Contents Previous Next Glossary Index Search

AlOrientationConstraint

Interface to IK orientation constraint data.

Synopsis

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

Description

Allows access to the IK orientation constraint information on an AlJoint. This class is derived from the AlConstraint class.

(See the discussion of skeletons, joints, contraints, IK, etc. in the Menu Book and Tool Book for a full description.)

Summary

AlOrientationConstraint::AlOrientationConstraint()

Description

Constructs an AlOrientationConstraint wrapper object.

AlOrientationConstraint::~AlOrientationConstraint()

Description

Deletes an AlOrientationConstraint wrapper object.

AlObject *AlOrientationConstraint::copyWrapper() const

Description

Wrapper object duplicator for AlOrientationConstraint.

statusCode AlOrientationConstraint::create(AlDagNode* srcNode, AlDagNode* dstNode )

Description

Performs all the initialization necessary to attach the constraint node to a DAG joint node as an orientation constraint. A DAG node can not be constrained to itself.

Arguments

< srcNode - AlDagNode 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 AlOrientationConstraint::create(AlDagNode* srcNode, AlDagNode* dstNode , double uv[2])

Description:

This method performs all the initialization necessary to attach the constraint node to dag joint node as a uv orientation constraint. A dag node can not be constrained to itself. The destNode must be a spline geometry node, e.g. 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 AlOrientationConstraint::type() const

Description

Returns the class identifier kOrientationConstraintType.

AlOrientationConstraint* AlOrientationConstraint::asOrientationConstraintPtr()

Description

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

statusCode AlOrientationConstraint::goalX( double ex[3] ) const

Description

Returns the orientation goal in the X axis for this constraint.

statusCode AlOrientationConstraint::goalY( double ey[3] ) const

Description

Returns the orientation goal in the Y axis for this constraint.

statusCode AlOrientationConstraint::goalZ( double ez[3] ) const

Description

Returns the orientation goal in the Z axis for this constraint.



Bookshelf Contents Previous Next Glossary Index Search

[email protected]
Copyright © 1998, Alias|Wavefront, a division of Silicon Graphics Limited. All rights reserved.