CSLXSITransform Class Reference

This class represents an XSI_Translate template. More...

#include <XSITransform.h>

Inheritance diagram for CSLXSITransform:

CSLTemplate CSIBCNode List of all members.

Public Member Functions
CSIBCMatrix4x4  GetMatrix ()
CSIBCVector3D  GetEulerRotation ()
SI_Void  SetEulerRotation (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetScale ()
SI_Void  SetScale (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetTranslation ()
SI_Void  SetTranslation (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetShear ()
SI_Void  SetShear (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetPivotPosition ()
SI_Void  SetPivotPosition (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetPivotRotation ()
SI_Void  SetPivotRotation (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetPivotScale ()
SI_Void  SetPivotScale (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetPivotCompPosition ()
SI_Void  SetPivotCompPosition (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetPivotCompRotation ()
SI_Void  SetPivotCompRotation (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetPivotCompScale ()
SI_Void  SetPivotCompScale (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetNeutralPosePosition ()
SI_Void  SetNeutralPosePosition (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetNeutralPoseRotation ()
SI_Void  SetNeutralPoseRotation (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetNeutralPoseScale ()
SI_Void  SetNeutralPoseScale (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetNeutralPoseShear ()
SI_Void  SetNeutralPoseShear (CSIBCVector3D &in_rValue)
SI_Bool  GetHierarchicalScaling ()
SI_Void  SetHierarchicalScaling (SI_Bool in_bValue)
CSLTemplate::ERotationOrder  GetRotationOrder ()
const SI_Char *  GetRotationOrderAsString ()
SI_Error  SetRotationOrder (CSLTemplate::ERotationOrder)
SI_Error  SetRotationOrderAsString (const SI_Char *)
SI_Error  ComputeLocalMatrix ()
SI_Error  ComputeGlobalMatrix ()
CSIBCMatrix4x4 &  GetGlobalMatrix ()
SI_Error  ComputeLocalMatrix (SI_Float in_fTime)
SI_Error  ComputeGlobalMatrix (SI_Float in_fTime)
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)
CSLVector3DProxy *  ScaleProxy ()
CSLBoolProxy *  HierarchicalScalingProxy ()
CSLVector3DProxy *  RotationProxy ()
CSLVector3DProxy *  TranslationProxy ()
CSLVector3DProxy *  ShearProxy ()
CSLVector3DProxy *  PivotPositionProxy ()
CSLVector3DProxy *  PivotRotationProxy ()
CSLVector3DProxy *  PivotScaleProxy ()
CSLVector3DProxy *  PivotCompPositionProxy ()
CSLVector3DProxy *  PivotCompRotationProxy ()
CSLVector3DProxy *  PivotCompScaleProxy ()
CSLVector3DProxy *  NeutralPoseScaleProxy ()
CSLVector3DProxy *  NeutralPoseRotationProxy ()
CSLVector3DProxy *  NeutralPosePositionProxy ()
CSLVector3DProxy *  NeutralPoseShearProxy ()
CSLStrEnumProxy< ERotationOrder,
SI_ZYX > * 		 RotationOrderProxy ()
CSLXSILimit *  ConnectXSILimit (CSLXSILimit *in_pXSILimit)
CSLXSILimit *  AddXSILimit (CSLAnimatableType *in_pParameter)
SI_Error  ClearXSILimits ()
CSLXSILimit **  GetXSILimitList ()
SI_Int  GetXSILimitCount ()
SI_Error  RemoveXSILimit (SI_Int in_nIndex)
SI_Error  RemoveXSILimit (CSLXSILimit *in_pToRemove)

Detailed Description

This class represents an XSI_Translate template.

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

Member Function Documentation

CSIBCMatrix4x4 GetMatrix (  ) 

Returns the transformation matrix.

Returns:
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

CSIBCVector3D GetShear (  ) 

Returns the shear.

Returns:
Shear value.

SI_Void SetShear ( CSIBCVector3D &  in_rValue  ) 

Changes the shear value.

Parameters:
[in]  in_rValue  New translation value

CSIBCVector3D GetPivotPosition (  ) 

Returns the pivot position.

Returns:
Pivot position value.

SI_Void SetPivotPosition ( CSIBCVector3D &  in_rValue  ) 

Changes the pivot position value.

Parameters:
[in]  in_rValue  New pivot position value

CSIBCVector3D GetPivotRotation (  ) 

Returns the pivot rotation.

Returns:
Pivot rotation value.

SI_Void SetPivotRotation ( CSIBCVector3D &  in_rValue  ) 

Changes the pivot rotation value.

Parameters:
[in]  in_rValue  New pivot rotation value

CSIBCVector3D GetPivotScale (  ) 

Returns the pivot scale.

Returns:
Pivot scale value.

SI_Void SetPivotScale ( CSIBCVector3D &  in_rValue  ) 

Changes the pivot scale value.

Parameters:
[in]  in_rValue  New translation value

CSIBCVector3D GetPivotCompPosition (  ) 

Returns the pivot compensation position.

Returns:
pivot compensation position value.

SI_Void SetPivotCompPosition ( CSIBCVector3D &  in_rValue  ) 

Changes the pivot compensation position value.

Parameters:
[in]  in_rValue  New pivot compensation position value

CSIBCVector3D GetPivotCompRotation (  ) 

Returns the pivot compensation rotation.

Returns:
pivot compensation rotation value.

SI_Void SetPivotCompRotation ( CSIBCVector3D &  in_rValue  ) 

Changes the pivot compensation rotation value.

Parameters:
[in]  in_rValue  New pivot compensation rotation value

CSIBCVector3D GetPivotCompScale (  ) 

Returns the pivot compensation scale.

Returns:
pivot compensation scale value.

SI_Void SetPivotCompScale ( CSIBCVector3D &  in_rValue  ) 

Changes the pivot compensation scale value.

Parameters:
[in]  in_rValue  New pivot compensation scale value

CSIBCVector3D GetNeutralPosePosition (  ) 

Returns the neutral pose position.

Returns:
neutral pose position value.

SI_Void SetNeutralPosePosition ( CSIBCVector3D &  in_rValue  ) 

Changes the neutral pose position value.

Parameters:
[in]  in_rValue  New neutral pose position value

CSIBCVector3D GetNeutralPoseRotation (  ) 

Returns the neutral pose rotation.

Returns:
neutral pose rotation value.

SI_Void SetNeutralPoseRotation ( CSIBCVector3D &  in_rValue  ) 

Changes the neutral pose rotation value.

Parameters:
[in]  in_rValue  New neutral pose rotation value

CSIBCVector3D GetNeutralPoseScale (  ) 

Returns the neutral pose scale.

Returns:
neutral pose scale value.

SI_Void SetNeutralPoseScale ( CSIBCVector3D &  in_rValue  ) 

Changes the neutral pose scale value.

Parameters:
[in]  in_rValue  New neutral pose scale value

CSIBCVector3D GetNeutralPoseShear (  ) 

Returns the neutral pose shear.

Returns:
neutral pose shear value.

SI_Void SetNeutralPoseShear ( CSIBCVector3D &  in_rValue  ) 

Changes the neutral pose shear value.

Parameters:
[in]  in_rValue  New neutral pose shear value

SI_Bool GetHierarchicalScaling (  ) 

Returns the hirearchical scaling flag.

Returns:
hirearchical scaling flag value.

SI_Void SetHierarchicalScaling ( SI_Bool  in_bValue  ) 

Changes the hirearchical scaling flag value.

Parameters:
[in]  in_bValue  New hirearchical scaling flag value

CSLTemplate::ERotationOrder GetRotationOrder (  ) 

Returns the rotation order.

Returns:
Rotation order.

const SI_Char* GetRotationOrderAsString (  ) 

Returns the rotation order as a string.

Returns:
Rotation order.

SI_Error SetRotationOrder ( CSLTemplate::ERotationOrder   ) 

Changes the rotation order.

Returns:
Operation successful or not.

SI_Error SetRotationOrderAsString ( const SI_Char *   ) 

Changes the rotation order using a string value.

Returns:
Operation successful or not.

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_Error ComputeLocalMatrix ( SI_Float  in_fTime  ) 

Computes this CSLTransform's local matrix at the specified time value.

Parameters:
[in]  in_fTime  The time
Returns:
Error code

SI_Error ComputeGlobalMatrix ( SI_Float  in_fTime  ) 

Computes this CSLTransform's global matrix at the specified time value. Also forces an evaluation of the parent global matrix to ensure a correct global matrix.

Parameters:
[in]  in_fTime  The time
Returns:
Error code

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_TRANSFORM  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.

CSLVector3DProxy* ScaleProxy (  )  [inline]

Returns the proxy to the scale vector

Returns:
Proxy to the scale vector

CSLBoolProxy* HierarchicalScalingProxy (  )  [inline]

Returns the proxy to the hierarchical scaling value

Returns:
Proxy to the hierarchical scaling value

CSLVector3DProxy* RotationProxy (  )  [inline]

Returns the proxy to the Rotation vector

Returns:
Proxy to the Rotation vector

CSLVector3DProxy* TranslationProxy (  )  [inline]

Returns the proxy to the Translation vector

Returns:
Proxy to the Translation vector

CSLVector3DProxy* ShearProxy (  )  [inline]

Returns the proxy to the Shear vector

Returns:
CSLVector3DProxy*

CSLVector3DProxy* PivotPositionProxy (  )  [inline]

Returns the proxy to the Pivot Position vector

Returns:
Proxy to the Pivot Position vector

CSLVector3DProxy* PivotRotationProxy (  )  [inline]

Returns the proxy to the Pivot Rotation vector

Returns:
Proxy to the Pivot Rotation vector

CSLVector3DProxy* PivotScaleProxy (  )  [inline]

Returns the proxy to the Pivot Scale vector

Returns:
Proxy to the Pivot Scale vector

CSLVector3DProxy* PivotCompPositionProxy (  )  [inline]

Returns the proxy to the Pivot Comp Position vector

Returns:
Proxy to the Pivot Comp Position vector

CSLVector3DProxy* PivotCompRotationProxy (  )  [inline]

Returns the proxy to the Pivot Comp Rotation vector

Returns:
Proxy to the Pivot Comp Rotation vector

CSLVector3DProxy* PivotCompScaleProxy (  )  [inline]

Returns the proxy to the Pivot Comp Scale vector

Returns:
Proxy to the Pivot Comp Scale vector

CSLVector3DProxy* NeutralPoseScaleProxy (  )  [inline]

Returns the proxy to the Neutral Pose Scale vector

Returns:
Proxy to the Neutral Pose Scale vector

CSLVector3DProxy* NeutralPoseRotationProxy (  )  [inline]

Returns the proxy to the Neutral Pose Rotation vector

Returns:
Proxy to the Neutral Pose Rotation vector

CSLVector3DProxy* NeutralPosePositionProxy (  )  [inline]

Returns the proxy to the Neutral Pose Position vector

Returns:
Proxy to the Neutral Pose Position vector

CSLVector3DProxy* NeutralPoseShearProxy (  )  [inline]

Returns the proxy to the Neutral Pose Shear vector

Returns:
Proxy to the Neutral Pose Shear vector

CSLStrEnumProxy<ERotationOrder, SI_ZYX>* RotationOrderProxy (  )  [inline]

Returns the proxy to the Rotation Order value

Returns:
Proxy to the Rotation Order value

CSLXSILimit* ConnectXSILimit ( CSLXSILimit *  in_pXSILimit  ) 

Connects a limit to this template

Parameters:
[in]  in_pXSILimit  the limit to connect
Returns:
Pointer to the specified limit

CSLXSILimit* AddXSILimit ( CSLAnimatableType *  in_pParameter  ) 

Adds a limit to this template

Parameters:
[in]  in_pParameter  Animatable type of limit to add
Returns:
Pointer to the newly created limit, NULL if failed

SI_Error ClearXSILimits (  ) 

Clears all limits on that template

Returns:
Whether the function failed or succeeded

CSLXSILimit** GetXSILimitList (  ) 

Returns the list of limits on that template

Returns:
Array of limits

SI_Int GetXSILimitCount (  ) 

Returns the number of limits on that template

Returns:
Number of limits on that template

SI_Error RemoveXSILimit ( SI_Int  in_nIndex  ) 

Removes a limit by index

Parameters:
[in]  in_nIndex  Index of limit to remove
Returns:
Whether the function failed or succeeded

SI_Error RemoveXSILimit ( CSLXSILimit *  in_pToRemove  ) 

Removes a limit

Parameters:
[in]  in_pToRemove  Limit to remove
Returns:
Whether the function failed or succeeded

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