Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLIKJoint Class Reference

Describes one joint of an IK chain. More...

#include <IKJoint.h>

Inheritance diagram for CSLIKJoint::

CSLIK CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Types

Public Methods


Detailed Description

Describes one joint of an IK chain.


Member Enumeration Documentation

enum CSLIKJoint::EJointSolverType
 

Joint solver types.

Enumeration values:
SI_DEFAULT  default joint type.
SI_2D  2D joint.
SI_3D  3D joint.


Constructor & Destructor Documentation

CSLIKJoint::CSLIKJoint CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate,
CSLModel   in_pRoot
 

Constructor

Parameters:
in_pScene  Pointer to the scene containing the joint
in_pModel  Pointer to the model containing the joint
in_pTemplate  Pointer to the CdotXSITemplate containing the joint
Returns:
an instance of CSLIKJoint

CSLIKJoint::~CSLIKJoint   [virtual]
 

Destructor


Member Function Documentation

SI_Float CSLIKJoint::GetLength  
 

Return the length value of the joint.

Returns:
SI_Float Length value.

CSIBCVector3D CSLIKJoint::GetPreferredRotation  
 

Return the prefered rotation of the joint.

Returns:
CSIBCVector3D Preferred rotation value.

SI_Bool CSLIKJoint::GetPseudoRoot  
 

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

Returns:
SI_Bool Pseudo-root status.

SI_Bool CSLIKJoint::GetRotationLimitActivation  
 

Return the rotation limit activation flag of the joint.

Returns:
SI_Bool Rrotation limit activation flag.

CSIBCVector3D CSLIKJoint::GetRotationLimitMaximum  
 

Return the maximum rotation limit of the joint.

Returns:
CSIBCVector3D Maximum rotation limit.

CSIBCVector3D CSLIKJoint::GetRotationLimitMinimum  
 

Return the minimum rotation limit of the joint.

Returns:
CSIBCVector3D Minimum rotation limit.

CSLIKJoint::EJointSolverType CSLIKJoint::GetSolverType  
 

Return the solver type of the joint.

Returns:
EJointSolverType Solver type.

SI_Float CSLIKJoint::GetStiffness  
 

Return the stiffness value of the joint.

Returns:
SI_Float Stiffness value.

SI_Bool CSLIKJoint::GetStiffnessActivation  
 

Return the stiffness activation flag of the joint.

Returns:
SI_Bool Stiffness activation flag.

CSLAnimatableType * CSLIKJoint::ParameterFromName SI_Char *    in_szName [virtual]
 

Gets a handle on one of this light's parameters by using its name

Parameters:
in_szName  the name of the parameter to get the handle from
Returns:
CSLAnimatableType* the handle to the parameter

Reimplemented from CSLTemplate.

SI_Void CSLIKJoint::SetLength SI_Float    in_fValue
 

Change the length value of the joint.

Parameters:
in_fValue  New length value.
Returns:
SI_Void

SI_Void CSLIKJoint::SetPreferredRotation CSIBCVector3D   in_rValue
 

Change the preffered rotation value of the joint.

Parameters:
in_rValue  New preferred rotation value.
Returns:
SI_Void

SI_Void CSLIKJoint::SetPseudoRoot SI_Bool    in_bValue
 

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

Parameters:
in_bValue  New Pseudo-root status.
Returns:
SI_Void

SI_Void CSLIKJoint::SetRotationLimitActivation SI_Bool    in_bValue
 

Change the rotation limit activation flag of the joint.

Parameters:
in_bValue  New rotation limit activation flag.
Returns:
SI_Void

SI_Void CSLIKJoint::SetRotationLimitMaximum CSIBCVector3D   in_rValue
 

Change the maximum rotation limit value of the joint.

Parameters:
in_rValue  New maximum rotation limit.
Returns:
SI_Void

SI_Void CSLIKJoint::SetRotationLimitMinimum CSIBCVector3D   in_rValue
 

Change the minimum rotation limit value of the joint.

Parameters:
in_rValue  New minimum rotation limit.
Returns:
SI_Void

SI_Void CSLIKJoint::SetSolverType EJointSolverType    in_Type
 

Change the solver type of the joint.

Parameters:
in_Type  New solver type.
Returns:
SI_Void

SI_Void CSLIKJoint::SetStiffness SI_Float    in_fValue
 

Change the stiffness value of the joint.

Parameters:
in_fValue  New stiffness value.
Returns:
SI_Void

SI_Void CSLIKJoint::SetStiffnessActivation SI_Bool    in_bValue
 

Change the stiffness activation flag of the joint.

Parameters:
in_bValue  New stiffness activation flag.
Returns:
SI_Void

SI_Error CSLIKJoint::Synchronize   [virtual]
 

Synchronizes this IK joint instance with its IO layer representation

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

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType CSLIKJoint::Type   [virtual]
 

Get the template type

Returns:
ETemplateType the template type of the joint

Reimplemented from CSLTemplate.

SI_Bool CSLIKJoint::ValidateParent CSLModel   in_pNewParent [virtual]
 

Validate that the parent is of valid type

Parameters:
in_pNewParent  the parent to validate against
Returns:
SI_Bool whether the parent is valid or not

Reimplemented from CSLPrimitive.


The documentation for this class was generated from the following files: © Copyright 2001-2003 Avid Technology, Inc. All rights reserved.

© Copyright 2001-2003 Avid Technology, Inc. All rights reserved.