Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   Compound Members  

CSLIKEffector Class Reference

Describes the effector of an IK chain. More...

#include <IKEffector.h>

Inheritance diagram for CSLIKEffector::

CSLIK CSLPrimitive CSLTemplate CSIBCNode List of all members.

Public Methods


Detailed Description

Describes the effector of an IK chain.


Constructor & Destructor Documentation

CSLIKEffector::CSLIKEffector CSLScene   in_pScene,
CSLModel   in_pModel,
CdotXSITemplate   in_pTemplate,
CSLModel   pRoot
 

Constructor

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

CSLIKEffector::~CSLIKEffector   [virtual]
 

Destructor


Member Function Documentation

SI_Bool CSLIKEffector::GetRotationFlag  
 

Return the inherit rotation flag of the effector.

Returns:
SI_Bool Inherit rotation flag.

CSLAnimatableType * CSLIKEffector::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 CSLIKEffector::SetRotationFlag SI_Bool    in_bValue
 

Change the inherit rotation flag of the joint.

Parameters:
in_bValue  New inherit rotation flag.
Returns:
SI_Void

SI_Error CSLIKEffector::Synchronize   [virtual]
 

Synchronizes this IK effector instance with its IO layer representation

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

Reimplemented from CSLTemplate.

CSLTemplate::ETemplateType CSLIKEffector::Type   [virtual]
 

Get the template type

Returns:
ETemplateType the template type of the effector

Reimplemented from CSLTemplate.

SI_Bool CSLIKEffector::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.