# CSLIKResolutionPlane Class Reference

`#include <IKJoint.h>`

Inheritance diagram for CSLIKResolutionPlane:

List of all members.

## Public Types
enum | EIKResPlaneType { SI_IKRPTYPE_DEFAULT, SI_IKRPTYPE_PREFAXIS, SI_IKRPTYPE_UPVECTOR }
| Joint solver types. More...
## Public Member Functions
| CSLIKResolutionPlane (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate)
virtual | ~CSLIKResolutionPlane ()
EIKResPlaneType | GetResolutionPlaneType ()
SI_Void | SetResolutionPlaneType (EIKResPlaneType in_Type)
SI_Float | GetRoll ()
SI_Void | SetRoll (SI_Float in_fValue)
SI_Bool | GetPrefRotXAsRoll ()
SI_Void | SetPrefRotXAsRoll (SI_Bool in_bValue)
CSIBCVector3D | GetUpVector ()
SI_Void | SetUpVector (CSIBCVector3D &in_rValue)
SI_Bool | GetUpVectorRelativeToRoot ()
SI_Void | SetUpVectorRelativeToRoot (SI_Bool in_bValue)
CSIBCVector3D | GetPreferredRotation ()
SI_Void | SetPreferredRotation (CSIBCVector3D &in_rValue)
SI_Bool | GetPreferredRotationRelativeToRoot ()
SI_Void | SetPreferredRotationRelativeToRoot (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 resolution plane of an IK chain (see the XSI_IK_ResolutionPlane template reference).

## Member Enumeration Documentation

enum EIKResPlaneType

Joint solver types.

Enumerator:

  SI_IKRPTYPE_DEFAULT | default resolution plane type
  SI_IKRPTYPE_PREFAXIS | preferred axis
  SI_IKRPTYPE_UPVECTOR | up vector

## Constructor & Destructor Documentation

CSLIKResolutionPlane | ( | CSLScene * | in_pScene,
|  | CSLModel * | in_pModel,
|  | CdotXSITemplate * | in_pTemplate |
| ) |  |  |

Constructor

Parameters:

  | in_pScene | Pointer to the scene containing the Resolution Plane
  | in_pModel | Pointer to the model containing the Resolution Plane
  | in_pTemplate | Pointer to the CdotXSITemplate containing the Resolution Plane

Returns:
  an instance of CSLIKResolutionPlane

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

Destructor

## Member Function Documentation

EIKResPlaneType GetResolutionPlaneType | ( |  | ) |

Return the resolution plane type of the joint.

Returns:
  EJointSolverType resolution plane type.

SI_Void SetResolutionPlaneType | ( | EIKResPlaneType | in_Type | ) |

Change the resolution plane type of the joint.

Parameters:

  | in_Type | New resolution plane type.

Returns:
  SI_Void

SI_Float GetRoll | ( |  | ) |

Return the Roll value of the Resolution Plane.

Returns:
  SI_Float Roll value.

SI_Void SetRoll | ( | SI_Float | in_fValue | ) |

Change the Roll value of the Resolution Plane.

Parameters:

  | in_fValue | New Roll value.

Returns:
  SI_Void

SI_Bool GetPrefRotXAsRoll | ( |  | ) |

Return a flag indicating if the preferred rotation in X should be used as the roll angle.

Returns:
  SI_Bool status of the preference.

SI_Void SetPrefRotXAsRoll | ( | SI_Bool | in_bValue | ) |

Change the flag indicating if the preferred rotation in X should be used as the roll angle.

Parameters:

  | in_bValue | new status of the preference.

Returns:
  SI_Void

CSIBCVector3D GetUpVector | ( |  | ) |

Return the prefered rotation of the Resolution Plane.

Returns:
  CSIBCVector3D Up Vector value.

SI_Void SetUpVector | ( | CSIBCVector3D & | in_rValue | ) |

Change the Up Vector value of the Resolution Plane.

Parameters:

  | in_rValue | New Up Vector value.

Returns:
  SI_Void

SI_Bool GetUpVectorRelativeToRoot | ( |  | ) |

Return a flag indicating if the up vector is relative to the IK root.

Returns:
  SI_Bool status of the preference.

SI_Void SetUpVectorRelativeToRoot | ( | SI_Bool | in_bValue | ) |

Change the flag indicating if the up vector is relative to the IK root.

Parameters:

  | in_bValue | new status of the preference.

Returns:
  SI_Void

CSIBCVector3D GetPreferredRotation | ( |  | ) |

Return the prefered rotation of the Resolution Plane.

Returns:
  CSIBCVector3D Preferred rotation value.

SI_Void SetPreferredRotation | ( | CSIBCVector3D & | in_rValue | ) |

Change the preferred rotation value of the Resolution Plane.

Parameters:

  | in_rValue | New preferred rotation value.

Returns:
  SI_Void

SI_Bool GetPreferredRotationRelativeToRoot | ( |  | ) |

Return a flag indicating if the Preferred Rotation is relative to the IK root.

Returns:
  SI_Bool status of the preference.

SI_Void SetPreferredRotationRelativeToRoot | ( | SI_Bool | in_bValue | ) |

Change the flag indicating if the Preferred Rotation is relative to the IK root.

Parameters:

  | in_bValue | new status of the preference.

Returns:
  SI_Void

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

Synchronizes this IK Resolution Plane 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 Resolution Plane

Implements CSLTemplate.

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

Gets a handle on one of this template'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

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

- IKJoint.h