# CSLXSIBasePose Class Reference

`#include <XSITransform.h>`

Inheritance diagram for CSLXSIBasePose:

List of all members.

## Public Member Functions
CSIBCMatrix4x4 | GetMatrix ()
CSIBCVector3D | GetEulerRotation ()
SI_Void | SetEulerRotation (const CSIBCVector3D &in_rValue)
CSIBCVector3D | GetScale ()
SI_Void | SetScale (CSIBCVector3D &in_rValue)
CSIBCVector3D | GetTranslation ()
SI_Void | SetTranslation (CSIBCVector3D &in_rValue)
virtual CSLAnimatableType * | ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType * | ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
virtual ETemplateType | Type ()
virtual SI_Error | Synchronize ()
virtual const SI_Char * | GetParameterName (CSLAnimatableType *in_pParameter)
SI_Error | ComputeMatrix ()
CSLVector3DProxy & | GetScaleProxy ()
CSLVector3DProxy & | GetRotationProxy ()
CSLVector3DProxy & | GetTranslationProxy ()
SI_Void | SetMatrix (CSIBCMatrix4x4 &in_Matrix)

## Detailed Description

Handles the base pose matrix of a model (see the XSI_BasePose template reference). It provides functions to set all aspects of the base pose like SRT, pivots, shearing, etc.

## Member Function Documentation

CSIBCMatrix4x4 GetMatrix | ( |  | ) |

Return the BasePoseation matrix.

Returns:
  CSIBCMatrix4x4 Base pose matrix.

CSIBCVector3D GetEulerRotation | ( |  | ) |

Return the actual rotation in euler representation.

Returns:
  CSIBCVector3D Rotation value.

SI_Void SetEulerRotation | ( | const CSIBCVector3D & | in_rValue | ) |

Change the rotation value in euler representation.

Parameters:

  | CSIBCVector3D& | New rotation value

Returns:
  None

CSIBCVector3D GetScale | ( |  | ) |

Return the actual scale.

Returns:
  CSIBCVector3D Scale value.

SI_Void SetScale | ( | CSIBCVector3D & | in_rValue | ) |

Change the scale value.

Parameters:

  | CSIBCVector3D& | New scale value

Returns:
  None

CSIBCVector3D GetTranslation | ( |  | ) |

Return the actual translation.

Returns:
  CSIBCVector3D Translation value.

SI_Void SetTranslation | ( | CSIBCVector3D & | in_rValue | ) |

Change the translation value.

Parameters:

  | CSIBCVector3D& | New translation value

Returns:
  None

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

Return a proxy to the specified parameter.

Parameters:

  | in_szName | Name of the parameter

Returns:
  CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

virtual CSLAnimatableType* ParameterFromType | ( | EFCurveType | in_Type,
|  | SI_Char * | in_szParameterName |
| ) |  |  | `[virtual]`

Return a proxy to the specified parameter.

Parameters:

  | in_Type | Type of parameter
  | in_szParameterName | Name of the parameter if the type is SI_PARAMETER

Returns:
  CSLAnimatableType* Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

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

Indicate which dotXSI template this object describes.

Returns:
  ETemplateType Type of template

Implements CSLTemplate.

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

Synchronize will ensure that the animated parameter is up to date.

Returns:
  SI_Error Error code

Reimplemented from CSLTemplate.

virtual const SI_Char* GetParameterName | ( | CSLAnimatableType * | in_pParameter | ) | `[virtual]`

Return the name (string) of a specified sub parameter.

Parameters:

  | in_pParameter | The sub parameter

Returns:
  SI_Char* Name of the sub parameter.

Reimplemented from CSLTemplate.

SI_Error ComputeMatrix | ( |  | ) |

Computes this CSLBasePose's local matrix.

Returns:
  Error code

CSLVector3DProxy& GetScaleProxy | ( |  | ) |

Return the value of the scale proxy vector.

Returns:
  CSLVector3DProxy& Scale proxy vector value

CSLVector3DProxy& GetRotationProxy | ( |  | ) |

Return the value of the rotation proxy vector.

Returns:
  CSLVector3DProxy& Rotation proxy vector value

CSLVector3DProxy& GetTranslationProxy | ( |  | ) |

Return the value of the Translation proxy vector.

Returns:
  CSLVector3DProxy& Translation proxy vector value

SI_Void SetMatrix | ( | CSIBCMatrix4x4 & | in_Matrix | ) |

Change the base pose matrix values. The scale, rotation and translation values are also updated.

Parameters:

  | CSIBCMatrix4x4& | The matrix that contains the new values

Returns:
  None

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

- XSITransform.h