FBX C++ API Reference
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FbxEffector Class Reference

#include <fbxcontrolset.h>

Class Description

An effector wraps a character node (FbxNode) used to animate its control rig (FbxControlSet) via inverse kinematics.

Definition at line 62 of file fbxcontrolset.h.

Public Types

enum  ESetId {
  eDefaultSet, eAux1Set, eAux2Set, eAux3Set,
  eAux4Set, eAux5Set, eAux6Set, eAux7Set,
  eAux8Set, eAux9Set, eAux10Set, eAux11Set,
  eAux12Set, eAux13Set, eAux14Set, eSetIdCount
}
 
enum  ENodeId {
  eHips, eLeftAnkle, eRightAnkle, eLeftWrist,
  eRightWrist, eLeftKnee, eRightKnee, eLeftElbow,
  eRightElbow, eChestOrigin, eChestEnd, eLeftFoot,
  eRightFoot, eLeftShoulder, eRightShoulder, eHead,
  eLeftHip, eRightHip, eLeftHand, eRightHand,
  eLeftHandThumb, eLeftHandIndex, eLeftHandMiddle, eLeftHandRing,
  eLeftHandPinky, eLeftHandExtraFinger, eRightHandThumb, eRightHandIndex,
  eRightHandMiddle, eRightHandRing, eRightHandPinky, eRightHandExtraFinger,
  eLeftFootThumb, eLeftFootIndex, eLeftFootMiddle, eLeftFootRing,
  eLeftFootPinky, eLeftFootExtraFinger, eRightFootThumb, eRightFootIndex,
  eRightFootMiddle, eRightFootRing, eRightFootPinky, eRightFootExtraFinger,
  eNodeIdCount, eNodeIdInvalid =-1
}
 

Public Member Functions

 FbxEffector ()
 Default constructor with uninitialized character node. More...
 
FbxEffectoroperator= (const FbxEffector &pEffector)
 Assignment operator. More...
 
void Reset ()
 Reset to default values. More...
 

Public Attributes

FbxNodemNode
 The character's node in a hierarchy linked to this effector. More...
 
bool mShow
 true if the effector is visible, false if hidden More...
 

Member Enumeration Documentation

◆ ESetId

enum ESetId
Enumerator
eDefaultSet 
eAux1Set 
eAux2Set 
eAux3Set 
eAux4Set 
eAux5Set 
eAux6Set 
eAux7Set 
eAux8Set 
eAux9Set 
eAux10Set 
eAux11Set 
eAux12Set 
eAux13Set 
eAux14Set 
eSetIdCount 

Definition at line 65 of file fbxcontrolset.h.

◆ ENodeId

enum ENodeId
Enumerator
eHips 
eLeftAnkle 
eRightAnkle 
eLeftWrist 
eRightWrist 
eLeftKnee 
eRightKnee 
eLeftElbow 
eRightElbow 
eChestOrigin 
eChestEnd 
eLeftFoot 
eRightFoot 
eLeftShoulder 
eRightShoulder 
eHead 
eLeftHip 
eRightHip 
eLeftHand 
eRightHand 
eLeftHandThumb 
eLeftHandIndex 
eLeftHandMiddle 
eLeftHandRing 
eLeftHandPinky 
eLeftHandExtraFinger 
eRightHandThumb 
eRightHandIndex 
eRightHandMiddle 
eRightHandRing 
eRightHandPinky 
eRightHandExtraFinger 
eLeftFootThumb 
eLeftFootIndex 
eLeftFootMiddle 
eLeftFootRing 
eLeftFootPinky 
eLeftFootExtraFinger 
eRightFootThumb 
eRightFootIndex 
eRightFootMiddle 
eRightFootRing 
eRightFootPinky 
eRightFootExtraFinger 
eNodeIdCount 
eNodeIdInvalid 

Definition at line 85 of file fbxcontrolset.h.

86  {
87  eHips,
88  eLeftAnkle,
90  eLeftWrist,
92  eLeftKnee,
93  eRightKnee,
94  eLeftElbow,
97  eChestEnd,
98  eLeftFoot,
99  eRightFoot,
102  eHead,
103  eLeftHip,
104  eRightHip,
105  eLeftHand,
106  eRightHand,
131  eNodeIdCount,
132  eNodeIdInvalid=-1
133  };

Constructor & Destructor Documentation

◆ FbxEffector()

Default constructor with uninitialized character node.

Member Function Documentation

◆ operator=()

FbxEffector& operator= ( const FbxEffector pEffector)

Assignment operator.

Parameters
pEffectorAnother FbxEffector assigned to this one.

◆ Reset()

void Reset ( )

Reset to default values.

  • mNode is set to NULL.
  • mShow is set to true.

Member Data Documentation

◆ mNode

FbxNode* mNode

The character's node in a hierarchy linked to this effector.

Definition at line 150 of file fbxcontrolset.h.

◆ mShow

bool mShow

true if the effector is visible, false if hidden

Definition at line 153 of file fbxcontrolset.h.


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