This reference page is linked to from the following overview topics: List of Python FBX classes.
This constraint class contains methods for accessing the properties of a single chain IK constraint.
Definition at line 57 of file kfbxconstraintsinglechainik.h.
#include <kfbxconstraintsinglechainik.h>
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. |
|
Protected Member Functions |
|
KFbxConstraintSingleChainIK (KFbxSdkManager &pManager, char const *pName) | |
virtual bool | ConstructProperties (bool pForceSet) |
virtual EConstraintType | GetConstraintType () const |
Access the type of the constraint. |
|
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.
|
enum ESolverType |
Pole vector type.
Definition at line 113 of file kfbxconstraintsinglechainik.h.
{ eRP_SOLVER, eSC_SOLVER } ESolverType;
enum EPoleVectorType |
Pole vector type.
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.
Definition at line 134 of file kfbxconstraintsinglechainik.h.
KFbxConstraintSingleChainIK | ( | KFbxSdkManager & | pManager, |
char const * | pName | ||
) | [protected] |
void SetLock | ( | bool | pLock | ) |
bool GetLock | ( | ) | const |
void SetPoleVectorType | ( | EPoleVectorType | pType | ) |
Set the Pole Vector type.
pType | New type for the pole vector. |
EPoleVectorType GetPoleVectorType | ( | ) | const |
void SetSolverType | ( | ESolverType | pType | ) |
ESolverType GetSolverType | ( | ) | const |
void SetEvalTS | ( | EEvalTS | pEval | ) |
EEvalTS GetEvalTS | ( | ) | const |
void SetWeight | ( | double | pWeight | ) |
double GetWeight | ( | ) | const |
double GetPoleVectorObjectWeight | ( | const KFbxObject * | pObject | ) | const |
Get the weight of a source.
pObject | Source object that we want the weight. |
void AddPoleVectorObject | ( | KFbxObject * | pObject, |
double | pWeight =
100 |
||
) |
Add a source to the constraint.
pObject | New source object. |
pWeight | Weight value of the source object expressed as a percentage. |
int GetConstraintPoleVectorCount | ( | ) | const |
Retrieve the constraint source count.
KFbxObject* GetPoleVectorObject | ( | int | pIndex | ) | const |
Retrieve a constraint source object.
pIndex | Index of constraint source object. |
void SetPoleVector | ( | KFbxVector4 | pVector | ) |
KFbxVector4 GetPoleVector | ( | ) | const |
void SetTwist | ( | double | pTwist | ) |
double GetTwist | ( | ) | const |
void SetFirstJointObject | ( | KFbxObject * | pObject | ) |
KFbxObject* GetFirstJointObject | ( | ) | const |
void SetEndJointObject | ( | KFbxObject * | pObject | ) |
KFbxObject* GetEndJointObject | ( | ) | const |
void SetEffectorObject | ( | KFbxObject * | pObject | ) |
KFbxObject* GetEffectorObject | ( | ) | const |
virtual bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented from KFbxConstraint.
virtual EConstraintType GetConstraintType | ( | ) | const [protected, virtual] |
Access the type of the constraint.
Reimplemented from KFbxConstraint.
This property handles pole vector type.
Definition at line 68 of file kfbxconstraintsinglechainik.h.
This property handles solver type.
Definition at line 72 of file kfbxconstraintsinglechainik.h.
This property handles evaluate TS animation.
Definition at line 76 of file kfbxconstraintsinglechainik.h.
This property handles pole vector objects.
Definition at line 82 of file kfbxconstraintsinglechainik.h.
This property handles pole vector.
Default value is (0, 1, 0).
Definition at line 88 of file kfbxconstraintsinglechainik.h.
This property handles twist value.
Default value is 0.
Definition at line 94 of file kfbxconstraintsinglechainik.h.
This property handles first joint object.
Definition at line 98 of file kfbxconstraintsinglechainik.h.
This property handles end joint object.
Definition at line 102 of file kfbxconstraintsinglechainik.h.
This property handles effector object.
Definition at line 106 of file kfbxconstraintsinglechainik.h.