fbsdk/fbcharacter.h File Reference

fbcharacter.h File Reference

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

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

Namespaces

 ORSDK2018
 

Macros

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

Typedefs

typedef class FBPropertyBaseEnum< enum FBCharacterInputType > FBPropertyCharacterInputType
 
typedef class FBPropertyBaseEnum< enum FBCharacterKeyingMode > FBPropertyCharacterKeyingMode
 
typedef class FBPropertyBaseEnum< enum FBCharacterPlotWhere > FBPropertyCharacterPlotWhere
 
typedef class FBPropertyBaseEnum< enum FBCharacterHipsTranslationMode > FBPropertyCharacterHipsTranslationMode
 
typedef class FBPropertyBaseEnum< enum FBCharacterRollSolver > FBPropertyCharacterRollSolver
 
typedef class FBPropertyBaseEnum< enum FBCharacterContactBehaviour > FBPropertyCharacterContactBehaviour
 
typedef class FBPropertyBaseEnum< enum FBControlSetType > FBPropertyControlSetType
 
typedef class FBPropertyBaseEnum< enum FBSkeletonTrackingState > FBPropertySkeletonTrackingState
 
typedef class FBPropertyBaseEnum< enum FBSkeletonJointTrackingState > FBPropertySkeletonJointTrackingState
 
typedef class FBPropertyBaseEnum< enum FBCalibrationState > FBPropertyCalibrationState
 
typedef class FBPropertyBaseEnum< enum FBVisibilityState > FBPropertyVisibilityState
 
typedef class FBPropertyBase< FBMarkerSet *, kFBPT_object > FBPropertyBaseMarkerSet
 
typedef class FBPropertyBaseComponent< FBMarkerSet * > FBPropertyMarkerSet
 
typedef class FBArrayTemplate< FBModel * > FBModelList
 typedef class FBSDK_DLL FBArrayTemplate<FBModel*> FBModelList; More...
 
typedef class FBPropertyBase< FBControlSet *, kFBPT_object > FBPropertyBaseControlSet
 
typedef class FBPropertyBaseComponent< FBControlSet * > FBPropertyControlSet
 
typedef class FBPropertyBase< FBCharacterMarkerSet *, kFBPT_object > FBPropertyBaseCharacterMarkerSet
 
typedef class FBPropertyBaseComponent< FBCharacterMarkerSet * > FBPropertyCharacterMarkerSet
 

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

const char * FBCharacterBodyNodeNameFromId (FBBodyNodeId pBodyNodeId)
 Get the UI name associated with a body node. More...
 
const char * FBCharacterEffectorNameFromId (FBEffectorId pEffectorId)
 Get the UI name associated with an effector. More...
 
FBCharacterKeyingMode FBGetCharactersKeyingMode ()
 return Character Manipulation/Keying Mode More...
 
FBBodyPartId FBGetEffectorBodyPart (FBEffectorId pEffectorId)
 return BodyPart ID from Effector. More...
 
FBBodyPartId FBGetBodyNodeBodyPart (FBBodyNodeId pBodyNodeId)
 return BodyPart ID from Bones. More...
 
FBCharacter * FBGetCharacterByAssociatedPart (FBComponent *pPart)
 Get character by its associated IK/FK Marker or Bone. More...
 
bool FBGetCharacterFloorContactsVisibility ()
 Queries visibility of the floor contacts of the current character. More...
 
void FBSetCharacterFloorContactsVisibility (bool pShow)
 Sets visibility of the floor contacts of the current character. More...
 
bool FBGetCharacterFingerTipsVisibility ()
 Queries visibility of the finger-tips of the current character. More...
 
void FBSetCharacterFingerTipsVisibility (bool pShow)
 Sets visibility of the finger-tips of the current character. More...
 
bool FBGetActorMarkerSetVisibility ()
 Queries visibility of the marker set of the current actor. More...
 
bool FBSetActorMarkerSetVisibility (bool pShow)
 Sets visibility of the marker set of the current actor. More...
 

Variables

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

Macro Definition Documentation

#define FBSDK_DLL   K_DLLIMPORT

Be sure that FBSDK_DLL is defined only once...

Definition at line 51 of file fbcharacter.h.

Go to the source code of this file.