# CSLIKRoot Class Reference

`#include <IKRoot.h>`

Inheritance diagram for CSLIKRoot:

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

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_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

virtual ~CSLIKRoot | ( |  | ) | `[virtual]`

Destructor

## Member Function Documentation

CSLModel* GetEffector | ( |  | ) |

Return the effector of the IK chain.

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

CSLModel** GetJointList | ( |  | ) |

Return an array of all joints in the IK chain.

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

SI_Int GetJointCount | ( |  | ) |

Return the number of joints in the IK chain.

Returns:
  SI_Int Number of joint.

CSLModel* 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* ConnectEffector | ( | CSLModel * | in_pNewEffector | ) |

Connects an effector to this IK root

Parameters:

  | in_pNewEffector | the effector to connect

Returns:
  CSLModel* the effector to connect

virtual SI_Error 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.

virtual ETemplateType Type | ( |  | ) | `[virtual]`

Get the template type

Returns:
  ETemplateType the template type of the IK root

Implements CSLTemplate.

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

- IKRoot.h