Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLIKRoot Class Reference

Describes the root of an IK chain. More...

#include <IKRoot.h>

Inheritance diagram for CSLIKRoot::

CSLIK CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Describes the root of an IK chain.


Constructor & Destructor Documentation

CSLIKRoot::CSLIKRoot CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate
 

Constructor

Parameters:
in_pScene  Pointer to the scene containing the root
in_pModel  Pointer to the model containing the root
in_pTemplate  Pointer to the CdotXSITemplate containing the root
Returns:
an instance of CSLIKRoot

CSLIKRoot::~CSLIKRoot   [virtual]
 

Destructor


Member Function Documentation

CSLModel * CSLIKRoot::ConnectEffector CSLModel   in_pNewEffector
 

Connects an effector to this IK root

Parameters:
in_pNewEffector  the effector to connect
Returns:
CSLModel* the effector to connect

CSLModel * CSLIKRoot::ConnectJoint CSLModel   in_pNewJoint
 

Connects a joint to this IK root

Parameters:
in_pNewJoint  the joint to connect
Returns:
CSLModel* the joint to connect

CSLModel * CSLIKRoot::GetEffector  
 

Return the effector of the IK chain.

Returns:
CSLTexture2D* Pointer to a texture 2D object.

SI_Int CSLIKRoot::GetJointCount  
 

Return the number of joints in the IK chain.

Returns:
SI_Int Number of joint.

CSLModel ** CSLIKRoot::GetJointList  
 

Return an array of all joints in the IK chain.

Returns:
CSLIKKoint** Array of pointers to IK joint objects.

SI_Error CSLIKRoot::Synchronize   [virtual]
 

Synchronizes this IK root instance with its IO layer representation

Returns:
SI_Error
Return values:
SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType CSLIKRoot::Type   [virtual]
 

Get the template type

Returns:
ETemplateType the template type of the IK root

Reimplemented from CSLTemplate.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.