CSLIKResolutionPlane Class Reference

This class represents an XSI_IK_ResolutionPlane template. More...

#include <IKJoint.h>

Inheritance diagram for CSLIKResolutionPlane:

CSLTemplate CSIBCNode List of all members.

Public Types
enum   EIKResPlaneType {
  SI_IKRPTYPE_DEFAULT,
  SI_IKRPTYPE_PREFAXIS,
  SI_IKRPTYPE_UPVECTOR
}

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

This class represents an XSI_IK_ResolutionPlane template.

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]  in_pScene  Pointer to the scene containing the Resolution Plane
[in]  in_pModel  Pointer to the model containing the Resolution Plane
[in]  in_pTemplate  Pointer to the CdotXSITemplate containing the Resolution Plane
Returns:
an instance of CSLIKResolutionPlane

virtual ~CSLIKResolutionPlane (  )  [virtual]

Destructor

Member Function Documentation

EIKResPlaneType GetResolutionPlaneType (  ) 

Returns the resolution plane type of the joint.

Returns:
resolution plane type.

SI_Void SetResolutionPlaneType ( EIKResPlaneType  in_Type  ) 

Changes the resolution plane type of the joint.

Parameters:
[in]  in_Type  New resolution plane type.

SI_Float GetRoll (  ) 

Returns the Roll value of the Resolution Plane.

Returns:
Roll value.

SI_Void SetRoll ( SI_Float  in_fValue  ) 

Changes the Roll value of the Resolution Plane.

Parameters:
[in]  in_fValue  New Roll value.

SI_Bool GetPrefRotXAsRoll (  ) 

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

Returns:
status of the preference.

SI_Void SetPrefRotXAsRoll ( SI_Bool  in_bValue  ) 

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

Parameters:
[in]  in_bValue  new status of the preference.

CSIBCVector3D GetUpVector (  ) 

Returns the prefered rotation of the Resolution Plane.

Returns:
Up Vector value.

SI_Void SetUpVector ( CSIBCVector3D &  in_rValue  ) 

Changes the Up Vector value of the Resolution Plane.

Parameters:
[in]  in_rValue  New Up Vector value.

SI_Bool GetUpVectorRelativeToRoot (  ) 

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

Returns:
status of the preference.

SI_Void SetUpVectorRelativeToRoot ( SI_Bool  in_bValue  ) 

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

Parameters:
[in]  in_bValue  new status of the preference.

CSIBCVector3D GetPreferredRotation (  ) 

Returns the prefered rotation of the Resolution Plane.

Returns:
Preferred rotation value.

SI_Void SetPreferredRotation ( CSIBCVector3D &  in_rValue  ) 

Changes the preferred rotation value of the Resolution Plane.

Parameters:
[in]  in_rValue  New preferred rotation value.

SI_Bool GetPreferredRotationRelativeToRoot (  ) 

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

Returns:
status of the preference.

SI_Void SetPreferredRotationRelativeToRoot ( SI_Bool  in_bValue  ) 

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

Parameters:
[in]  in_bValue  new status of the preference.

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this IK Resolution Plane instance with its IO layer representation

Return values:
SI_Error::SI_SUCCESS  this function always returns SI_SUCCESS

Reimplemented from CSLTemplate.

virtual ETemplateType Type (  )  [virtual]

Returns the template type of the Resolution Plane

Return values:
CSLTemplate::XSI_IK_RESOLUTIONPLANE  the template type

Implements CSLTemplate.

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

Returns a handle on one of this template's parameters by using its name

Parameters:
[in]  in_szName  the name of the parameter to get the handle from
Returns:
the handle to the parameter

Reimplemented from CSLTemplate.

virtual SI_Bool ValidateParent ( CSLModel *  in_pNewParent  )  [virtual]

Validates that the parent is of valid type

Parameters:
[in]  in_pNewParent  the parent to validate against
Returns:
whether the parent is valid or not

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