CSLXSIBasePose Class Reference

This class represents an XSI_BasePose template. More...

#include <XSITransform.h>

Inheritance diagram for CSLXSIBasePose:

CSLTemplate CSIBCNode 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

This class represents an XSI_BasePose template.

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 (  ) 

Returns the BasePoseation matrix.

Returns:
Base pose matrix.

CSIBCVector3D GetEulerRotation (  ) 

Returns the actual rotation in euler representation.

Returns:
Rotation value.

SI_Void SetEulerRotation ( const CSIBCVector3D in_rValue  ) 

Changes the rotation value in euler representation.

Parameters:
[in]  in_rValue  New rotation value

CSIBCVector3D GetScale (  ) 

Return the actual scale.

Returns:
Scale value.

SI_Void SetScale ( CSIBCVector3D in_rValue  ) 

Changes the scale value.

Parameters:
[in]  in_rValue  New scale value

CSIBCVector3D GetTranslation (  ) 

Returns the actual translation.

Returns:
Translation value.

SI_Void SetTranslation ( CSIBCVector3D in_rValue  ) 

Changes the translation value.

Parameters:
[in]  in_rValue  New translation value

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

Returns a proxy to the specified parameter.

Parameters:
[in]  in_szName  Name of the parameter
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

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

Returns a proxy to the specified parameter.

Parameters:
[in]  in_Type  Type of parameter
[in]  in_szParameterName  Name of the parameter if the type is SI_PARAMETER
Returns:
Pointer to a parameter proxy.

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [virtual]

Returns the type of this template

Return values:
CSLTemplate::XSI_BASEPOSE  Template type

Implements CSLTemplate.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes to ensure that the animated parameter is up to date.

Returns:
Error code

Reimplemented from CSLTemplate.

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

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

Parameters:
[in]  in_pParameter  The sub parameter
Returns:
Name of the sub parameter.

Reimplemented from CSLTemplate.

SI_Error ComputeMatrix (  ) 

Computes this CSLBasePose's local matrix.

Returns:
Error code

CSLVector3DProxy& GetScaleProxy (  ) 

Returns the value of the scale proxy vector.

Returns:
Scale proxy vector value

CSLVector3DProxy& GetRotationProxy (  ) 

Returns the value of the rotation proxy vector.

Returns:
Rotation proxy vector value

CSLVector3DProxy& GetTranslationProxy (  ) 

Returns the value of the Translation proxy vector.

Returns:
Translation proxy vector value

SI_Void SetMatrix ( CSIBCMatrix4x4 in_Matrix  ) 

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

Parameters:
[in]  in_Matrix  The matrix that contains the new values


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