CSLIKJoint Class Reference

This class represents an SI_IK_Joint template. More...

#include <IKJoint.h>

Inheritance diagram for CSLIKJoint:

CSLIK CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Types
enum   EJointSolverType {
  SI_DEFAULT,
  SI_2D,
  SI_3D
}
  Joint solver types. More...

Public Member Functions
  CSLIKJoint (CSLScene *in_pScene, CSLModel *in_pModel, CdotXSITemplate *in_pTemplate, CSLModel *in_pRoot)
virtual  ~CSLIKJoint ()
SI_Float  GetLength ()
SI_Void  SetLength (SI_Float in_fValue)
CSIBCVector3D  GetPreferredRotation ()
SI_Void  SetPreferredRotation (CSIBCVector3D &in_rValue)
SI_Bool  GetPseudoRoot ()
SI_Void  SetPseudoRoot (SI_Bool in_bValue)
SI_Bool  GetRotationLimitActivation ()
SI_Void  SetRotationLimitActivation (SI_Bool in_bValue)
CSIBCVector3D  GetRotationLimitMaximum ()
SI_Void  SetRotationLimitMaximum (CSIBCVector3D &in_rValue)
CSIBCVector3D  GetRotationLimitMinimum ()
SI_Void  SetRotationLimitMinimum (CSIBCVector3D &in_rValue)
EJointSolverType  GetSolverType ()
SI_Void  SetSolverType (EJointSolverType in_Type)
SI_Float  GetStiffness ()
SI_Void  SetStiffness (SI_Float in_fValue)
SI_Bool  GetStiffnessActivation ()
SI_Void  SetStiffnessActivation (SI_Bool in_bValue)
CSLIKResolutionPlane *  GetResolutionPlane ()
CSLIKResolutionPlane *  CreateResolutionPlane ()
SI_Void  ConnectResolutionPlane (CSLIKResolutionPlane *in_pResPlane)
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 SI_IK_Joint template.

Describes one joint of an IK chain (see the SI_IK_Joint template reference).

Member Enumeration Documentation

enum EJointSolverType

Joint solver types.

Enumerator:
SI_DEFAULT  default joint type
SI_2D  2D joint
SI_3D  3D joint

Constructor & Destructor Documentation

CSLIKJoint ( CSLScene *  in_pScene,
CSLModel *  in_pModel,
CdotXSITemplate *  in_pTemplate,
CSLModel *  in_pRoot  
)

Constructor

Parameters:
[in]  in_pScene  Pointer to the scene containing the joint
[in]  in_pModel  Pointer to the model containing the joint
[in]  in_pTemplate  Pointer to the CdotXSITemplate containing the joint
[in]  in_pRoot  Pointer to the model that is the chain root of that joint
Returns:
an instance of CSLIKJoint

virtual ~CSLIKJoint (  )  [virtual]

Destructor

Member Function Documentation

SI_Float GetLength (  ) 

Returns the length value of the joint.

Returns:
Length value.

SI_Void SetLength ( SI_Float  in_fValue  ) 

Changes the length value of the joint.

Parameters:
[in]  in_fValue  New length value.

CSIBCVector3D GetPreferredRotation (  ) 

Returns the prefered rotation of the joint.

Returns:
Preferred rotation value.

SI_Void SetPreferredRotation ( CSIBCVector3D &  in_rValue  ) 

Changes the preferred rotation value of the joint.

Parameters:
[in]  in_rValue  New preferred rotation value.

SI_Bool GetPseudoRoot (  ) 

Returns a flag indicating if the joint is a pseudo-root.

Returns:
Pseudo-root status.

SI_Void SetPseudoRoot ( SI_Bool  in_bValue  ) 

Changes the flag indicating the joint is a pseudo-root.

Parameters:
[in]  in_bValue  New Pseudo-root status.

SI_Bool GetRotationLimitActivation (  ) 

Returns the rotation limit activation flag of the joint.

Returns:
Rrotation limit activation flag.

SI_Void SetRotationLimitActivation ( SI_Bool  in_bValue  ) 

Changes the rotation limit activation flag of the joint.

Parameters:
[in]  in_bValue  New rotation limit activation flag.

CSIBCVector3D GetRotationLimitMaximum (  ) 

Returns the maximum rotation limit of the joint.

Returns:
Maximum rotation limit.

SI_Void SetRotationLimitMaximum ( CSIBCVector3D &  in_rValue  ) 

Changes the maximum rotation limit value of the joint.

Parameters:
[in]  in_rValue  New maximum rotation limit.

CSIBCVector3D GetRotationLimitMinimum (  ) 

Returns the minimum rotation limit of the joint.

Returns:
Minimum rotation limit.

SI_Void SetRotationLimitMinimum ( CSIBCVector3D &  in_rValue  ) 

Changes the minimum rotation limit value of the joint.

Parameters:
[in]  in_rValue  New minimum rotation limit.

EJointSolverType GetSolverType (  ) 

Returns the solver type of the joint.

Returns:
Solver type.

SI_Void SetSolverType ( EJointSolverType  in_Type  ) 

Changes the solver type of the joint.

Parameters:
[in]  in_Type  New solver type.

SI_Float GetStiffness (  ) 

Returns the stiffness value of the joint.

Returns:
Stiffness value.

SI_Void SetStiffness ( SI_Float  in_fValue  ) 

Changes the stiffness value of the joint.

Parameters:
[in]  in_fValue  New stiffness value.

SI_Bool GetStiffnessActivation (  ) 

Returns the stiffness activation flag of the joint.

Returns:
Stiffness activation flag.

SI_Void SetStiffnessActivation ( SI_Bool  in_bValue  ) 

Changes the stiffness activation flag of the joint.

Parameters:
[in]  in_bValue  New stiffness activation flag.

CSLIKResolutionPlane* GetResolutionPlane (  ) 

Returns the resolution plane of this joint

Returns:
the resolution plane

CSLIKResolutionPlane* CreateResolutionPlane (  ) 

Creates the resolution plane of this joint

Returns:
the resolution plane

SI_Void ConnectResolutionPlane ( CSLIKResolutionPlane *  in_pResPlane  ) 

Connects and existing resolution plane to this joint

Parameters:
[in]  in_pResPlane  the resolution plane to connect to

virtual SI_Error Synchronize (  )  [virtual]

Synchronizes this IK joint 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

Return values:
CSLTemplate::SI_IK_JOINT  the template type of the joint

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

Reimplemented from CSLPrimitive.

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