fbcharacter.h File Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, Optical devices.


Contains definitions for actors, characters, and marker sets In Development. More...

#include <kaydaradef.h>
#include <fbsdk/fbconstraint.h>
#include <fbsdk/fbcharacterextension.h>

Go to the source code of this file.

Classes

class  FBMarkerSet
 Marker set class. More...
class  FBControlSet
 Control set class. More...
class  FBControlSetState
class  FBEffectorSetState
class  FBCharacterMarkerSet
 Character marker set class. More...
class  FBSkeletonState
class  FBActor
 FBActor is used to link motion data to a character. More...
class  FBCharacter
 A character is the link between a motion source and a character model. More...
class  FBPropertyListMarkerSet
 PropertyList: MarkerSet. More...
class  FBPropertyListCharacterMarkerSet
 PropertyList: CharacterMarkerSet. More...
class  FBPropertyListControlSet
 PropertyList: MarkerSet. More...
class  FBPropertyListActor
 PropertyList: Actor. More...
class  FBPropertyListCharacter
 PropertyList: Character. More...

Defines

#define FBSDK_DLL   K_DLLIMPORT
 Be sure that FBSDK_DLL is defined only once...

Typedefs

typedef class FBSDK_DLL
FBArrayTemplate< FBModel * > 
FBModelList
 typedef class FBSDK_DLL FBArrayTemplate<FBModel*> FBModelList;

Enumerations

enum  FBSkeletonNodeId {
  kFBSkeletonInvalidIndex = -1, kFBSkeletonHipsIndex = 0, kFBSkeletonLeftHipIndex, kFBSkeletonLeftKneeIndex,
  kFBSkeletonLeftAnkleIndex, kFBSkeletonLeftFootIndex, kFBSkeletonRightHipIndex, kFBSkeletonRightKneeIndex,
  kFBSkeletonRightAnkleIndex, kFBSkeletonRightFootIndex, kFBSkeletonWaistIndex, kFBSkeletonChestIndex,
  kFBSkeletonLeftCollarIndex, kFBSkeletonLeftShoulderIndex, kFBSkeletonLeftElbowIndex, kFBSkeletonLeftWristIndex,
  kFBSkeletonRightCollarIndex, kFBSkeletonRightShoulderIndex, kFBSkeletonRightElbowIndex, kFBSkeletonRightWristIndex,
  kFBSkeletonNeckIndex, kFBSkeletonHeadIndex, kFBSkeletonLeftThumbAIndex, kFBSkeletonLeftThumbBIndex,
  kFBSkeletonLeftThumbCIndex, kFBSkeletonLeftIndexAIndex, kFBSkeletonLeftIndexBIndex, kFBSkeletonLeftIndexCIndex,
  kFBSkeletonLeftMiddleAIndex, kFBSkeletonLeftMiddleBIndex, kFBSkeletonLeftMiddleCIndex, kFBSkeletonLeftRingAIndex,
  kFBSkeletonLeftRingBIndex, kFBSkeletonLeftRingCIndex, kFBSkeletonLeftPinkyAIndex, kFBSkeletonLeftPinkyBIndex,
  kFBSkeletonLeftPinkyCIndex, kFBSkeletonRightThumbAIndex, kFBSkeletonRightThumbBIndex, kFBSkeletonRightThumbCIndex,
  kFBSkeletonRightIndexAIndex, kFBSkeletonRightIndexBIndex, kFBSkeletonRightIndexCIndex, kFBSkeletonRightMiddleAIndex,
  kFBSkeletonRightMiddleBIndex, kFBSkeletonRightMiddleCIndex, kFBSkeletonRightRingAIndex, kFBSkeletonRightRingBIndex,
  kFBSkeletonRightRingCIndex, kFBSkeletonRightPinkyAIndex, kFBSkeletonRightPinkyBIndex, kFBSkeletonRightPinkyCIndex,
  kFBSkeletonReferenceIndex, kFBSkeletonLastIndex
}
 

All Skeleton nodes.

More...
enum  FBBodyNodeId {
  kFBInvalidNodeId = -1, kFBHipsNodeId = 0, kFBLeftHipNodeId, kFBLeftKneeNodeId,
  kFBLeftAnkleNodeId, kFBLeftFootNodeId, kFBRightHipNodeId, kFBRightKneeNodeId,
  kFBRightAnkleNodeId, kFBRightFootNodeId, kFBWaistNodeId, kFBChestNodeId,
  kFBLeftCollarNodeId, kFBLeftShoulderNodeId, kFBLeftElbowNodeId, kFBLeftWristNodeId,
  kFBRightCollarNodeId, kFBRightShoulderNodeId, kFBRightElbowNodeId, kFBRightWristNodeId,
  kFBNeckNodeId, kFBHeadNodeId, kFBLeftHipRollNodeId, kFBLeftKneeRollNodeId,
  kFBRightHipRollNodeId, kFBRightKneeRollNodeId, kFBLeftShoulderRollNodeId, kFBLeftElbowRollNodeId,
  kFBRightShoulderRollNodeId, kFBRightElbowRollNodeId, kFBSpine2NodeId, kFBSpine3NodeId,
  kFBSpine4NodeId, kFBSpine5NodeId, kFBSpine6NodeId, kFBSpine7NodeId,
  kFBSpine8NodeId, kFBSpine9NodeId, kFBLeftThumbANodeId, kFBLeftThumbBNodeId,
  kFBLeftThumbCNodeId, kFBLeftIndexANodeId, kFBLeftIndexBNodeId, kFBLeftIndexCNodeId,
  kFBLeftMiddleANodeId, kFBLeftMiddleBNodeId, kFBLeftMiddleCNodeId, kFBLeftRingANodeId,
  kFBLeftRingBNodeId, kFBLeftRingCNodeId, kFBLeftPinkyANodeId, kFBLeftPinkyBNodeId,
  kFBLeftPinkyCNodeId, kFBRightThumbANodeId, kFBRightThumbBNodeId, kFBRightThumbCNodeId,
  kFBRightIndexANodeId, kFBRightIndexBNodeId, kFBRightIndexCNodeId, kFBRightMiddleANodeId,
  kFBRightMiddleBNodeId, kFBRightMiddleCNodeId, kFBRightRingANodeId, kFBRightRingBNodeId,
  kFBRightRingCNodeId, kFBRightPinkyANodeId, kFBRightPinkyBNodeId, kFBRightPinkyCNodeId,
  kFBReferenceNodeId, kFBLeftThumbInNodeId, kFBLeftThumbDNodeId, kFBLeftIndexInNodeId,
  kFBLeftIndexDNodeId, kFBLeftMiddleInNodeId, kFBLeftMiddleDNodeId, kFBLeftRingInNodeId,
  kFBLeftRingDNodeId, kFBLeftPinkyInNodeId, kFBLeftPinkyDNodeId, kFBRightThumbInNodeId,
  kFBRightThumbDNodeId, kFBRightIndexInNodeId, kFBRightIndexDNodeId, kFBRightMiddleInNodeId,
  kFBRightMiddleDNodeId, kFBRightRingInNodeId, kFBRightRingDNodeId, kFBRightPinkyInNodeId,
  kFBRightPinkyDNodeId, kFBLeftExtraFingerInNodeId, kFBLeftExtraFingerANodeId, kFBLeftExtraFingerBNodeId,
  kFBLeftExtraFingerCNodeId, kFBLeftExtraFingerDNodeId, kFBRightExtraFingerInNodeId, kFBRightExtraFingerANodeId,
  kFBRightExtraFingerBNodeId, kFBRightExtraFingerCNodeId, kFBRightExtraFingerDNodeId, kFBLeftFootThumbInNodeId,
  kFBLeftFootThumbANodeId, kFBLeftFootThumbBNodeId, kFBLeftFootThumbCNodeId, kFBLeftFootThumbDNodeId,
  kFBLeftFootIndexInNodeId, kFBLeftFootIndexANodeId, kFBLeftFootIndexBNodeId, kFBLeftFootIndexCNodeId,
  kFBLeftFootIndexDNodeId, kFBLeftFootMiddleInNodeId, kFBLeftFootMiddleANodeId, kFBLeftFootMiddleBNodeId,
  kFBLeftFootMiddleCNodeId, kFBLeftFootMiddleDNodeId, kFBLeftFootRingInNodeId, kFBLeftFootRingANodeId,
  kFBLeftFootRingBNodeId, kFBLeftFootRingCNodeId, kFBLeftFootRingDNodeId, kFBLeftFootPinkyInNodeId,
  kFBLeftFootPinkyANodeId, kFBLeftFootPinkyBNodeId, kFBLeftFootPinkyCNodeId, kFBLeftFootPinkyDNodeId,
  kFBRightFootThumbInNodeId, kFBRightFootThumbANodeId, kFBRightFootThumbBNodeId, kFBRightFootThumbCNodeId,
  kFBRightFootThumbDNodeId, kFBRightFootIndexInNodeId, kFBRightFootIndexANodeId, kFBRightFootIndexBNodeId,
  kFBRightFootIndexCNodeId, kFBRightFootIndexDNodeId, kFBRightFootMiddleInNodeId, kFBRightFootMiddleANodeId,
  kFBRightFootMiddleBNodeId, kFBRightFootMiddleCNodeId, kFBRightFootMiddleDNodeId, kFBRightFootRingInNodeId,
  kFBRightFootRingANodeId, kFBRightFootRingBNodeId, kFBRightFootRingCNodeId, kFBRightFootRingDNodeId,
  kFBRightFootPinkyInNodeId, kFBRightFootPinkyANodeId, kFBRightFootPinkyBNodeId, kFBRightFootPinkyCNodeId,
  kFBRightFootPinkyDNodeId, kFBLeftExtraFootFingerInNodeId, kFBLeftExtraFootFingerANodeId, kFBLeftExtraFootFingerBNodeId,
  kFBLeftExtraFootFingerCNodeId, kFBLeftExtraFootFingerDNodeId, kFBRightExtraFootFingerInNodeId, kFBRightExtraFootFingerANodeId,
  kFBRightExtraFootFingerBNodeId, kFBRightExtraFootFingerCNodeId, kFBRightExtraFootFingerDNodeId, kFBLeftHandNodeId,
  kFBRightHandNodeId, kFBNeck1NodeId, kFBNeck2NodeId, kFBNeck3NodeId,
  kFBNeck4NodeId, kFBNeck5NodeId, kFBNeck6NodeId, kFBNeck7NodeId,
  kFBNeck8NodeId, kFBNeck9NodeId, kFBHipsTranslationNodeId, kFBLastNodeId
}
 

All body nodes.

More...
enum  FBEffectorId {
  kFBInvalidEffectorId = -1, kFBHipsEffectorId = 0, kFBLeftAnkleEffectorId, kFBRightAnkleEffectorId,
  kFBLeftWristEffectorId, kFBRightWristEffectorId, kFBLeftKneeEffectorId, kFBRightKneeEffectorId,
  kFBLeftElbowEffectorId, kFBRightElbowEffectorId, kFBChestOriginEffectorId, kFBChestEndEffectorId,
  kFBLeftFootEffectorId, kFBRightFootEffectorId, kFBLeftShoulderEffectorId, kFBRightShoulderEffectorId,
  kFBHeadEffectorId, kFBLeftHipEffectorId, kFBRightHipEffectorId, kFBLeftHandEffectorId,
  kFBRightHandEffectorId, kFBLeftHandThumbEffectorId, kFBLeftHandIndexEffectorId, kFBLeftHandMiddleEffectorId,
  kFBLeftHandRingEffectorId, kFBLeftHandPinkyEffectorId, kFBLeftHandExtraFingerEffectorId, kFBRightHandThumbEffectorId,
  kFBRightHandIndexEffectorId, kFBRightHandMiddleEffectorId, kFBRightHandRingEffectorId, kFBRightHandPinkyEffectorId,
  kFBRightHandExtraFingerEffectorId, kFBLeftFootThumbEffectorId, kFBLeftFootIndexEffectorId, kFBLeftFootMiddleEffectorId,
  kFBLeftFootRingEffectorId, kFBLeftFootPinkyEffectorId, kFBLeftFootExtraFingerEffectorId, kFBRightFootThumbEffectorId,
  kFBRightFootIndexEffectorId, kFBRightFootMiddleEffectorId, kFBRightFootRingEffectorId, kFBRightFootPinkyEffectorId,
  kFBRightFootExtraFingerEffectorId, kFBLastEffectorId
}
 

All effector nodes.

More...
enum  FBEffectorSetID {
  FBEffectorSetDefault = 0, FBEffectorSetAux1, FBEffectorSetAux2, FBEffectorSetAux3,
  FBEffectorSetAux4, FBEffectorSetAux5, FBEffectorSetAux6, EFBffectorSetAux7,
  FBEffectorSetAux8, FBEffectorSetAux9, FBEffectorSetAux10, FBEffectorSetAux11,
  FBEffectorSetAux12, FBEffectorSetAux13, FBEffectorSetAux14, FBLastEffectorSetIndex
}
 

Effector ID identifier.

More...
enum  FBFloorContactID {
  FBLeftHandMemberIndex, FBRightHandMemberIndex, FBLeftFootMemberIndex, FBRightFootMemberIndex,
  FBLastCharacterMember
}
 

Floor contact for the given index.

More...
enum  FBBodyPartId {
  kFBCtrlSetPartNone = 0, kFBCtrlSetPartHips, kFBCtrlSetPartChest, kFBCtrlSetPartLeftArm,
  kFBCtrlSetPartRightArm, kFBCtrlSetPartLeftLeg, kFBCtrlSetPartRightLeg, kFBCtrlSetPartHead,
  kFBCtrlSetPartLeftHand, kFBCtrlSetPartRightHand, kFBCtrlSetPartLeftFoot, kFBCtrlSetPartRightFoot,
  kFBLastCtrlSetPartIndex
}
 

Body part for character.

More...
enum  FBCharacterInputType {
  kFBCharacterInputActor, kFBCharacterInputCharacter, kFBCharacterInputMarkerSet, kFBCharacterOutputMarkerSet,
  kFBCharacterInputStance, kFBCharacterInputMoCap
}
 

Character Input/Output types.

More...
enum  FBCharacterKeyingMode { kFBCharacterKeyingFullBody, kFBCharacterKeyingBodyPart, kFBCharacterKeyingSelection }
 

Character keying modes.

More...
enum  FBCharacterResetProperties { kFBCharacterResetPropertiesAll, kFBCharacterResetPropertiesSolving, kFBCharacterResetPropertiesDefinition }
 

Character Reset Properties Type.

More...
enum  FBCharacterPlotWhere { kFBCharacterPlotOnControlRig, kFBCharacterPlotOnSkeleton }
 

Where to plot a character.

More...
enum  FBCharacterHipsTranslationMode { kFBParamHipsTranslationWorldRigid = 0, kFBParamHipsTranslationBodyRigid, kFBLastHipsTranslationMode }
 

Character Hips Translation modes.

More...
enum  FBCharacterRollSolver { kFBParamRollSolver70 = 0, kFBParamRollSolver75, kFBLastRollSolver }
 

Character Roll Solver version.

More...
enum  FBCharacterContactBehaviour { kFBParamContactNeverSync = 0, kFBParamContactSyncOnKey, kFBParamContactAlwaysSync, kFBLastContactBehaviour }
 

Character Contact Behaviour.

More...
enum  FBControlSetType { kFBControlSetTypeNone = 0, kFBControlSetTypeFKIK, kFBControlSetTypeIKOnly }
 

Character ControlSet type.

More...
enum  FBRecalcMarkerSetOffset { kFBRecalcMarkerSetOffsetTR, kFBRecalcMarkerSetOffsetROnly }
 

Recalculate MarkerSet offset for?

More...

Functions

 FB_DEFINE_ENUM (FBSDK_DLL, CharacterInputType)
 FB_DEFINE_ENUM (FBSDK_DLL, CharacterKeyingMode)
 FB_DEFINE_ENUM (FBSDK_DLL, CharacterPlotWhere)
 FB_DEFINE_ENUM (FBSDK_DLL, CharacterHipsTranslationMode)
 FB_DEFINE_ENUM (FBSDK_DLL, CharacterRollSolver)
 FB_DEFINE_ENUM (FBSDK_DLL, CharacterContactBehaviour)
 FB_DEFINE_ENUM (FBSDK_DLL, ControlSetType)
FBSDK_DLL const char * FBCharacterBodyNodeNameFromId (FBBodyNodeId pBodyNodeId)
 Get the UI name associated with a body node.
FBSDK_DLL const char * FBCharacterEffectorNameFromId (FBEffectorId pEffectorId)
 Get the UI name associated with an effector.
 __FB_FORWARD (FBMarkerSet)
 FB_DEFINE_COMPONENT (FBSDK_DLL, MarkerSet)
 FB_FORWARD (FBModel)
 __FB_FORWARD (FBControlSet)
 FB_DEFINE_COMPONENT (FBSDK_DLL, ControlSet)
 __FB_FORWARD (FBControlSetState)
 Control Set State class.
 __FB_FORWARD (FBEffectorSetState)
 Effector Set State class.
 __FB_FORWARD (FBCharacterMarkerSet)
 FB_DEFINE_COMPONENT (FBSDK_DLL, CharacterMarkerSet)
 __FB_FORWARD (FBSkeletonState)
 Skeleton State class.
 __FB_FORWARD (FBActor)
 FB_DEFINE_COMPONENT (FBSDK_DLL, Actor)
 FB_FORWARD (FBPlotOptions)
 __FB_FORWARD (FBCharacter)
 FB_DEFINE_COMPONENT (FBSDK_DLL, Character)
 FB_FORWARD (FBPropertyListCharacter)
FBSDK_DLL FBCharacterKeyingMode FBGetCharactersKeyingMode ()
 return Character Manipulation/Keying Mode
FBSDK_DLL FBBodyPartId FBGetEffectorBodyPart (FBEffectorId pEffectorId)
 return BodyPart ID from Effector.
FBSDK_DLL FBBodyPartId FBGetBodyNodeBodyPart (FBBodyNodeId pBodyNodeId)
 return BodyPart ID from Bones.
FBSDK_DLL FBCharacterFBGetCharacterByAssociatedPart (FBComponent *pPart)
 Get character by its associated IK/FK Marker or Bone.
FBSDK_DLL bool FBGetCharacterFloorContactsVisibility ()
 Queries visibility of the floor contacts of the current character.
FBSDK_DLL void FBSetCharacterFloorContactsVisibility (bool pShow)
 Sets visibility of the floor contacts of the current character.
FBSDK_DLL bool FBGetCharacterFingerTipsVisibility ()
 Queries visibility of the finger-tips of the current character.
FBSDK_DLL void FBSetCharacterFingerTipsVisibility (bool pShow)
 Sets visibility of the finger-tips of the current character.

Variables

const int kFBLastActorNodeId = ( kFBHeadNodeId + 1 )
 Last Actor NodeId.

Detailed Description

Contains definitions for actors, characters, and marker sets In Development.

Warning:
These classes are under development and may change dramatically between versions.

Definition in file fbcharacter.h.


Define Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 51 of file fbcharacter.h.


Typedef Documentation

typedef class FBSDK_DLL FBArrayTemplate<FBModel*> FBModelList

typedef class FBSDK_DLL FBArrayTemplate<FBModel*> FBModelList;

Definition at line 506 of file fbcharacter.h.


Enumeration Type Documentation

All Skeleton nodes.

Enumerator:
kFBSkeletonInvalidIndex 
kFBSkeletonHipsIndex 
kFBSkeletonLeftHipIndex 
kFBSkeletonLeftKneeIndex 
kFBSkeletonLeftAnkleIndex 
kFBSkeletonLeftFootIndex 
kFBSkeletonRightHipIndex 
kFBSkeletonRightKneeIndex 
kFBSkeletonRightAnkleIndex 
kFBSkeletonRightFootIndex 
kFBSkeletonWaistIndex 
kFBSkeletonChestIndex 
kFBSkeletonLeftCollarIndex 
kFBSkeletonLeftShoulderIndex 
kFBSkeletonLeftElbowIndex 
kFBSkeletonLeftWristIndex 
kFBSkeletonRightCollarIndex 
kFBSkeletonRightShoulderIndex 
kFBSkeletonRightElbowIndex 
kFBSkeletonRightWristIndex 
kFBSkeletonNeckIndex 
kFBSkeletonHeadIndex 
kFBSkeletonLeftThumbAIndex 
kFBSkeletonLeftThumbBIndex 
kFBSkeletonLeftThumbCIndex 
kFBSkeletonLeftIndexAIndex 
kFBSkeletonLeftIndexBIndex 
kFBSkeletonLeftIndexCIndex 
kFBSkeletonLeftMiddleAIndex 
kFBSkeletonLeftMiddleBIndex 
kFBSkeletonLeftMiddleCIndex 
kFBSkeletonLeftRingAIndex 
kFBSkeletonLeftRingBIndex 
kFBSkeletonLeftRingCIndex 
kFBSkeletonLeftPinkyAIndex 
kFBSkeletonLeftPinkyBIndex 
kFBSkeletonLeftPinkyCIndex 
kFBSkeletonRightThumbAIndex 
kFBSkeletonRightThumbBIndex 
kFBSkeletonRightThumbCIndex 
kFBSkeletonRightIndexAIndex 
kFBSkeletonRightIndexBIndex 
kFBSkeletonRightIndexCIndex 
kFBSkeletonRightMiddleAIndex 
kFBSkeletonRightMiddleBIndex 
kFBSkeletonRightMiddleCIndex 
kFBSkeletonRightRingAIndex 
kFBSkeletonRightRingBIndex 
kFBSkeletonRightRingCIndex 
kFBSkeletonRightPinkyAIndex 
kFBSkeletonRightPinkyBIndex 
kFBSkeletonRightPinkyCIndex 
kFBSkeletonReferenceIndex 
kFBSkeletonLastIndex 

Definition at line 65 of file fbcharacter.h.

All body nodes.

Enumerator:
kFBInvalidNodeId 
kFBHipsNodeId 

Required.

kFBLeftHipNodeId 

Required.

kFBLeftKneeNodeId 

Required.

kFBLeftAnkleNodeId 

Required.

kFBLeftFootNodeId 
kFBRightHipNodeId 

Required.

kFBRightKneeNodeId 

Required.

kFBRightAnkleNodeId 

Required.

kFBRightFootNodeId 
kFBWaistNodeId 

Required, Spine 0.

kFBChestNodeId 

Spine 1.

kFBLeftCollarNodeId 
kFBLeftShoulderNodeId 

Required.

kFBLeftElbowNodeId 

Required.

kFBLeftWristNodeId 

Required.

kFBRightCollarNodeId 
kFBRightShoulderNodeId 

Required.

kFBRightElbowNodeId 

Required.

kFBRightWristNodeId 

Required.

kFBNeckNodeId 
kFBHeadNodeId 

Required.

kFBLeftHipRollNodeId 
kFBLeftKneeRollNodeId 
kFBRightHipRollNodeId 
kFBRightKneeRollNodeId 
kFBLeftShoulderRollNodeId 
kFBLeftElbowRollNodeId 
kFBRightShoulderRollNodeId 
kFBRightElbowRollNodeId 
kFBSpine2NodeId 
kFBSpine3NodeId 
kFBSpine4NodeId 
kFBSpine5NodeId 
kFBSpine6NodeId 
kFBSpine7NodeId 
kFBSpine8NodeId 
kFBSpine9NodeId 
kFBLeftThumbANodeId 
kFBLeftThumbBNodeId 
kFBLeftThumbCNodeId 
kFBLeftIndexANodeId 
kFBLeftIndexBNodeId 
kFBLeftIndexCNodeId 
kFBLeftMiddleANodeId 
kFBLeftMiddleBNodeId 
kFBLeftMiddleCNodeId 
kFBLeftRingANodeId 
kFBLeftRingBNodeId 
kFBLeftRingCNodeId 
kFBLeftPinkyANodeId 
kFBLeftPinkyBNodeId 
kFBLeftPinkyCNodeId 
kFBRightThumbANodeId 
kFBRightThumbBNodeId 
kFBRightThumbCNodeId 
kFBRightIndexANodeId 
kFBRightIndexBNodeId 
kFBRightIndexCNodeId 
kFBRightMiddleANodeId 
kFBRightMiddleBNodeId 
kFBRightMiddleCNodeId 
kFBRightRingANodeId 
kFBRightRingBNodeId 
kFBRightRingCNodeId 
kFBRightPinkyANodeId 
kFBRightPinkyBNodeId 
kFBRightPinkyCNodeId 
kFBReferenceNodeId 
kFBLeftThumbInNodeId 
kFBLeftThumbDNodeId 
kFBLeftIndexInNodeId 
kFBLeftIndexDNodeId 
kFBLeftMiddleInNodeId 
kFBLeftMiddleDNodeId 
kFBLeftRingInNodeId 
kFBLeftRingDNodeId 
kFBLeftPinkyInNodeId 
kFBLeftPinkyDNodeId 
kFBRightThumbInNodeId 
kFBRightThumbDNodeId 
kFBRightIndexInNodeId 
kFBRightIndexDNodeId 
kFBRightMiddleInNodeId 
kFBRightMiddleDNodeId 
kFBRightRingInNodeId 
kFBRightRingDNodeId 
kFBRightPinkyInNodeId 
kFBRightPinkyDNodeId 
kFBLeftExtraFingerInNodeId 

New extra finger bone.

kFBLeftExtraFingerANodeId 

New extra finger bone.

kFBLeftExtraFingerBNodeId 

New extra finger bone.

kFBLeftExtraFingerCNodeId 

New extra finger bone.

kFBLeftExtraFingerDNodeId 

New extra finger bone.

kFBRightExtraFingerInNodeId 

New extra finger bone.

kFBRightExtraFingerANodeId 

New extra finger bone.

kFBRightExtraFingerBNodeId 

New extra finger bone.

kFBRightExtraFingerCNodeId 

New extra finger bone.

kFBRightExtraFingerDNodeId 

New extra finger bone.

kFBLeftFootThumbInNodeId 
kFBLeftFootThumbANodeId 
kFBLeftFootThumbBNodeId 
kFBLeftFootThumbCNodeId 
kFBLeftFootThumbDNodeId 
kFBLeftFootIndexInNodeId 
kFBLeftFootIndexANodeId 
kFBLeftFootIndexBNodeId 
kFBLeftFootIndexCNodeId 
kFBLeftFootIndexDNodeId 
kFBLeftFootMiddleInNodeId 
kFBLeftFootMiddleANodeId 
kFBLeftFootMiddleBNodeId 
kFBLeftFootMiddleCNodeId 
kFBLeftFootMiddleDNodeId 
kFBLeftFootRingInNodeId 
kFBLeftFootRingANodeId 
kFBLeftFootRingBNodeId 
kFBLeftFootRingCNodeId 
kFBLeftFootRingDNodeId 
kFBLeftFootPinkyInNodeId 
kFBLeftFootPinkyANodeId 
kFBLeftFootPinkyBNodeId 
kFBLeftFootPinkyCNodeId 
kFBLeftFootPinkyDNodeId 
kFBRightFootThumbInNodeId 
kFBRightFootThumbANodeId 
kFBRightFootThumbBNodeId 
kFBRightFootThumbCNodeId 
kFBRightFootThumbDNodeId 
kFBRightFootIndexInNodeId 
kFBRightFootIndexANodeId 
kFBRightFootIndexBNodeId 
kFBRightFootIndexCNodeId 
kFBRightFootIndexDNodeId 
kFBRightFootMiddleInNodeId 
kFBRightFootMiddleANodeId 
kFBRightFootMiddleBNodeId 
kFBRightFootMiddleCNodeId 
kFBRightFootMiddleDNodeId 
kFBRightFootRingInNodeId 
kFBRightFootRingANodeId 
kFBRightFootRingBNodeId 
kFBRightFootRingCNodeId 
kFBRightFootRingDNodeId 
kFBRightFootPinkyInNodeId 
kFBRightFootPinkyANodeId 
kFBRightFootPinkyBNodeId 
kFBRightFootPinkyCNodeId 
kFBRightFootPinkyDNodeId 
kFBLeftExtraFootFingerInNodeId 

New extra finger bone.

kFBLeftExtraFootFingerANodeId 

New extra finger bone.

kFBLeftExtraFootFingerBNodeId 

New extra finger bone.

kFBLeftExtraFootFingerCNodeId 

New extra finger bone.

kFBLeftExtraFootFingerDNodeId 

New extra finger bone.

kFBRightExtraFootFingerInNodeId 

New extra finger bone.

kFBRightExtraFootFingerANodeId 

New extra finger bone.

kFBRightExtraFootFingerBNodeId 

New extra finger bone.

kFBRightExtraFootFingerCNodeId 

New extra finger bone.

kFBRightExtraFootFingerDNodeId 

New extra finger bone.

kFBLeftHandNodeId 
kFBRightHandNodeId 
kFBNeck1NodeId 
kFBNeck2NodeId 
kFBNeck3NodeId 
kFBNeck4NodeId 
kFBNeck5NodeId 
kFBNeck6NodeId 
kFBNeck7NodeId 
kFBNeck8NodeId 
kFBNeck9NodeId 
kFBHipsTranslationNodeId 
kFBLastNodeId 

Definition at line 124 of file fbcharacter.h.

{
    kFBInvalidNodeId = -1,
    kFBHipsNodeId = 0,             
    kFBLeftHipNodeId,              
    kFBLeftKneeNodeId,             
    kFBLeftAnkleNodeId,            
    kFBLeftFootNodeId,             
    kFBRightHipNodeId,             
    kFBRightKneeNodeId,            
    kFBRightAnkleNodeId,           
    kFBRightFootNodeId,            
    kFBWaistNodeId,             
    kFBChestNodeId,             
    kFBLeftCollarNodeId,           
    kFBLeftShoulderNodeId,         
    kFBLeftElbowNodeId,            
    kFBLeftWristNodeId,            
    kFBRightCollarNodeId,          
    kFBRightShoulderNodeId,        
    kFBRightElbowNodeId,           
    kFBRightWristNodeId,           
    kFBNeckNodeId,                 
    kFBHeadNodeId,                 
    kFBLeftHipRollNodeId,          
    kFBLeftKneeRollNodeId,         
    kFBRightHipRollNodeId,         
    kFBRightKneeRollNodeId,        
    kFBLeftShoulderRollNodeId,     
    kFBLeftElbowRollNodeId,        
    kFBRightShoulderRollNodeId,    
    kFBRightElbowRollNodeId,       
    kFBSpine2NodeId,               
    kFBSpine3NodeId,               
    kFBSpine4NodeId,               
    kFBSpine5NodeId,               
    kFBSpine6NodeId,               
    kFBSpine7NodeId,               
    kFBSpine8NodeId,               
    kFBSpine9NodeId,               
    kFBLeftThumbANodeId,           
    kFBLeftThumbBNodeId,           
    kFBLeftThumbCNodeId,           
    kFBLeftIndexANodeId,           
    kFBLeftIndexBNodeId,           
    kFBLeftIndexCNodeId,           
    kFBLeftMiddleANodeId,          
    kFBLeftMiddleBNodeId,          
    kFBLeftMiddleCNodeId,          
    kFBLeftRingANodeId,            
    kFBLeftRingBNodeId,            
    kFBLeftRingCNodeId,            
    kFBLeftPinkyANodeId,           
    kFBLeftPinkyBNodeId,           
    kFBLeftPinkyCNodeId,           
    kFBRightThumbANodeId,          
    kFBRightThumbBNodeId,          
    kFBRightThumbCNodeId,          
    kFBRightIndexANodeId,          
    kFBRightIndexBNodeId,          
    kFBRightIndexCNodeId,          
    kFBRightMiddleANodeId,         
    kFBRightMiddleBNodeId,         
    kFBRightMiddleCNodeId,         
    kFBRightRingANodeId,           
    kFBRightRingBNodeId,           
    kFBRightRingCNodeId,           
    kFBRightPinkyANodeId,          
    kFBRightPinkyBNodeId,          
    kFBRightPinkyCNodeId,          
    kFBReferenceNodeId,            
    // -- New bones for 2.0 --
    kFBLeftThumbInNodeId,          
    kFBLeftThumbDNodeId,           
    kFBLeftIndexInNodeId,          
    kFBLeftIndexDNodeId,           
    kFBLeftMiddleInNodeId,         
    kFBLeftMiddleDNodeId,          
    kFBLeftRingInNodeId,           
    kFBLeftRingDNodeId,            
    kFBLeftPinkyInNodeId,          
    kFBLeftPinkyDNodeId,           
    kFBRightThumbInNodeId,         
    kFBRightThumbDNodeId,          
    kFBRightIndexInNodeId,         
    kFBRightIndexDNodeId,          
    kFBRightMiddleInNodeId,        
    kFBRightMiddleDNodeId,         
    kFBRightRingInNodeId,          
    kFBRightRingDNodeId,           
    kFBRightPinkyInNodeId,         
    kFBRightPinkyDNodeId,          

    kFBLeftExtraFingerInNodeId,    
    kFBLeftExtraFingerANodeId,     
    kFBLeftExtraFingerBNodeId,     
    kFBLeftExtraFingerCNodeId,     
    kFBLeftExtraFingerDNodeId,     
    kFBRightExtraFingerInNodeId,   
    kFBRightExtraFingerANodeId,    
    kFBRightExtraFingerBNodeId,    
    kFBRightExtraFingerCNodeId,    
    kFBRightExtraFingerDNodeId,    

    kFBLeftFootThumbInNodeId,      
    kFBLeftFootThumbANodeId,       
    kFBLeftFootThumbBNodeId,       
    kFBLeftFootThumbCNodeId,       
    kFBLeftFootThumbDNodeId,       
    kFBLeftFootIndexInNodeId,      
    kFBLeftFootIndexANodeId,       
    kFBLeftFootIndexBNodeId,       
    kFBLeftFootIndexCNodeId,       
    kFBLeftFootIndexDNodeId,       
    kFBLeftFootMiddleInNodeId,     
    kFBLeftFootMiddleANodeId,      
    kFBLeftFootMiddleBNodeId,      
    kFBLeftFootMiddleCNodeId,      
    kFBLeftFootMiddleDNodeId,      
    kFBLeftFootRingInNodeId,       
    kFBLeftFootRingANodeId,        
    kFBLeftFootRingBNodeId,        
    kFBLeftFootRingCNodeId,        
    kFBLeftFootRingDNodeId,        
    kFBLeftFootPinkyInNodeId,      
    kFBLeftFootPinkyANodeId,       
    kFBLeftFootPinkyBNodeId,       
    kFBLeftFootPinkyCNodeId,       
    kFBLeftFootPinkyDNodeId,       
    kFBRightFootThumbInNodeId,     
    kFBRightFootThumbANodeId,      
    kFBRightFootThumbBNodeId,      
    kFBRightFootThumbCNodeId,      
    kFBRightFootThumbDNodeId,      
    kFBRightFootIndexInNodeId,     
    kFBRightFootIndexANodeId,      
    kFBRightFootIndexBNodeId,      
    kFBRightFootIndexCNodeId,      
    kFBRightFootIndexDNodeId,      
    kFBRightFootMiddleInNodeId,    
    kFBRightFootMiddleANodeId,     
    kFBRightFootMiddleBNodeId,     
    kFBRightFootMiddleCNodeId,     
    kFBRightFootMiddleDNodeId,     
    kFBRightFootRingInNodeId,      
    kFBRightFootRingANodeId,       
    kFBRightFootRingBNodeId,       
    kFBRightFootRingCNodeId,       
    kFBRightFootRingDNodeId,       
    kFBRightFootPinkyInNodeId,     
    kFBRightFootPinkyANodeId,      
    kFBRightFootPinkyBNodeId,      
    kFBRightFootPinkyCNodeId,      
    kFBRightFootPinkyDNodeId,      

    kFBLeftExtraFootFingerInNodeId,        
    kFBLeftExtraFootFingerANodeId,         
    kFBLeftExtraFootFingerBNodeId,         
    kFBLeftExtraFootFingerCNodeId,         
    kFBLeftExtraFootFingerDNodeId,         
    kFBRightExtraFootFingerInNodeId,       
    kFBRightExtraFootFingerANodeId,        
    kFBRightExtraFootFingerBNodeId,        
    kFBRightExtraFootFingerCNodeId,        
    kFBRightExtraFootFingerDNodeId,        

    kFBLeftHandNodeId,             
    kFBRightHandNodeId,            
    kFBNeck1NodeId,                
    kFBNeck2NodeId,                
    kFBNeck3NodeId,                
    kFBNeck4NodeId,                
    kFBNeck5NodeId,                
    kFBNeck6NodeId,                
    kFBNeck7NodeId,                
    kFBNeck8NodeId,                
    kFBNeck9NodeId,                

    kFBHipsTranslationNodeId,       
    kFBLastNodeId                   
};

All effector nodes.

Enumerator:
kFBInvalidEffectorId 
kFBHipsEffectorId 
kFBLeftAnkleEffectorId 
kFBRightAnkleEffectorId 
kFBLeftWristEffectorId 
kFBRightWristEffectorId 
kFBLeftKneeEffectorId 
kFBRightKneeEffectorId 
kFBLeftElbowEffectorId 
kFBRightElbowEffectorId 
kFBChestOriginEffectorId 
kFBChestEndEffectorId 
kFBLeftFootEffectorId 
kFBRightFootEffectorId 
kFBLeftShoulderEffectorId 
kFBRightShoulderEffectorId 
kFBHeadEffectorId 
kFBLeftHipEffectorId 
kFBRightHipEffectorId 
kFBLeftHandEffectorId 
kFBRightHandEffectorId 
kFBLeftHandThumbEffectorId 
kFBLeftHandIndexEffectorId 
kFBLeftHandMiddleEffectorId 
kFBLeftHandRingEffectorId 
kFBLeftHandPinkyEffectorId 
kFBLeftHandExtraFingerEffectorId 
kFBRightHandThumbEffectorId 
kFBRightHandIndexEffectorId 
kFBRightHandMiddleEffectorId 
kFBRightHandRingEffectorId 
kFBRightHandPinkyEffectorId 
kFBRightHandExtraFingerEffectorId 
kFBLeftFootThumbEffectorId 
kFBLeftFootIndexEffectorId 
kFBLeftFootMiddleEffectorId 
kFBLeftFootRingEffectorId 
kFBLeftFootPinkyEffectorId 
kFBLeftFootExtraFingerEffectorId 
kFBRightFootThumbEffectorId 
kFBRightFootIndexEffectorId 
kFBRightFootMiddleEffectorId 
kFBRightFootRingEffectorId 
kFBRightFootPinkyEffectorId 
kFBRightFootExtraFingerEffectorId 
kFBLastEffectorId 

Definition at line 310 of file fbcharacter.h.

Floor contact for the given index.

Enumerator:
FBLeftHandMemberIndex 
FBRightHandMemberIndex 
FBLeftFootMemberIndex 
FBRightFootMemberIndex 
FBLastCharacterMember 

Definition at line 383 of file fbcharacter.h.

Body part for character.

Enumerator:
kFBCtrlSetPartNone 

No part selected.

kFBCtrlSetPartHips 

Hips Body Part.

kFBCtrlSetPartChest 

Chest Body Part.

kFBCtrlSetPartLeftArm 

Left Arm Body Part.

kFBCtrlSetPartRightArm 

Right Arm Body Part.

kFBCtrlSetPartLeftLeg 

Left Leg Body Part.

kFBCtrlSetPartRightLeg 

Right Leg Body Part.

kFBCtrlSetPartHead 

Head Body Part.

kFBCtrlSetPartLeftHand 

Left Hand Body Part.

kFBCtrlSetPartRightHand 

Right Hand Body Part.

kFBCtrlSetPartLeftFoot 

Left Foot Body Part.

kFBCtrlSetPartRightFoot 

Right Foot Body Part.

kFBLastCtrlSetPartIndex 

Part count.

Definition at line 393 of file fbcharacter.h.

Character Input/Output types.

Enumerator:
kFBCharacterInputActor 
kFBCharacterInputCharacter 
kFBCharacterInputMarkerSet 
kFBCharacterOutputMarkerSet 
kFBCharacterInputStance 
kFBCharacterInputMoCap 

Definition at line 413 of file fbcharacter.h.

Character keying modes.

Enumerator:
kFBCharacterKeyingFullBody 
kFBCharacterKeyingBodyPart 
kFBCharacterKeyingSelection 

Definition at line 425 of file fbcharacter.h.

Character Reset Properties Type.

Enumerator:
kFBCharacterResetPropertiesAll 
kFBCharacterResetPropertiesSolving 
kFBCharacterResetPropertiesDefinition 

Definition at line 434 of file fbcharacter.h.

Where to plot a character.

Enumerator:
kFBCharacterPlotOnControlRig 
kFBCharacterPlotOnSkeleton 

Definition at line 442 of file fbcharacter.h.

Character Hips Translation modes.

Enumerator:
kFBParamHipsTranslationWorldRigid 
kFBParamHipsTranslationBodyRigid 
kFBLastHipsTranslationMode 

Definition at line 450 of file fbcharacter.h.

Character Roll Solver version.

Enumerator:
kFBParamRollSolver70 
kFBParamRollSolver75 
kFBLastRollSolver 

Definition at line 459 of file fbcharacter.h.

Character Contact Behaviour.

Enumerator:
kFBParamContactNeverSync 
kFBParamContactSyncOnKey 
kFBParamContactAlwaysSync 
kFBLastContactBehaviour 

Definition at line 468 of file fbcharacter.h.

Character ControlSet type.

Enumerator:
kFBControlSetTypeNone 
kFBControlSetTypeFKIK 
kFBControlSetTypeIKOnly 

Definition at line 478 of file fbcharacter.h.

Recalculate MarkerSet offset for?

Enumerator:
kFBRecalcMarkerSetOffsetTR 

Recalculate MarkerSet offset for TR.

kFBRecalcMarkerSetOffsetROnly 

Recalculate MarkerSet offset for R Only.

Definition at line 851 of file fbcharacter.h.


Function Documentation

FB_DEFINE_ENUM ( FBSDK_DLL  ,
CharacterInputType   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CharacterKeyingMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CharacterPlotWhere   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CharacterHipsTranslationMode   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CharacterRollSolver   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
CharacterContactBehaviour   
)
FB_DEFINE_ENUM ( FBSDK_DLL  ,
ControlSetType   
)
FBSDK_DLL const char* FBCharacterBodyNodeNameFromId ( FBBodyNodeId  pBodyNodeId)

Get the UI name associated with a body node.

Parameters:
pBodyNodeIdThe body node ID.
Returns:
The UI name for this body node.
FBSDK_DLL const char* FBCharacterEffectorNameFromId ( FBEffectorId  pEffectorId)

Get the UI name associated with an effector.

Parameters:
pEffectorIdThe effector ID.
Returns:
The UI name for this effector.
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
MarkerSet   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
ControlSet   
)
__FB_FORWARD ( FBControlSetState  )

Control Set State class.

These classes are under development and may change dramatically between versions.

__FB_FORWARD ( FBEffectorSetState  )

Effector Set State class.

These classes are under development and may change dramatically between versions.

FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
CharacterMarkerSet   
)
__FB_FORWARD ( FBSkeletonState  )

Skeleton State class.

These classes are under development and may change dramatically between versions.

__FB_FORWARD ( FBActor  )
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Actor   
)
FB_DEFINE_COMPONENT ( FBSDK_DLL  ,
Character   
)
FBSDK_DLL FBCharacterKeyingMode FBGetCharactersKeyingMode ( )

return Character Manipulation/Keying Mode

Returns:
Keying Mode
FBSDK_DLL FBBodyPartId FBGetEffectorBodyPart ( FBEffectorId  pEffectorId)

return BodyPart ID from Effector.

Parameters:
pEffectorIdEffector ID.
Returns:
ID of the BodyPart the effector is in.
FBSDK_DLL FBBodyPartId FBGetBodyNodeBodyPart ( FBBodyNodeId  pBodyNodeId)

return BodyPart ID from Bones.

Parameters:
pBodyNodeIdBody Node ID.
Returns:
ID of the BodyPart the effector is in.
FBSDK_DLL FBCharacter* FBGetCharacterByAssociatedPart ( FBComponent pPart)

Get character by its associated IK/FK Marker or Bone.

Parameters:
pPartassociated IK/FK Marker or Bone
Returns:
character.
FBSDK_DLL bool FBGetCharacterFloorContactsVisibility ( )

Queries visibility of the floor contacts of the current character.

Returns:
True if floor contacts of the current character are visible, or false if they are hidden.
FBSDK_DLL void FBSetCharacterFloorContactsVisibility ( bool  pShow)

Sets visibility of the floor contacts of the current character.

Parameters:
pShowSpecifies if floor contacts of the current character should be visible.
FBSDK_DLL bool FBGetCharacterFingerTipsVisibility ( )

Queries visibility of the finger-tips of the current character.

Returns:
True if finger-tips of the current character are visible, or false if they are hidden.
FBSDK_DLL void FBSetCharacterFingerTipsVisibility ( bool  pShow)

Sets visibility of the finger-tips of the current character.

Parameters:
pShowSpecifies if finger-tips of the current character should be visible.

Variable Documentation

const int kFBLastActorNodeId = ( kFBHeadNodeId + 1 )

Last Actor NodeId.

Definition at line 307 of file fbcharacter.h.