CSLTransform Class Reference

This class represents an SI_Transform template. More...

#include <Transform.h>

Inheritance diagram for CSLTransform:

CSLTemplate CSIBCNode List of all members.

Public Member Functions

CSIBCMatrix4x4  GetMatrix ()
SI_Void  SetMatrix (CSIBCMatrix4x4 &in_rValue)
CSIBCVector3D  GetEulerRotation ()
SI_Void  SetEulerRotation (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetScale ()
SI_Void  SetScale (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetTranslation ()
SI_Void  SetTranslation (CSIBCVector3D &in_rValue)
SI_Error  ComputeLocalMatrix ()
SI_Error  ComputeGlobalMatrix ()
CSIBCMatrix4x4 GetGlobalMatrix ()
SI_Void  SetGlobalMatrix (CSIBCMatrix4x4 &in_rValue)
virtual CSLAnimatableType ParameterFromName (SI_Char *in_szName)
virtual CSLAnimatableType ParameterFromType (EFCurveType in_Type, SI_Char *in_szParameterName)
virtual ETemplateType  Type ()

Detailed Description

This class represents an SI_Transform template.

This class handles the transformation matrix of a model (see the SI_Transform template reference). It provides functions to set the local scaling, rotation and position of the model and also provides easy and fast access to the model's global tranform.


Member Function Documentation

CSIBCMatrix4x4 GetMatrix (  ) 

Returns the transformation matrix.

Returns:
Transformation matrix.

SI_Void SetMatrix ( CSIBCMatrix4x4 in_rValue  ) 

Changes the transformation matrix.

Parameters:
[in]  in_rValue  New Transformation matrix.

CSIBCVector3D GetEulerRotation (  ) 

Returns the actual rotation in euler representation.

Returns:
Rotation value.

SI_Void SetEulerRotation ( CSIBCVector3D in_rValue  ) 

Changes the rotation value in euler representation.

Parameters:
[in]  in_rValue  New rotation value

CSIBCVector3D GetScale (  ) 

Returns 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

SI_Error ComputeLocalMatrix (  ) 

Computes this CSLTransform's local matrix.

Returns:
Error code

SI_Error ComputeGlobalMatrix (  ) 

Computes this CSLTransform's global matrix.

Returns:
Error code

CSIBCMatrix4x4& GetGlobalMatrix (  ) 

Returns the global matrix

Returns:
The global matrix

SI_Void SetGlobalMatrix ( CSIBCMatrix4x4 in_rValue  ) 

Sets the global transformation matrix.

Parameters:
[in]  in_rValue  New Transformation matrix.

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::SI_TRANSFORM  Template type

Implements CSLTemplate.


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