KFbxConstraintSingleChainIK Class Reference

#include <kfbxconstraintsinglechainik.h>

Inherits KFbxConstraint.

Inheritance diagram for KFbxConstraintSingleChainIK:

Inheritance graph
List of all members.

Detailed Description

This constraint class contains methods for accessing the properties of a single chain IK constraint.

Definition at line 64 of file kfbxconstraintsinglechainik.h.

Public Types

enum  ESolverType
 Pole vector type. More...
enum  EPoleVectorType
 Pole vector type. More...
enum  EEvalTS
 If the constaints read its animation on Translation and Scale for the nodes it constraints. More...

Public Member Functions

void SetLock (bool pLock)
 Set the constraint lock.
bool GetLock ()
 Retrieve the constraint lock state.
void SetActive (bool pActive)
 Set the constraint active.
bool GetActive ()
 Retrieve the constraint active state.
void SetPoleVectorType (EPoleVectorType pType)
 Set the Pole Vector type.
EPoleVectorType GetPoleVectorType ()
 Retrieve the pole vector type.
void SetSolverType (ESolverType pType)
 Set the Solver type.
ESolverType GetSolverType ()
 Retrieve the solver type.
void SetEvalTS (EEvalTS pEval)
 Sets the EvalTS.
EEvalTS GetEvalTS ()
 Retrieve the EvalTS.
void SetWeight (double pWeight)
 Set the weight of the constraint.
double GetWeight ()
 Get the weight of the constraint.
double GetPoleVectorObjectWeight (KFbxObject *pObject)
 Get the weight of a source.
void AddPoleVectorObject (KFbxObject *pObject, double pWeight=100)
 Add a source to the constraint.
int GetConstraintPoleVectorCount ()
 Retrieve the constraint source count.
KFbxObject * GetPoleVectorObject (int pIndex)
 Retrieve a constraint source object.
void SetPoleVector (KFbxVector4 pVector)
 Set the pole vector.
KFbxVector4 GetPoleVector ()
 Retrieve the pole vector.
void SetTwist (double pTwist)
 Set the twist value.
double GetTwist ()
 Retrieve the twist value.
void SetFirstJointObject (KFbxObject *pObject)
 Set the first joint object.
KFbxObject * GetFirstJointObject ()
 Retrieve the first joint object.
void SetEndJointObject (KFbxObject *pObject)
 Set the end joint object.
KFbxObject * GetEndJointObject ()
 Retrieve the end joint object.
void SetEffectorObject (KFbxObject *pObject)
 Set the effector object.
KFbxObject * GetEffectorObject ()
 Retrieve the effector object.

Member Enumeration Documentation

enum ESolverType

Pole vector type.

  • eRP_SOLVER
  • eSC_SOLVER

Definition at line 95 of file kfbxconstraintsinglechainik.h.

enum EPoleVectorType

Pole vector type.

  • ePOLE_VECTOR_TYPE_VECTOR
  • ePOLE_VECTOR_TYPE_OBJECT

Definition at line 105 of file kfbxconstraintsinglechainik.h.

enum EEvalTS

If the constaints read its animation on Translation and Scale for the nodes it constraints.

  • eEVALTS_NEVER
  • eEVALTS_AUTODETECT = eEVALTS_ALWAYS

Definition at line 116 of file kfbxconstraintsinglechainik.h.

Member Function Documentation

void SetLock ( bool  pLock  ) 

Set the constraint lock.

Parameters:
pLock State of the lock flag.

bool GetLock (  ) 

Retrieve the constraint lock state.

Returns:
Current lock flag.

void SetActive ( bool  pActive  ) 

Set the constraint active.

Parameters:
pLock State of the active flag.

bool GetActive (  ) 

Retrieve the constraint active state.

Returns:
Current active flag.

void SetPoleVectorType ( EPoleVectorType  pType  ) 

Set the Pole Vector type.

Parameters:
pType New type for the pole vector.

EPoleVectorType GetPoleVectorType (  ) 

Retrieve the pole vector type.

Returns:
Current pole vector type.

void SetSolverType ( ESolverType  pType  ) 

Set the Solver type.

Parameters:
pType New type for the solver.

ESolverType GetSolverType (  ) 

Retrieve the solver type.

Returns:
Current solver type.

void SetEvalTS ( EEvalTS  pEval  ) 

Sets the EvalTS.

Parameters:
pEval New type of EvalTS

EEvalTS GetEvalTS (  ) 

Retrieve the EvalTS.

Returns:
The current EvalTS type

void SetWeight ( double  pWeight  ) 

Set the weight of the constraint.

Parameters:
pWeight New weight value.

double GetWeight (  ) 

Get the weight of the constraint.

Returns:
The current weight value.

double GetPoleVectorObjectWeight ( KFbxObject *  pObject  ) 

Get the weight of a source.

Parameters:
pObject Source object that we want the weight.

void AddPoleVectorObject ( KFbxObject *  pObject,
double  pWeight = 100 
)

Add a source to the constraint.

Parameters:
pObject New source object.
pWeight Weight value of the source object expressed as a percentage.
Remarks:
pWeight value is 100 percent by default.

int GetConstraintPoleVectorCount (  ) 

Retrieve the constraint source count.

Returns:
Current constraint source count.

KFbxObject* GetPoleVectorObject ( int  pIndex  ) 

Retrieve a constraint source object.

Parameters:
pIndex Index of constraint source object.
Returns:
Current source at the specified index.

void SetPoleVector ( KFbxVector4  pVector  ) 

Set the pole vector.

Parameters:
pVector New pole vector.

KFbxVector4 GetPoleVector (  ) 

Retrieve the pole vector.

Returns:
Current pole vector.

void SetTwist ( double  pTwist  ) 

Set the twist value.

Parameters:
New twist value.

double GetTwist (  ) 

Retrieve the twist value.

Returns:
Current twist value.

void SetFirstJointObject ( KFbxObject *  pObject  ) 

Set the first joint object.

Parameters:
pObject The first joint object.

KFbxObject* GetFirstJointObject (  ) 

Retrieve the first joint object.

Returns:
Current first joint object.

void SetEndJointObject ( KFbxObject *  pObject  ) 

Set the end joint object.

Parameters:
pObject The end joint object.

KFbxObject* GetEndJointObject (  ) 

Retrieve the end joint object.

Returns:
Current end joint object.

void SetEffectorObject ( KFbxObject *  pObject  ) 

Set the effector object.

Parameters:
pObject The effector object.

KFbxObject* GetEffectorObject (  ) 

Retrieve the effector object.

Returns:
Current effector object.