This reference page is linked to from the following overview topics: 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.
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<HFBModel> FBModelList |
typedef class FBSDK_DLL FBArrayTemplate<HFBModel> FBModelList;
Definition at line 505 of file fbcharacter.h.
Enumeration Type Documentation
| enum FBSkeletonNodeId |
All Skeleton nodes.
- Enumerator:
Definition at line 65 of file fbcharacter.h.
{
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
};
| enum FBBodyNodeId |
All body nodes.
- Enumerator:
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
};
| enum FBEffectorId |
All effector nodes.
- Enumerator:
Definition at line 310 of file fbcharacter.h.
{
kFBInvalidEffectorId = -1,
kFBHipsEffectorId = 0,
kFBLeftAnkleEffectorId,
kFBRightAnkleEffectorId,
kFBLeftWristEffectorId,
kFBRightWristEffectorId,
kFBLeftKneeEffectorId,
kFBRightKneeEffectorId,
kFBLeftElbowEffectorId,
kFBRightElbowEffectorId,
kFBChestOriginEffectorId,
kFBChestEndEffectorId,
kFBLeftFootEffectorId,
kFBRightFootEffectorId,
kFBLeftShoulderEffectorId,
kFBRightShoulderEffectorId,
kFBHeadEffectorId,
kFBLeftHipEffectorId,
kFBRightHipEffectorId,
// -- New effector for 2.0 --
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
};
| enum FBEffectorSetID |
Effector ID identifier.
- Enumerator:
Definition at line 362 of file fbcharacter.h.
{
FBEffectorSetDefault = 0,
FBEffectorSetAux1,
FBEffectorSetAux2,
FBEffectorSetAux3,
FBEffectorSetAux4,
FBEffectorSetAux5,
FBEffectorSetAux6,
EFBffectorSetAux7,
FBEffectorSetAux8,
FBEffectorSetAux9,
FBEffectorSetAux10,
FBEffectorSetAux11,
FBEffectorSetAux12,
FBEffectorSetAux13,
FBEffectorSetAux14,
FBLastEffectorSetIndex
};
| enum FBFloorContactID |
Floor contact for the given index.
- Enumerator:
-
FBLeftHandMemberIndex FBRightHandMemberIndex FBLeftFootMemberIndex FBRightFootMemberIndex FBLastCharacterMember
Definition at line 383 of file fbcharacter.h.
| enum FBBodyPartId |
Body part for character.
- Enumerator:
Definition at line 393 of file fbcharacter.h.
{
kFBCtrlSetPartNone = 0,
kFBCtrlSetPartHips,
kFBCtrlSetPartChest,
kFBCtrlSetPartLeftArm,
kFBCtrlSetPartRightArm,
kFBCtrlSetPartLeftLeg,
kFBCtrlSetPartRightLeg,
kFBCtrlSetPartHead,
kFBCtrlSetPartLeftHand,
kFBCtrlSetPartRightHand,
kFBCtrlSetPartLeftFoot,
kFBCtrlSetPartRightFoot,
kFBLastCtrlSetPartIndex
};
| enum FBCharacterInputType |
Character Input/Output types.
- Enumerator:
-
kFBCharacterInputActor kFBCharacterInputCharacter kFBCharacterInputMarkerSet kFBCharacterOutputMarkerSet kFBCharacterInputStance
Definition at line 413 of file fbcharacter.h.
Character keying modes.
Definition at line 424 of file fbcharacter.h.
Character Reset Properties Type.
- Enumerator:
-
kFBCharacterResetPropertiesAll kFBCharacterResetPropertiesSolving kFBCharacterResetPropertiesDefinition
Definition at line 433 of file fbcharacter.h.
| enum FBCharacterPlotWhere |
Where to plot a character.
Definition at line 441 of file fbcharacter.h.
Character Hips Translation modes.
- Enumerator:
-
kFBParamHipsTranslationWorldRigid kFBParamHipsTranslationBodyRigid kFBLastHipsTranslationMode
Definition at line 449 of file fbcharacter.h.
Character Roll Solver version.
Definition at line 458 of file fbcharacter.h.
Character Contact Behaviour.
- Enumerator:
-
kFBParamContactNeverSync kFBParamContactSyncOnKey kFBParamContactAlwaysSync kFBLastContactBehaviour
Definition at line 467 of file fbcharacter.h.
| enum FBControlSetType |
Character ControlSet type.
Definition at line 477 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 767 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:
-
pBodyNodeId The 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:
-
pEffectorId The effector ID.
- Returns:
- The UI name for this effector.
| __FB_FORWARD | ( | FBMarkerSet | ) |
| FB_DEFINE_COMPONENT | ( | FBSDK_DLL | , |
| MarkerSet | |||
| ) |
| FB_FORWARD | ( | FBModel | ) |
| __FB_FORWARD | ( | FBControlSet | ) |
| FB_DEFINE_COMPONENT | ( | FBSDK_DLL | , |
| ControlSet | |||
| ) |
| __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_FORWARD | ( | FBPlotOptions | ) |
| __FB_FORWARD | ( | FBCharacter | ) |
| FB_DEFINE_COMPONENT | ( | FBSDK_DLL | , |
| Character | |||
| ) |
| FB_FORWARD | ( | FBPropertyListCharacter | ) |
| FBSDK_DLL FBCharacterKeyingMode FBGetCharactersKeyingMode | ( | ) |
| FBSDK_DLL FBBodyPartId FBGetEffectorBodyPart | ( | FBEffectorId | pEffectorId | ) |
return BodyPart ID from Effector.
- Parameters:
-
pEffectorId Effector ID.
- Returns:
- ID of the BodyPart the effector is in.
| FBSDK_DLL FBBodyPartId FBGetBodyNodeBodyPart | ( | FBBodyNodeId | pBodyNodeId | ) |
return BodyPart ID from Bones.
- Parameters:
-
pBodyNodeId Body Node ID.
- Returns:
- ID of the BodyPart the effector is in.
| FBSDK_DLL HFBCharacter FBGetCharacterByAssociatedPart | ( | HFBComponent | pPart | ) |
Get character by its associated IK/FK Marker or Bone.
- Parameters:
-
pPart associated IK/FK Marker or Bone
- Returns:
- character.
Variable Documentation
| const int kFBLastActorNodeId = ( kFBHeadNodeId + 1 ) |
