# CSLIKEffector Class Reference

`#include <IKEffector.h>`

Inheritance diagram for CSLIKEffector:

List of all members.

## Public Member Functions
| CSLIKEffector (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, CSLModel *in_pRoot)
virtual | ~CSLIKEffector ()
SI_Bool | GetRotationFlag ()
SI_Void | SetRotationFlag (SI_Bool in_bValue)
virtual SI_Error | Synchronize ()
virtual ETemplateType | Type ()
virtual CSLAnimatableType * | ParameterFromName (SI_Char *in_szName)
virtual SI_Bool | ValidateParent (CSLModel *in_pNewParent)

## Detailed Description

Describes the effector of an IK chain (see the SI_IK_Effector template reference).

## Constructor & Destructor Documentation

CSLIKEffector | ( | CSLScene * | in_pScene,
|  | CSLModel * | in_pModel,
|  | CdotXSITemplate * | in_pTemplate,
|  | CSLModel * | in_pRoot |
| ) |  |  |

Constructor

Parameters:

  | in_pScene | Pointer to the scene containing the effector
  | in_pModel | Pointer to the model containing the effector
  | in_pTemplate | Pointer to the CdotXSITemplate containing the effector

Returns:
  an instance of CSLIKEffector

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

Destructor

## Member Function Documentation

SI_Bool GetRotationFlag | ( |  | ) |

Return the inherit rotation flag of the effector.

Returns:
  SI_Bool Inherit rotation flag.

SI_Void SetRotationFlag | ( | SI_Bool | in_bValue | ) |

Change the inherit rotation flag of the joint.

Parameters:

  | in_bValue | New inherit rotation flag.

Returns:
  SI_Void

virtual SI_Error Synchronize | ( |  | ) | `[virtual]`

Synchronizes this IK effector 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 effector

Implements CSLTemplate.

virtual CSLAnimatableType* ParameterFromName | ( | SI_Char * | in_szName | ) | `[virtual]`

Gets a handle on one of this light's parameters by using its name

Parameters:

  | in_szName | the name of the parameter to get the handle from

Returns:
  CSLAnimatableType* the handle to the parameter

Reimplemented from CSLTemplate.

virtual SI_Bool ValidateParent | ( | CSLModel * | in_pNewParent | ) | `[virtual]`

Validate that the parent is of valid type

Parameters:

  | in_pNewParent | the parent to validate against

Returns:
  SI_Bool whether the parent is valid or not

Reimplemented from CSLPrimitive.

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

- IKEffector.h