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, and so on, in the Menu Book and Tool
Book for a full description.)
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
Does
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 does 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, 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 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.
AlOrthographicCamera
Interface
to orthographic modeling cameras.
Synopsis
#include <AlOrthographicCamera.h>
class AlOrthographicCamera : public AlCamera
AlOrthographicCamera();
virtual ~AlOrthographicCamera();
virtual statusCode deleteObject();
virtual AlObject* copyWrapper() const;
statusCode create( AlWindow::AlViewType );
virtual AlObjectType type() const;
Description
This class provides an
interface to orthographic cameras, primarily so that one can manipulate
the image planes on those cameras. In general, little can be done
to ortho cameras, as they are more of a modeling tool than geometry.
In that regard, this class contains little functionality.
It is possible to create
a new orthographic camera through the create() call. The valid parameters
to that call are defined in AlWindow.h. Note that creating an orthographic camera
creates the associated modeling window.
AlOrthographicCamera::AlOrthographicCamera()
Description
Constructs
an AlOrthographicCamera wrapper object.
AlOrthographicCamera::~AlOrthographicCamera()
Description
Deletes an AlOrthographicCamera
wrapper object.
statusCode AlOrthographicCamera::deleteObject()
Description
Deletes the orthographic camera node.
Return Codes
sSuccess - the camera
data was successfully deleted
sInvalidObject - the
camera was not valid
AlObject* AlOrthographicCamera::copyWrapper()
const
Description
Makes a copy of the AlCamera. The
returned AlCamera will reference the same data as the original.
AlObjectType AlOrthographicCamera::type()
const
Description
Returns the class identifier ’kOrthographicCameraType’.
AlOrthographicCamera* AlOrthographicCamera::asOrthographicCameraPtr()
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 AlOrthographicCamera::create( AlWindow::AlViewType
viewType )
Description
Creates an
orthographic camera, with the associated window.
Arguments
viewType - type of window
required
Return Codes
sSuccess - everything
was created
sInsufficientMemory -
there was not enough memory
sFailure - camera was
not created
sInvalidArgument - the
viewType must be one of kFront, kRight, kTop
