KFbxConstraintSingleChainIK Class Reference

#include <kfbxconstraintsinglechainik.h>

Inheritance diagram for KFbxConstraintSingleChainIK:

[legend]

List of all members.

---

Detailed Description

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

Definition at line 57 of file kfbxconstraintsinglechainik.h.

Properties
KFbxTypedProperty< fbxEnum >	PoleVectorType
	This property handles pole vector type.
KFbxTypedProperty< fbxEnum >	SolverType
	This property handles solver type.
KFbxTypedProperty< fbxEnum >	EvaluateTSAnim
	This property handles evaluate TS animation.
KFbxTypedProperty< fbxReference >	PoleVectorObjects
	This property handles pole vector objects.
KFbxTypedProperty< fbxDouble3 >	PoleVector
	This property handles pole vector.
KFbxTypedProperty< fbxDouble1 >	Twist
	This property handles twist value.
KFbxTypedProperty< fbxReference >	FirstJointObject
	This property handles first joint object.
KFbxTypedProperty< fbxReference >	EndJointObject
	This property handles end joint object.
KFbxTypedProperty< fbxReference >	EffectorObject
	This property handles effector object.
Public Types
enum	ESolverType {    eRP_SOLVER,    eSC_SOLVER }
	Pole vector type. More...
enum	EPoleVectorType {    ePOLE_VECTOR_TYPE_VECTOR,    ePOLE_VECTOR_TYPE_OBJECT }
	Pole vector type. More...
enum	EEvalTS {    eEVAL_TS_NEVER,    eEVAL_TS_AUTO_DETECT,    eEVAL_TS_ALWAYS }
	If the constraints 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 () const
	Retrieve the constraint lock state.
void	SetPoleVectorType (EPoleVectorType pType)
	Set the Pole Vector type.
EPoleVectorType	GetPoleVectorType () const
	Retrieve the pole vector type.
void	SetSolverType (ESolverType pType)
	Set the Solver type.
ESolverType	GetSolverType () const
	Retrieve the solver type.
void	SetEvalTS (EEvalTS pEval)
	Sets the EvalTS.
EEvalTS	GetEvalTS () const
	Retrieve the EvalTS.
void	SetWeight (double pWeight)
	Set the weight of the constraint.
double	GetWeight () const
	Get the weight of the constraint.
double	GetPoleVectorObjectWeight (const KFbxObject *pObject) const
	Get the weight of a source.
void	AddPoleVectorObject (KFbxObject *pObject, double pWeight=100)
	Add a source to the constraint.
int	GetConstraintPoleVectorCount () const
	Retrieve the constraint source count.
KFbxObject *	GetPoleVectorObject (int pIndex) const
	Retrieve a constraint source object.
void	SetPoleVector (KFbxVector4 pVector)
	Set the pole vector.
KFbxVector4	GetPoleVector () const
	Retrieve the pole vector.
void	SetTwist (double pTwist)
	Set the twist value.
double	GetTwist () const
	Retrieve the twist value.
void	SetFirstJointObject (KFbxObject *pObject)
	Set the first joint object.
KFbxObject *	GetFirstJointObject () const
	Retrieve the first joint object.
void	SetEndJointObject (KFbxObject *pObject)
	Set the end joint object.
KFbxObject *	GetEndJointObject () const
	Retrieve the end joint object.
void	SetEffectorObject (KFbxObject *pObject)
	Set the effector object.
KFbxObject *	GetEffectorObject () const
	Retrieve the effector object.

---

Member Enumeration Documentation

enum ESolverType

Pole vector type.

• eRP_SOLVER
• eSC_SOLVER

Enumerator:

eRP_SOLVER
eSC_SOLVER

Definition at line 113 of file kfbxconstraintsinglechainik.h.

enum EPoleVectorType

Pole vector type.

• ePOLE_VECTOR_TYPE_VECTOR
• ePOLE_VECTOR_TYPE_OBJECT

Enumerator:

ePOLE_VECTOR_TYPE_VECTOR
ePOLE_VECTOR_TYPE_OBJECT

Definition at line 123 of file kfbxconstraintsinglechainik.h.

enum EEvalTS

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

• eEVALTS_NEVER
• eEVALTS_AUTODETECT = eEVALTS_ALWAYS

Enumerator:

eEVAL_TS_NEVER
eEVAL_TS_AUTO_DETECT
eEVAL_TS_ALWAYS

Definition at line 134 of file kfbxconstraintsinglechainik.h.

---

Member Function Documentation

void SetLock

(

bool

pLock

)

Set the constraint lock.

Parameters:

pLock

State of the lock flag.

bool GetLock

(

)

const

Retrieve the constraint lock state.

Returns:

Current lock flag.

void SetPoleVectorType

(

EPoleVectorType

pType

)

Set the Pole Vector type.

Parameters:

pType

New type for the pole vector.

EPoleVectorType GetPoleVectorType

(

)

const

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

(

)

const

Retrieve the solver type.

Returns:

Current solver type.

void SetEvalTS

(

EEvalTS

pEval

)

Sets the EvalTS.

Parameters:

pEval

New type of EvalTS

EEvalTS GetEvalTS

(

)

const

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

(

)

const

Get the weight of the constraint.

Returns:

The current weight value.

double GetPoleVectorObjectWeight

(

const KFbxObject *

pObject

)

const

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

(

)

const

Retrieve the constraint source count.

Returns:

Current constraint source count.

KFbxObject* GetPoleVectorObject

(

int

pIndex

)

const

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

(

)

const

Retrieve the pole vector.

Returns:

Current pole vector.

void SetTwist

(

double

pTwist

)

Set the twist value.

Parameters:

pTwist

New twist value.

double GetTwist

(

)

const

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

(

)

const

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

(

)

const

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

(

)

const

Retrieve the effector object.

Returns:

Current effector object.

---

Member Data Documentation

KFbxTypedProperty<fbxEnum> PoleVectorType

This property handles pole vector type.

Definition at line 68 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxEnum> SolverType

This property handles solver type.

Definition at line 72 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxEnum> EvaluateTSAnim

This property handles evaluate TS animation.

Definition at line 76 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxReference> PoleVectorObjects

This property handles pole vector objects.

Definition at line 82 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxDouble3> PoleVector

This property handles pole vector.

Default value is (0, 1, 0).

Definition at line 88 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxDouble1> Twist

This property handles twist value.

Default value is 0.

Definition at line 94 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxReference> FirstJointObject

This property handles first joint object.

Definition at line 98 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxReference> EndJointObject

This property handles end joint object.

Definition at line 102 of file kfbxconstraintsinglechainik.h.

KFbxTypedProperty<fbxReference> EffectorObject

This property handles effector object.

Definition at line 106 of file kfbxconstraintsinglechainik.h.