CSLIKRoot Class Reference

This class represents an SI_IK_Root template. More...

#include <IKRoot.h>

Inheritance diagram for CSLIKRoot:

CSLIK CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Member Functions
  CSLIKRoot (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual  ~CSLIKRoot ()
CSLModel *  GetEffector ()
CSLModel **  GetJointList ()
SI_Int  GetJointCount ()
CSLModel *  ConnectJoint (CSLModel *in_pNewJoint)
CSLModel *  ConnectEffector (CSLModel *in_pNewEffector)
virtual SI_Error  Synchronize ()
virtual ETemplateType  Type ()

Detailed Description

This class represents an SI_IK_Root template.

Describes the root of an IK chain (see the SI_IK_Root template reference).

Constructor & Destructor Documentation

CSLIKRoot ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate  
)

Constructor

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

virtual ~CSLIKRoot (  )  [virtual]

Destructor

Member Function Documentation

CSLModel* GetEffector (  ) 

Returns the effector of the IK chain.

Returns:
Pointer to a texture 2D object.

CSLModel** GetJointList (  ) 

Returns an array of all joints in the IK chain.

Returns:
Array of pointers to IK joint objects.

SI_Int GetJointCount (  ) 

Returns the number of joints in the IK chain.

Returns:
Number of joint.

CSLModel* ConnectJoint ( CSLModel *  in_pNewJoint  ) 

Connects a joint to this IK root

Parameters:
[in]  in_pNewJoint  the joint to connect
Returns:
the joint to connect

CSLModel* ConnectEffector ( CSLModel *  in_pNewEffector  ) 

Connects an effector to this IK root

Parameters:
[in]  in_pNewEffector  the effector to connect
Returns:
the effector to connect

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this IK root instance with its IO layer representation

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

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [virtual]

Returns the template type

Returns:
CSLTemplate::SI_IK_ROOT the template type of the IK root

Implements CSLTemplate.

The documentation for this class was generated from the following file: