Public Types | Public Member Functions | Public Attributes

FbxEffector Class Reference

This reference page is linked to from the following overview topics: List of Python Fbx classes.


Search for all occurrences

Detailed Description

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

Definition at line 66 of file fbxcontrolset.h.

#include <fbxcontrolset.h>

List of all members.

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
}

Public Member Functions

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

Public Attributes

FbxNode mNode
  The character's node in a hierarchy linked to this effector.
bool  mShow
  true if the effector is visible, false if hidden
bool  mTActive
bool  mRActive
bool  mCandidateTActive
bool  mCandidateRActive

Member Enumeration Documentation

enum ESetId
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 

Definition at line 89 of file fbxcontrolset.h.


Constructor & Destructor Documentation

Default constructor with uninitialized character node.


Member Function Documentation

FbxEffector& operator= ( const FbxEffector pEffector )

Assignment operator.

Parameters:
pEffector Another FbxEffector assigned to this one.
void Reset ( )

Reset to default values.

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

Member Data Documentation

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

Definition at line 153 of file fbxcontrolset.h.

bool mShow

true if the effector is visible, false if hidden

Definition at line 156 of file fbxcontrolset.h.

bool mTActive

Definition at line 169 of file fbxcontrolset.h.

bool mRActive

Definition at line 170 of file fbxcontrolset.h.

Definition at line 171 of file fbxcontrolset.h.

Definition at line 172 of file fbxcontrolset.h.


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

FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector
FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector FbxEffector