FBX C++ API Reference
FbxControlSet Class Reference

#include <fbxcontrolset.h>

Class Description

This class contains all methods to either set-up an exported control rig or query information on an imported control rig.

A Control rig is a character manipulation tool that lets you change the position and orientation of a character to create or alter animation.

This class also contains some methods to manipulate the FbxEffector and FbxControlSetLink.

The FbxControlSet class contains FK rig (Forward Kinematics) and IK rig (Inverse Kinematics) animation. The FK rig is represented by a list of nodes while the IK rig is represented by a list of effectors.

You can access the FK rig with the FbxControlSetLink class, using the functions FbxControlSet::SetControlSetLink() and FbxControlSet::GetControlSetLink().

You can access the IK rig with the FbxEffector class, using the functions FbxControlSet::SetEffector() and FbxControlSet::GetEffector().

See also
FbxEffector, FbxControlSetLink

Definition at line 185 of file fbxcontrolset.h.

Public Types

enum  EType { eNone, eFkIk, eIkOnly }
 Control rig type. More...
 

Public Member Functions

void Reset ()
 Reset to default values. More...
 
void SetType (EType pType)
 Set type as given. More...
 
EType GetType () const
 Get type. More...
 
void SetUseAxis (bool pUseAxis)
 Set use axis flag as given. More...
 
bool GetUseAxis () const
 Get use axis flag. More...
 
void SetLockTransform (bool pLockTransform)
 Set lock transform flag as given. More...
 
bool GetLockTransform () const
 Get lock transform flag. More...
 
void SetLock3DPick (bool pLock3DPick)
 Set lock 3D pick flag as given. More...
 
bool GetLock3DPick () const
 Get lock 3D pick flag. More...
 
bool SetControlSetLink (FbxCharacter::ENodeId pCharacterNodeId, const FbxControlSetLink &pControlSetLink)
 Set a control set link for a character node ID. More...
 
bool GetControlSetLink (FbxCharacter::ENodeId pCharacterNodeId, FbxControlSetLink *pControlSetLink=((void *) 0)) const
 Get the control set link associated with a character node ID. More...
 
bool SetEffector (FbxEffector::ENodeId pEffectorNodeId, FbxEffector pEffector)
 Set an effector node for an effector node ID. More...
 
bool GetEffector (FbxEffector::ENodeId pEffectorNodeId, FbxEffector *pEffector=((void *) 0))
 Get the effector associated with an effector node ID. More...
 
bool SetEffectorAux (FbxEffector::ENodeId pEffectorNodeId, FbxNode *pNode, FbxEffector::ESetId pEffectorSetId=FbxEffector::eAux1Set)
 Set an auxiliary effector node for an effector node ID. More...
 
bool GetEffectorAux (FbxEffector::ENodeId pEffectorNodeId, FbxNode **pNode=((void *) 0), FbxEffector::ESetId pEffectorSetId=FbxEffector::eAux1Set) const
 Get the auxiliary effector associated with an effector node ID. More...
 

Static Public Member Functions

static char * GetEffectorNodeName (FbxEffector::ENodeId pEffectorNodeId)
 Get the name associated with an effector node ID. More...
 
static FbxEffector::ENodeId GetEffectorNodeId (char *pEffectorNodeName)
 Get ID associated with an effector node name. More...
 

Member Enumeration Documentation

◆ EType

enum EType

Control rig type.

  • eNone No Control rig.
  • eFkIk Both an FK rig and IK rig.
  • eIkOnly Only an IK rig.
Enumerator
eNone 
eFkIk 
eIkOnly 

Definition at line 198 of file fbxcontrolset.h.

Member Function Documentation

◆ Reset()

void Reset ( )

Reset to default values.

Reset all effector and control set links.

◆ SetType()

void SetType ( EType  pType)

Set type as given.

Parameters
pTypeThe given type.

◆ GetType()

EType GetType ( ) const

Get type.

Returns
The gotten type.

◆ SetUseAxis()

void SetUseAxis ( bool  pUseAxis)

Set use axis flag as given.

Parameters
pUseAxisThe given use axis flag.

◆ GetUseAxis()

bool GetUseAxis ( ) const

Get use axis flag.

Returns
The gotten use axis flag.

◆ SetLockTransform()

void SetLockTransform ( bool  pLockTransform)

Set lock transform flag as given.

Parameters
pLockTransformThe given lock transform flag.

◆ GetLockTransform()

bool GetLockTransform ( ) const

Get lock transform flag.

Returns
The gotten lock transform flag.

◆ SetLock3DPick()

void SetLock3DPick ( bool  pLock3DPick)

Set lock 3D pick flag as given.

Parameters
pLock3DPickThe given lock 3D pick flag.

◆ GetLock3DPick()

bool GetLock3DPick ( ) const

Get lock 3D pick flag.

Returns
The gotten lock 3D pick flag.

◆ SetControlSetLink()

bool SetControlSetLink ( FbxCharacter::ENodeId  pCharacterNodeId,
const FbxControlSetLink pControlSetLink 
)

Set a control set link for a character node ID.

Parameters
pCharacterNodeIdCharacter node ID.
pControlSetLinkControl set link to be associated with the Character node ID.
Returns
true if successful, false otherwise.
Remarks
You should avoid setting a control set link for eCharacterLeftFloor, eCharacterRightFloor, eCharacterLeftHandFloor, eCharacterRightHandFloor, eCharacterProps0, eCharacterProps1, eCharacterProps2, eCharacterProps3 or eCharacterProps4. None of these nodes are part of a control set.

◆ GetControlSetLink()

bool GetControlSetLink ( FbxCharacter::ENodeId  pCharacterNodeId,
FbxControlSetLink pControlSetLink = ((void *) 0) 
) const

Get the control set link associated with a character node ID.

Parameters
pCharacterNodeIdRequested character node ID.
pControlSetLinkOptional pointer that returns the control set link if the function succeeds.
Returns
true if successful, false otherwise.
Remarks
You should avoid getting a control set link for eCharacterLeftFloor, eCharacterRightFloor, eCharacterLeftHandFloor, eCharacterRightHandFloor, eCharacterProps0, eCharacterProps1, eCharacterProps2, eCharacterProps3 or eCharacterProps4. None of these nodes are part of a control set.

◆ SetEffector()

bool SetEffector ( FbxEffector::ENodeId  pEffectorNodeId,
FbxEffector  pEffector 
)

Set an effector node for an effector node ID.

Parameters
pEffectorNodeIdEffector node ID.
pEffectorEffector to be associated with the effector node ID.
Returns
true if successful, false otherwise.

◆ GetEffector()

bool GetEffector ( FbxEffector::ENodeId  pEffectorNodeId,
FbxEffector pEffector = ((void *) 0) 
)

Get the effector associated with an effector node ID.

Parameters
pEffectorNodeIdID of requested effector node.
pEffectorOptional pointer that returns the effector if the function succeeds.
Returns
true if successful, false otherwise.

◆ SetEffectorAux()

bool SetEffectorAux ( FbxEffector::ENodeId  pEffectorNodeId,
FbxNode pNode,
FbxEffector::ESetId  pEffectorSetId = FbxEffector::eAux1Set 
)

Set an auxiliary effector node for an effector node ID.

Parameters
pEffectorNodeIdEffector node ID.
pNodeAuxiliary effector node to be associated with the effector node ID.
pEffectorSetIdEffector set ID. Set to FbxEffector::eAux1Set by default.
Returns
true if successful, false otherwise.

◆ GetEffectorAux()

bool GetEffectorAux ( FbxEffector::ENodeId  pEffectorNodeId,
FbxNode **  pNode = ((void *) 0),
FbxEffector::ESetId  pEffectorSetId = FbxEffector::eAux1Set 
) const

Get the auxiliary effector associated with an effector node ID.

Parameters
pEffectorNodeIdID of requested auxiliary effector node.
pNodeOptional pointer that returns the auxiliary effector node if the function succeeds.
pEffectorSetIdEffector set ID. Set to FbxEffector::eAux1Set by default.
Returns
true if successful, false otherwise.

◆ GetEffectorNodeName()

static char* GetEffectorNodeName ( FbxEffector::ENodeId  pEffectorNodeId)
static

Get the name associated with an effector node ID.

Parameters
pEffectorNodeIdEffector node ID.
Returns
Name associated with the effector node ID.

◆ GetEffectorNodeId()

static FbxEffector::ENodeId GetEffectorNodeId ( char *  pEffectorNodeName)
static

Get ID associated with an effector node name.

Parameters
pEffectorNodeNameEffector node name.
Returns
Effector node ID associated with the given effector node name, or FbxEffector::eNodeIdInvalid (-1) if no effector node with pEffectorNodeName exists.

The documentation for this class was generated from the following file: