fbcharacter.h File Reference

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.

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

Include dependency graph for fbcharacter.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.


Classes
class	FBMarkerSet
	Marker set class. More...
class	FBControlSet
	Control set class. More...
class	FBSkeletonState
class	FBActor
	Actor class. More...
class	FBCharacter
	Character class. More...
class	FBPropertyListMarkerSet
	PropertyList: MarkerSet. 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 K_DLLIMPORT FBArrayTemplate < HFBModel >	FBModelList
	typedef class FBSDK_DLL FBArrayTemplate<HFBModel> 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 }
	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
K_DLLIMPORT const char *	FBCharacterBodyNodeNameFromId (FBBodyNodeId pBodyNodeId)
	Get the UI name associated with a body node.
K_DLLIMPORT const char *	FBCharacterEffectorNameFromId (FBEffectorId pEffectorId)
	Get the UI name associated with an effector.
	__FB_FORWARD (FBSkeletonState)
	Skeleton State class.
K_DLLIMPORT FBCharacterKeyingMode	FBGetCharactersKeyingMode ()
	return Character Manipulation/Keying Mode
K_DLLIMPORT FBBodyPartId	FBGetEffectorBodyPart (FBEffectorId pEffectorId)
	return BodyPart ID from Effector.
K_DLLIMPORT FBBodyPartId	FBGetBodyNodeBodyPart (FBBodyNodeId pBodyNodeId)
	return BodyPart ID from Bones.
K_DLLIMPORT HFBCharacter	FBGetCharacterByAssociatedPart (HFBComponent pPart)
	Get character by its associated IK/FK Marker or Bone.
Variables
const int	kFBLastActorNodeId = ( kFBHeadNodeId + 1 )
	Last Actor NodeId.

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 K_DLLIMPORT FBArrayTemplate<HFBModel> FBModelList

typedef class FBSDK_DLL FBArrayTemplate<HFBModel> FBModelList;

Definition at line 505 of file fbcharacter.h.

Enumeration Type Documentation

enum FBBodyNodeId

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.

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

enum FBCharacterContactBehaviour

Character Contact Behaviour.

Enumerator:

kFBParamContactNeverSync
kFBParamContactSyncOnKey
kFBParamContactAlwaysSync
kFBLastContactBehaviour

Definition at line 467 of file fbcharacter.h.

enum FBCharacterHipsTranslationMode

Character Hips Translation modes.

Enumerator:

kFBParamHipsTranslationWorldRigid
kFBParamHipsTranslationBodyRigid
kFBLastHipsTranslationMode

Definition at line 449 of file fbcharacter.h.

enum FBCharacterInputType

Character Input/Output types.

Enumerator:

kFBCharacterInputActor
kFBCharacterInputCharacter
kFBCharacterInputMarkerSet
kFBCharacterOutputMarkerSet
kFBCharacterInputStance

Definition at line 413 of file fbcharacter.h.

enum FBCharacterKeyingMode

Character keying modes.

Enumerator:

kFBCharacterKeyingFullBody
kFBCharacterKeyingBodyPart
kFBCharacterKeyingSelection

Definition at line 424 of file fbcharacter.h.

enum FBCharacterPlotWhere

Where to plot a character.

Enumerator:

kFBCharacterPlotOnControlRig
kFBCharacterPlotOnSkeleton

Definition at line 441 of file fbcharacter.h.

enum FBCharacterResetProperties

Character Reset Properties Type.

Enumerator:

kFBCharacterResetPropertiesAll
kFBCharacterResetPropertiesSolving
kFBCharacterResetPropertiesDefinition

Definition at line 433 of file fbcharacter.h.

enum FBCharacterRollSolver

Character Roll Solver version.

Enumerator:

kFBParamRollSolver70
kFBParamRollSolver75
kFBLastRollSolver

Definition at line 458 of file fbcharacter.h.

enum FBControlSetType

Character ControlSet type.

Enumerator:

kFBControlSetTypeNone
kFBControlSetTypeFKIK
kFBControlSetTypeIKOnly

Definition at line 477 of file fbcharacter.h.

enum FBEffectorId

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.

enum FBEffectorSetID

Effector ID identifier.

Enumerator:

FBEffectorSetDefault
FBEffectorSetAux1
FBEffectorSetAux2
FBEffectorSetAux3
FBEffectorSetAux4
FBEffectorSetAux5
FBEffectorSetAux6
EFBffectorSetAux7
FBEffectorSetAux8
FBEffectorSetAux9
FBEffectorSetAux10
FBEffectorSetAux11
FBEffectorSetAux12
FBEffectorSetAux13
FBEffectorSetAux14
FBLastEffectorSetIndex

Definition at line 362 of file fbcharacter.h.

enum FBFloorContactID

Floor contact for the given index.

Enumerator:

FBLeftHandMemberIndex
FBRightHandMemberIndex
FBLeftFootMemberIndex
FBRightFootMemberIndex
FBLastCharacterMember

Definition at line 383 of file fbcharacter.h.

enum FBRecalcMarkerSetOffset

Recalculate MarkerSet offset for?

Enumerator:

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

Definition at line 769 of file fbcharacter.h.

enum FBSkeletonNodeId

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.

Function Documentation

__FB_FORWARD ( FBSkeletonState )

Skeleton State class.

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

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.

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.

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.

K_DLLIMPORT HFBCharacter FBGetCharacterByAssociatedPart ( HFBComponent pPart )

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

Parameters:

pPart

associated IK/FK Marker or Bone

Returns:: character.

K_DLLIMPORT FBCharacterKeyingMode FBGetCharactersKeyingMode ( )

return Character Manipulation/Keying Mode

Returns:: Keying Mode

K_DLLIMPORT FBBodyPartId FBGetEffectorBodyPart ( FBEffectorId pEffectorId )

return BodyPart ID from Effector.

Parameters:

pEffectorId

Effector ID.

Returns:: ID of the BodyPart the effector is in.

Variable Documentation

const int kFBLastActorNodeId = ( kFBHeadNodeId + 1 )

Last Actor NodeId.

Definition at line 307 of file fbcharacter.h.

Please send us your comments about this page.

fbcharacter.h File Reference

Detailed Description

Classes

Defines

Typedefs

Enumerations

Functions

Variables

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation