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

#include <kaydaradef.h>
#include <fbsdk/fbconstraint.h>
#include <fbsdk/fbcycleanalysisnode.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	FBMocapJointsState

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...

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

Typedefs
typedef class K_DLLIMPORT FBArrayTemplate< FBModel * >	FBModelList
	typedef class FBSDK_DLL FBArrayTemplate<FBModel*> FBModelList; More...

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_Old , kFBLeftHipRollNode1Id = kFBLastNodeId_Old , kFBLeftKneeRollNode1Id , kFBRightHipRollNode1Id , kFBRightKneeRollNode1Id , kFBLeftShoulderRollNode1Id , kFBLeftElbowRollNode1Id , kFBRightShoulderRollNode1Id , kFBRightElbowRollNode1Id , kFBLeftHipRollNode2Id , kFBLeftKneeRollNode2Id , kFBRightHipRollNode2Id , kFBRightKneeRollNode2Id , kFBLeftShoulderRollNode2Id , kFBLeftElbowRollNode2Id , kFBRightShoulderRollNode2Id , kFBRightElbowRollNode2Id , kFBLeftHipRollNode3Id , kFBLeftKneeRollNode3Id , kFBRightHipRollNode3Id , kFBRightKneeRollNode3Id , kFBLeftShoulderRollNode3Id , kFBLeftElbowRollNode3Id , kFBRightShoulderRollNode3Id , kFBRightElbowRollNode3Id , kFBLeftHipRollNode4Id , kFBLeftKneeRollNode4Id , kFBRightHipRollNode4Id , kFBRightKneeRollNode4Id , kFBLeftShoulderRollNode4Id , kFBLeftElbowRollNode4Id , kFBRightShoulderRollNode4Id , kFBRightElbowRollNode4Id , kFBLeftHipRollNode5Id , kFBLeftKneeRollNode5Id , kFBRightHipRollNode5Id , kFBRightKneeRollNode5Id , kFBLeftShoulderRollNode5Id , kFBLeftElbowRollNode5Id , kFBRightShoulderRollNode5Id , kFBRightElbowRollNode5Id , 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 , kFBCharacterKeyingFullBodyNoPull }
	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	FBSkeletonTrackingState { kFBSkeletonNotTracked = 0 , kFBSkeletonPositionOnly , kFBSkeletonTracked }
	Device Mocap skeleton tracking state. More...

enum	FBSkeletonJointTrackingState { kFBSkeletonJointNotTracked = 0 , kFBSkeletonJointInferred , kFBSkeletonJointTracked }
	Device Mocap skeleton joint tracking state. More...

enum	FBCalibrationState { FBCalibrationNoRequest = 0 , FBCalibrationInProcessing , FBCalibrationSuccessfully }
	Device Mocap character calibration state. More...

enum	FBVisibilityState { kFBVisibilityAny , kFBVisibilityAll , kFBVisibilitySome , kFBVisibilityInvalid }
	Visibility state. More...

enum	FBRecalcMarkerSetOffset { kFBRecalcMarkerSetOffsetTR , kFBRecalcMarkerSetOffsetROnly }
	Recalculate MarkerSet offset for? More...

Functions
	FB_DEFINE_ENUM (K_DLLIMPORT, CharacterInputType)

	FB_DEFINE_ENUM (K_DLLIMPORT, CharacterKeyingMode)

	FB_DEFINE_ENUM (K_DLLIMPORT, CharacterPlotWhere)

	FB_DEFINE_ENUM (K_DLLIMPORT, CharacterHipsTranslationMode)

	FB_DEFINE_ENUM (K_DLLIMPORT, CharacterRollSolver)

	FB_DEFINE_ENUM (K_DLLIMPORT, CharacterContactBehaviour)

	FB_DEFINE_ENUM (K_DLLIMPORT, ControlSetType)

	FB_DEFINE_ENUM (K_DLLIMPORT, SkeletonTrackingState)

	FB_DEFINE_ENUM (K_DLLIMPORT, SkeletonJointTrackingState)

	FB_DEFINE_ENUM (K_DLLIMPORT, CalibrationState)

	FB_DEFINE_ENUM (K_DLLIMPORT, VisibilityState)

K_DLLIMPORT const char *	FBCharacterBodyNodeNameFromId (FBBodyNodeId pBodyNodeId)
	Get the UI name associated with a body node. More...

K_DLLIMPORT const char *	FBCharacterEffectorNameFromId (FBEffectorId pEffectorId)
	Get the UI name associated with an effector. More...

	__FB_FORWARD (FBMarkerSet)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, MarkerSet)

	FB_FORWARD (FBModel)

	__FB_FORWARD (FBControlSet)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, ControlSet)

	__FB_FORWARD (FBControlSetState)
	Control Set State class. More...

	__FB_FORWARD (FBEffectorSetState)
	Effector Set State class. More...

	__FB_FORWARD (FBCharacterMarkerSet)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, CharacterMarkerSet)

	__FB_FORWARD (FBSkeletonState)
	Skeleton State class. More...

	__FB_FORWARD (FBActor)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, Actor)

	__FB_FORWARD (FBMocapJointsState)
	Device motion capture skeleton joints state class. More...

	FB_FORWARD (FBPlotOptions)

	__FB_FORWARD (FBCharacter)

	FB_DEFINE_COMPONENT (K_DLLIMPORT, Character)

	FB_FORWARD (FBPropertyListCharacter)

K_DLLIMPORT FBCharacterKeyingMode	FBGetCharactersKeyingMode ()
	return Character Manipulation/Keying Mode More...

K_DLLIMPORT FBBodyPartId	FBGetEffectorBodyPart (FBEffectorId pEffectorId)
	return BodyPart ID from Effector. More...

K_DLLIMPORT FBBodyPartId	FBGetBodyNodeBodyPart (FBBodyNodeId pBodyNodeId)
	return BodyPart ID from Bones. More...

K_DLLIMPORT FBCharacter *	FBGetCharacterByAssociatedPart (FBComponent *pPart)
	Get character by its associated IK/FK Marker or Bone. More...

K_DLLIMPORT bool	FBGetCharacterFloorContactsVisibility ()
	Queries visibility of the floor contacts of the current character. More...

K_DLLIMPORT void	FBSetCharacterFloorContactsVisibility (bool pShow)
	Sets visibility of the floor contacts of the current character. More...

K_DLLIMPORT bool	FBGetCharacterFingerTipsVisibility ()
	Queries visibility of the finger-tips of the current character. More...

K_DLLIMPORT void	FBSetCharacterFingerTipsVisibility (bool pShow)
	Sets visibility of the finger-tips of the current character. More...

K_DLLIMPORT bool	FBGetActorMarkerSetVisibility ()
	Queries visibility of the marker set of the current actor. More...

K_DLLIMPORT bool	FBSetActorMarkerSetVisibility (bool pShow)
	Sets visibility of the marker set of the current actor. More...

K_DLLIMPORT bool	FBLoadCharacterPinningPreset (const char *pPresetName)
	Loads a pinning preset in the Character Controls Tool. More...

K_DLLIMPORT bool	FBSaveCharacterPinningPreset (const char *pPresetName, bool pAllowOverwriting=false)
	Saves a pinning preset from the current pinning values in the Character Controls Tool. More...

K_DLLIMPORT bool	FBDeleteCharacterPinningPreset (const char *pPresetName)
	Deletes a pinning preset from the Character Controls Tool. More...

K_DLLIMPORT double	FBGetCharacterComparisonThresholdValue ()
	Return the Character comparison threshold value used when comparing two characters (e.g. More...

K_DLLIMPORT void	FBSetCharacterComparisonThresholdValue (double pValue)
	Set the Character threshold value used when comparing two characters (e.g. More...

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

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.

Macro Definition Documentation

◆ FBSDK_DLL

#define FBSDK_DLL K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 51 of file fbcharacter.h.

Typedef Documentation

◆ FBModelList

typedef class K_DLLIMPORT FBArrayTemplate<FBModel*> FBModelList

typedef class FBSDK_DLL FBArrayTemplate<FBModel*> FBModelList;

Definition at line 594 of file fbcharacter.h.

Enumeration Type Documentation

◆ FBBodyNodeId

enum FBBodyNodeId

All body nodes.

Enumerator
kFBHipsNodeId	Required.
kFBLeftHipNodeId	Required.
kFBLeftKneeNodeId	Required.
kFBLeftAnkleNodeId	Required.
kFBRightHipNodeId	Required.
kFBRightKneeNodeId	Required.
kFBRightAnkleNodeId	Required.
kFBWaistNodeId	Required, Spine 0.
kFBChestNodeId	Spine 1.
kFBLeftShoulderNodeId	Required.
kFBLeftElbowNodeId	Required.
kFBLeftWristNodeId	Required.
kFBRightShoulderNodeId	Required.
kFBRightElbowNodeId	Required.
kFBRightWristNodeId	Required.
kFBHeadNodeId	Required.
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.
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.
kFBLeftHipRollNode1Id	New leaf roll bone.
kFBLeftKneeRollNode1Id	New leaf roll bone.
kFBRightHipRollNode1Id	New leaf roll bone.
kFBRightKneeRollNode1Id	New leaf roll bone.
kFBLeftShoulderRollNode1Id	New leaf roll bone.
kFBLeftElbowRollNode1Id	New leaf roll bone.
kFBRightShoulderRollNode1Id	New leaf roll bone.
kFBRightElbowRollNode1Id	New leaf roll bone.
kFBLeftHipRollNode2Id	New leaf roll bone.
kFBLeftKneeRollNode2Id	New leaf roll bone.
kFBRightHipRollNode2Id	New leaf roll bone.
kFBRightKneeRollNode2Id	New leaf roll bone.
kFBLeftShoulderRollNode2Id	New leaf roll bone.
kFBLeftElbowRollNode2Id	New leaf roll bone.
kFBRightShoulderRollNode2Id	New leaf roll bone.
kFBRightElbowRollNode2Id	New leaf roll bone.
kFBLeftHipRollNode3Id	New leaf roll bone.
kFBLeftKneeRollNode3Id	New leaf roll bone.
kFBRightHipRollNode3Id	New leaf roll bone.
kFBRightKneeRollNode3Id	New leaf roll bone.
kFBLeftShoulderRollNode3Id	New leaf roll bone.
kFBLeftElbowRollNode3Id	New leaf roll bone.
kFBRightShoulderRollNode3Id	New leaf roll bone.
kFBRightElbowRollNode3Id	New leaf roll bone.
kFBLeftHipRollNode4Id	New leaf roll bone.
kFBLeftKneeRollNode4Id	New leaf roll bone.
kFBRightHipRollNode4Id	New leaf roll bone.
kFBRightKneeRollNode4Id	New leaf roll bone.
kFBLeftShoulderRollNode4Id	New leaf roll bone.
kFBLeftElbowRollNode4Id	New leaf roll bone.
kFBRightShoulderRollNode4Id	New leaf roll bone.
kFBRightElbowRollNode4Id	New leaf roll bone.
kFBLeftHipRollNode5Id	New leaf roll bone.
kFBLeftKneeRollNode5Id	New leaf roll bone.
kFBRightHipRollNode5Id	New leaf roll bone.
kFBRightKneeRollNode5Id	New leaf roll bone.
kFBLeftShoulderRollNode5Id	New leaf roll bone.
kFBLeftElbowRollNode5Id	New leaf roll bone.
kFBRightShoulderRollNode5Id	New leaf roll bone.
kFBRightElbowRollNode5Id	New leaf roll bone.

Definition at line 124 of file fbcharacter.h.

◆ FBBodyPartId

enum FBBodyPartId

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 446 of file fbcharacter.h.

◆ FBCalibrationState

enum FBCalibrationState

Device Mocap character calibration state.

Definition at line 559 of file fbcharacter.h.

◆ FBCharacterContactBehaviour

enum FBCharacterContactBehaviour

Character Contact Behaviour.

Definition at line 522 of file fbcharacter.h.

◆ FBCharacterHipsTranslationMode

enum FBCharacterHipsTranslationMode

Character Hips Translation modes.

Definition at line 504 of file fbcharacter.h.

◆ FBCharacterInputType

enum FBCharacterInputType

Character Input/Output types.

Definition at line 466 of file fbcharacter.h.

◆ FBCharacterKeyingMode

enum FBCharacterKeyingMode

Character keying modes.

Definition at line 478 of file fbcharacter.h.

◆ FBCharacterPlotWhere

enum FBCharacterPlotWhere

Where to plot a character.

Definition at line 496 of file fbcharacter.h.

◆ FBCharacterResetProperties

enum FBCharacterResetProperties

Character Reset Properties Type.

Definition at line 488 of file fbcharacter.h.

◆ FBCharacterRollSolver

enum FBCharacterRollSolver

Character Roll Solver version.

Definition at line 513 of file fbcharacter.h.

◆ FBControlSetType

enum FBControlSetType

Character ControlSet type.

Definition at line 532 of file fbcharacter.h.

◆ FBEffectorId

enum FBEffectorId

All effector nodes.

Definition at line 363 of file fbcharacter.h.

◆ FBEffectorSetID

enum FBEffectorSetID

Effector ID identifier.

Definition at line 415 of file fbcharacter.h.

◆ FBFloorContactID

enum FBFloorContactID

Floor contact for the given index.

Definition at line 436 of file fbcharacter.h.

◆ FBRecalcMarkerSetOffset

enum FBRecalcMarkerSetOffset

Recalculate MarkerSet offset for?

Enumerator
kFBRecalcMarkerSetOffsetTR	Recalculate MarkerSet offset for TR.
kFBRecalcMarkerSetOffsetROnly	Recalculate MarkerSet offset for R Only.

Definition at line 942 of file fbcharacter.h.

◆ FBSkeletonJointTrackingState

enum FBSkeletonJointTrackingState

Device Mocap skeleton joint tracking state.

Definition at line 550 of file fbcharacter.h.

◆ FBSkeletonNodeId

enum FBSkeletonNodeId

All Skeleton nodes

Definition at line 65 of file fbcharacter.h.

◆ FBSkeletonTrackingState

enum FBSkeletonTrackingState

Device Mocap skeleton tracking state.

Definition at line 541 of file fbcharacter.h.

◆ FBVisibilityState

enum FBVisibilityState

Visibility state.

Enumerator
kFBVisibilityAny	Any object requested is visible.
kFBVisibilityAll	All objects requested are visible.
kFBVisibilitySome	Some objects (at least one, but not all) requested are visible.
kFBVisibilityInvalid	Invalid visibility request.

Definition at line 568 of file fbcharacter.h.

Function Documentation

◆ __FB_FORWARD() [1/4]

__FB_FORWARD ( FBControlSetState )

Control Set State class.

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

◆ __FB_FORWARD() [2/4]

__FB_FORWARD ( FBEffectorSetState )

Effector Set State class.

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

◆ __FB_FORWARD() [3/4]

__FB_FORWARD ( FBMocapJointsState )

Device motion capture skeleton joints state class.

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

◆ __FB_FORWARD() [4/4]

__FB_FORWARD ( FBSkeletonState )

Skeleton State class.

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

◆ FBCharacterBodyNodeNameFromId()

K_DLLIMPORT const char* FBCharacterBodyNodeNameFromId ( FBBodyNodeId pBodyNodeId )

Get the UI name associated with a body node.

Parameters

pBodyNodeId The body node ID.

Returns: The UI name for this body node.

◆ FBCharacterEffectorNameFromId()

K_DLLIMPORT const char* FBCharacterEffectorNameFromId ( FBEffectorId pEffectorId )

Get the UI name associated with an effector.

Parameters

pEffectorId The effector ID.

Returns: The UI name for this effector.

◆ FBDeleteCharacterPinningPreset()

K_DLLIMPORT bool FBDeleteCharacterPinningPreset ( const char * pPresetName )

Deletes a pinning preset from the Character Controls Tool.

Parameters

pPresetName The preset name to delete (not the file path nor the filename of the preset).

Returns: True if the operation is successful, false otherwise.

◆ FBGetActorMarkerSetVisibility()

K_DLLIMPORT bool FBGetActorMarkerSetVisibility ( )

Queries visibility of the marker set of the current actor.

Returns: True if the marker set of the current actor are visible, or false if it is hidden.

◆ FBGetBodyNodeBodyPart()

K_DLLIMPORT FBBodyPartId FBGetBodyNodeBodyPart ( FBBodyNodeId pBodyNodeId )

return BodyPart ID from Bones.

Parameters

pBodyNodeId Body Node ID.

Returns: ID of the BodyPart the effector is in.

◆ FBGetCharacterByAssociatedPart()

K_DLLIMPORT FBCharacter* FBGetCharacterByAssociatedPart ( FBComponent * pPart )

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

Parameters

pPart associated IK/FK Marker or Bone

Returns: character.

◆ FBGetCharacterComparisonThresholdValue()

K_DLLIMPORT double FBGetCharacterComparisonThresholdValue ( )

Return the Character comparison threshold value used when comparing two characters (e.g.

: when applying a Character Clip using the "Control Rig" Solving Mode).

Returns: The threshold value.

◆ FBGetCharacterFingerTipsVisibility()

K_DLLIMPORT 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.

◆ FBGetCharacterFloorContactsVisibility()

K_DLLIMPORT 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.

◆ FBGetCharactersKeyingMode()

K_DLLIMPORT FBCharacterKeyingMode FBGetCharactersKeyingMode ( )

return Character Manipulation/Keying Mode

Returns: Keying Mode

◆ FBGetEffectorBodyPart()

K_DLLIMPORT FBBodyPartId FBGetEffectorBodyPart ( FBEffectorId pEffectorId )

return BodyPart ID from Effector.

Parameters

pEffectorId Effector ID.

Returns: ID of the BodyPart the effector is in.

◆ FBLoadCharacterPinningPreset()

K_DLLIMPORT bool FBLoadCharacterPinningPreset ( const char * pPresetName )

Loads a pinning preset in the Character Controls Tool.

Parameters

pPresetName The preset name to load (not the file path nor the filename of the preset).

Returns: True if the operation is successful, false otherwise.

◆ FBSaveCharacterPinningPreset()

K_DLLIMPORT bool FBSaveCharacterPinningPreset	(	const char *	pPresetName,
		bool	pAllowOverwriting = `false`
	)

Saves a pinning preset from the current pinning values in the Character Controls Tool.

Parameters

pPresetName	The preset name to save (not the file path nor the filename of the preset).
pAllowOverwriting	True to allow overwriting an existing preset having the same name as the one provided, false otherwise.

Returns: True if the operation is successful, false otherwise.

◆ FBSetActorMarkerSetVisibility()

K_DLLIMPORT bool FBSetActorMarkerSetVisibility ( bool pShow )

Sets visibility of the marker set of the current actor.

Parameters

pShow Specifies if the market of the current actor should be visible.

Returns: True if the operation is successful, false otherwise.

◆ FBSetCharacterComparisonThresholdValue()

K_DLLIMPORT void FBSetCharacterComparisonThresholdValue ( double pValue )

Set the Character threshold value used when comparing two characters (e.g.

: when applying a Character Clip using the "Control Rig" Solving Mode).

Parameters

pValue The new threshold value to set.

◆ FBSetCharacterFingerTipsVisibility()

K_DLLIMPORT void FBSetCharacterFingerTipsVisibility ( bool pShow )

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

Parameters

pShow Specifies if finger-tips of the current character should be visible.

◆ FBSetCharacterFloorContactsVisibility()

K_DLLIMPORT void FBSetCharacterFloorContactsVisibility ( bool pShow )

Sets visibility of the floor contacts of the current character.

Parameters

pShow Specifies if floor contacts of the current character should be visible.

Variable Documentation

◆ kFBLastActorNodeId

const int kFBLastActorNodeId = ( kFBHeadNodeId + 1 )

Last Actor NodeId.

Definition at line 360 of file fbcharacter.h.

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Detailed Description

Macro Definition Documentation

◆ FBSDK_DLL

Typedef Documentation

◆ FBModelList

Enumeration Type Documentation

◆ FBBodyNodeId

◆ FBBodyPartId

◆ FBCalibrationState

◆ FBCharacterContactBehaviour

◆ FBCharacterHipsTranslationMode

◆ FBCharacterInputType

◆ FBCharacterKeyingMode

◆ FBCharacterPlotWhere

◆ FBCharacterResetProperties

◆ FBCharacterRollSolver

◆ FBControlSetType

◆ FBEffectorId

◆ FBEffectorSetID

◆ FBFloorContactID

◆ FBRecalcMarkerSetOffset

◆ FBSkeletonJointTrackingState

◆ FBSkeletonNodeId

◆ FBSkeletonTrackingState

◆ FBVisibilityState

Function Documentation

◆ __FB_FORWARD() [1/4]

◆ __FB_FORWARD() [2/4]

◆ __FB_FORWARD() [3/4]

◆ __FB_FORWARD() [4/4]

◆ FBCharacterBodyNodeNameFromId()

◆ FBCharacterEffectorNameFromId()

◆ FBDeleteCharacterPinningPreset()

◆ FBGetActorMarkerSetVisibility()

◆ FBGetBodyNodeBodyPart()

◆ FBGetCharacterByAssociatedPart()

◆ FBGetCharacterComparisonThresholdValue()

◆ FBGetCharacterFingerTipsVisibility()

◆ FBGetCharacterFloorContactsVisibility()

◆ FBGetCharactersKeyingMode()

◆ FBGetEffectorBodyPart()

◆ FBLoadCharacterPinningPreset()

◆ FBSaveCharacterPinningPreset()

◆ FBSetActorMarkerSetVisibility()

◆ FBSetCharacterComparisonThresholdValue()

◆ FBSetCharacterFingerTipsVisibility()

◆ FBSetCharacterFloorContactsVisibility()

Variable Documentation

◆ kFBLastActorNodeId