FbxCharacter Class Reference
 
 
 
FbxCharacter Class Reference

This reference page is linked to from the following overview topics: FBX Scenes, Merging Two Scenes, List of Python Fbx classes.


#include <fbxcharacter.h>


Class Description

A Character is a person or animal with pre-defined skeleton system.

The skeleton system is composed of multiple named node (skeleton). This class contains all methods to setup an exported character or query information on an imported character. This class also contains some methods for manipulating the FbxCharacterLink, FbxControlSet

The most important part of a FbxCharacter is the FbxCharacterLink. There is one FbxCharacterLink for each characterized node. For more information see FbxCharacterLink class documentation.

See also:
FbxCharacterLink, FbxControlSet
Examples:

ImportScene/DisplayPose.cxx.

Definition at line 91 of file fbxcharacter.h.

Inheritance diagram for FbxCharacter:
FbxConstraint FbxObject FbxEmitter

List of all members.

Public Types

enum   EInputType {
  eInputActor, eInputCharacter, eInputMarkerSet, eOutputMarkerSet,
  eInputStancePose
}
  Character input type. More...
enum   EGroupId {
  eGroupBase, eGroupAuxiliary, eGroupSpine, eGroupRoll,
  eGroupSpecial, eGroupLeftHand, eGroupRightHand, eGroupProps,
  eGroupGameModeParent, eGroupNeck, eGroupLeftFoot, eGroupRightFoot,
  eGroupFloorContact, eGroupIdCount
}
  Define ID for character groups that contains multiple character nodes. More...
enum   ENodeId {
  eHips, eLeftHip, eLeftKnee, eLeftAnkle,
  eLeftFoot, eRightHip, eRightKnee, eRightAnkle,
  eRightFoot, eWaist, eChest, eLeftCollar,
  eLeftShoulder, eLeftElbow, eLeftWrist, eRightCollar,
  eRightShoulder, eRightElbow, eRightWrist, eNeck,
  eHead, eLeftHipRoll, eLeftKneeRoll, eRightHipRoll,
  eRightKneeRoll, eLeftShoulderRoll, eLeftElbowRoll, eRightShoulderRoll,
  eRightElbowRoll, eSpine2, eSpine3, eSpine4,
  eSpine5, eSpine6, eSpine7, eSpine8,
  eSpine9, eLeftThumbA, eLeftThumbB, eLeftThumbC,
  eLeftIndexA, eLeftIndexB, eLeftIndexC, eLeftMiddleA,
  eLeftMiddleB, eLeftMiddleC, eLeftRingA, eLeftRingB,
  eLeftRingC, eLeftPinkyA, eLeftPinkyB, eLeftPinkyC,
  eRightThumbA, eRightThumbB, eRightThumbC, eRightIndexA,
  eRightIndexB, eRightIndexC, eRightMiddleA, eRightMiddleB,
  eRightMiddleC, eRightRingA, eRightRingB, eRightRingC,
  eRightPinkyA, eRightPinkyB, eRightPinkyC, eReference,
  eLeftFloor, eRightFloor, eHipsTranslation, eProps0,
  eProps1, eProps2, eProps3, eProps4,
  eGameModeParentLeftHipRoll, eGameModeParentLeftKnee, eGameModeParentLeftKneeRoll, eGameModeParentRightHipRoll,
  eGameModeParentRightKnee, eGameModeParentRightKneeRoll, eGameModeParentLeftShoulderRoll, eGameModeParentLeftElbow,
  eGameModeParentLeftElbowRoll, eGameModeParentRightShoulderRoll, eGameModeParentRightElbow, eGameModeParentRightElbowRoll,
  eLeftUpLegRoll, eLeftLegRoll, eRightUpLegRoll, eRightLegRoll,
  eLeftArmRoll, eLeftForeArmRoll, eRightArmRoll, eRightForeArmRoll,
  eLeftHandFloor, eRightHandFloor, eLeftHand, eRightHand,
  eNeck1, eNeck2, eNeck3, eNeck4,
  eNeck5, eNeck6, eNeck7, eNeck8,
  eNeck9, eLeftInHandThumb, eLeftThumbD, eLeftInHandIndex,
  eLeftIndexD, eLeftInHandMiddle, eLeftMiddleD, eLeftInHandRing,
  eLeftRingD, eLeftInHandPinky, eLeftPinkyD, eLeftInHandExtraFinger,
  eLeftExtraFingerA, eLeftExtraFingerB, eLeftExtraFingerC, eLeftExtraFingerD,
  eRightInHandThumb, eRightThumbD, eRightInHandIndex, eRightIndexD,
  eRightInHandMiddle, eRightMiddleD, eRightInHandRing, eRightRingD,
  eRightInHandPinky, eRightPinkyD, eRightInHandExtraFinger, eRightExtraFingerA,
  eRightExtraFingerB, eRightExtraFingerC, eRightExtraFingerD, eLeftInFootThumb,
  eLeftFootThumbA, eLeftFootThumbB, eLeftFootThumbC, eLeftFootThumbD,
  eLeftInFootIndex, eLeftFootIndexA, eLeftFootIndexB, eLeftFootIndexC,
  eLeftFootIndexD, eLeftInFootMiddle, eLeftFootMiddleA, eLeftFootMiddleB,
  eLeftFootMiddleC, eLeftFootMiddleD, eLeftInFootRing, eLeftFootRingA,
  eLeftFootRingB, eLeftFootRingC, eLeftFootRingD, eLeftInFootPinky,
  eLeftFootPinkyA, eLeftFootPinkyB, eLeftFootPinkyC, eLeftFootPinkyD,
  eLeftInFootExtraFinger, eLeftFootExtraFingerA, eLeftFootExtraFingerB, eLeftFootExtraFingerC,
  eLeftFootExtraFingerD, eRightInFootThumb, eRightFootThumbA, eRightFootThumbB,
  eRightFootThumbC, eRightFootThumbD, eRightInFootIndex, eRightFootIndexA,
  eRightFootIndexB, eRightFootIndexC, eRightFootIndexD, eRightInFootMiddle,
  eRightFootMiddleA, eRightFootMiddleB, eRightFootMiddleC, eRightFootMiddleD,
  eRightInFootRing, eRightFootRingA, eRightFootRingB, eRightFootRingC,
  eRightFootRingD, eRightInFootPinky, eRightFootPinkyA, eRightFootPinkyB,
  eRightFootPinkyC, eRightFootPinkyD, eRightInFootExtraFinger, eRightFootExtraFingerA,
  eRightFootExtraFingerB, eRightFootExtraFingerC, eRightFootExtraFingerD, eLeftCollarExtra,
  eRightCollarExtra, eNodeIdCount
}
  Define ID for each character node. More...
enum   EOffAutoUser { eParamModeOff, eParamModeAuto, eParamModeUser }
enum   EAutoUser { eParamModeAuto2, eParamModeUser2 }
enum   EPostureMode { ePostureBiped, ePostureQuadriped, ePostureCount }
enum   EFloorPivot { eFloorPivotAuto, eFloorPivotAnkle, eFloorPivotToes, eFloorPivotCount }
enum   ERollExtractionMode { eRelativeRollExtraction, eAbsoluteRollExtraction, eRollExtractionTypeCount }
enum   EHipsTranslationMode { eHipsTranslationWorldRigid, eHipsTranslationBodyRigid, eHipsTranslationTypeCount }
enum   EFootContactType {
  eFootTypeNormal, eFootTypeAnkle, eFootTypeToeBase, eFootTypeHoof,
  eFootContactModeCount
}
enum   EHandContactType {
  eHandTypeNormal, eHandTypeWrist, eHandTypeFingerBase, eHandTypeHoof,
  eHandContactModeCount
}
enum   EFingerContactMode { eFingerContactModeSticky, eFingerContactModeSpread, eFingerContactModeStickySpread, eFingerContactModeCount }
enum   EContactBehaviour { eContactNeverSync, eContactSyncOnKey, eContactAlwaysSync, eContactBehaviorCount }
enum   EPropertyUnit {
  ePropertyNoUnit, ePropertyPercent, ePropertySecond, ePropertyCentimeter,
  ePropertyDegree, ePropertyEnum, ePropertyReal
}
enum   EErrorCode { eInternalError, eErrorCount }

Public Member Functions

void  Reset ()
  Reset to default values.
void  SetInput (EInputType pInputType, FbxObject *pInputObject=NULL)
  Set input type and index.
EInputType  GetInputType () const
  Get input type.
FbxObject GetInputObject () const
  Get input actor or character.
bool  SetCharacterLink (ENodeId pCharacterNodeId, const FbxCharacterLink &pCharacterLink, bool pUpdateObjectList=true)
  Associate a character link to a given character node ID.
bool  GetCharacterLink (ENodeId pCharacterNodeId, FbxCharacterLink *pCharacterLink=NULL) const
  Get a character link associated with a given character node ID.
FbxControlSet GetControlSet () const
  Get control set associated with the character.

Static Public Member Functions

static int  GetCharacterGroupCount (EGroupId pCharacterGroupId)
  Get number of elements in a given character group.
static ENodeId  GetCharacterGroupElementByIndex (EGroupId pCharacterGroupId, int pIndex)
  Get character node ID of an element in a given character group.
static char *  GetCharacterGroupNameByIndex (EGroupId pCharacterGroupId, int pIndex)
  Get character node name of an element in a given character group.
static int  GetCharacterGroupVersionByIndex (EGroupId pCharacterGroupId, int pIndex)
  Get character node version of an element in a given character group.
static bool  FindCharacterGroupIndexByName (const char *pName, bool pForceGroupId, EGroupId &pCharacterGroupId, int &pIndex)
  Find the character group index associated with a given character node name.
static bool  GetCharacterGroupIndexByElement (ENodeId pCharacterNodeId, EGroupId &pCharacterGroupId, int &pIndex)
  Get character node group and index of a given character node ID.
static bool  GetCharacterGroupVersionByElement (ENodeId pCharacterNodeId, int &pVersion)
  Get character node version of a given character node ID.
static bool  GetCharacterNodeNameFromNodeId (ENodeId pCharacterNodeId, char *&pName)
  Get character node name associated with a given character node ID.
static bool  GetCharacterNodeIdFromNodeName (const char *pName, ENodeId &pCharacterNodeId)
  Get the character node ID associated with a given character node name.

Public Attributes

FbxPropertyT< FbxInt PullIterationCount
FbxPropertyT< EPostureMode Posture
FbxPropertyT< FbxBool ForceActorSpace
FbxPropertyT< FbxDouble ScaleCompensation
FbxPropertyT< EOffAutoUser ScaleCompensationMode
FbxPropertyT< FbxDouble HipsHeightCompensation
FbxPropertyT< EOffAutoUser HipsHeightCompensationMode
FbxPropertyT< FbxDouble AnkleHeightCompensation
FbxPropertyT< EOffAutoUser AnkleHeightCompensationMode
FbxPropertyT< FbxDouble AnkleProximityCompensation
FbxPropertyT< EOffAutoUser AnkleProximityCompensationMode
FbxPropertyT< FbxDouble MassCenterCompensation
FbxPropertyT< FbxBool ApplyLimits
FbxPropertyT< FbxDouble ChestReduction
FbxPropertyT< FbxDouble CollarReduction
FbxPropertyT< FbxDouble NeckReduction
FbxPropertyT< FbxDouble HeadReduction
FbxPropertyT< FbxDouble ReachActorLeftAnkle
FbxPropertyT< FbxDouble ReachActorRightAnkle
FbxPropertyT< FbxDouble ReachActorLeftKnee
FbxPropertyT< FbxDouble ReachActorRightKnee
FbxPropertyT< FbxDouble ReachActorChest
FbxPropertyT< FbxDouble ReachActorHead
FbxPropertyT< FbxDouble ReachActorLeftWrist
FbxPropertyT< FbxDouble ReachActorRightWrist
FbxPropertyT< FbxDouble ReachActorLeftElbow
FbxPropertyT< FbxDouble ReachActorRightElbow
FbxPropertyT< FbxDouble ReachActorLeftFingerBase
FbxPropertyT< FbxDouble ReachActorRightFingerBase
FbxPropertyT< FbxDouble ReachActorLeftToesBase
FbxPropertyT< FbxDouble ReachActorRightToesBase
FbxPropertyT< FbxDouble ReachActorLeftFingerBaseRotation
FbxPropertyT< FbxDouble ReachActorRightFingerBaseRotation
FbxPropertyT< FbxDouble ReachActorLeftToesBaseRotation
FbxPropertyT< FbxDouble ReachActorRightToesBaseRotation
FbxPropertyT< FbxDouble ReachActorLeftAnkleRotation
FbxPropertyT< FbxDouble ReachActorRightAnkleRotation
FbxPropertyT< FbxDouble ReachActorHeadRotation
FbxPropertyT< FbxDouble ReachActorLeftWristRotation
FbxPropertyT< FbxDouble ReachActorRightWristRotation
FbxPropertyT< FbxDouble ReachActorChestRotation
FbxPropertyT< FbxDouble ReachActorLowerChestRotation
FbxPropertyT< FbxDouble3 HipsTOffset
FbxPropertyT< FbxDouble3 ChestTOffset
FbxPropertyT< ERollExtractionMode RollExtractionMode
FbxPropertyT< FbxDouble LeftUpLegRoll
FbxPropertyT< FbxBool LeftUpLegRollMode
FbxPropertyT< FbxDouble LeftLegRoll
FbxPropertyT< FbxBool LeftLegRollMode
FbxPropertyT< FbxDouble RightUpLegRoll
FbxPropertyT< FbxBool RightUpLegRollMode
FbxPropertyT< FbxDouble RightLegRoll
FbxPropertyT< FbxBool RightLegRollMode
FbxPropertyT< FbxDouble LeftArmRoll
FbxPropertyT< FbxBool LeftArmRollMode
FbxPropertyT< FbxDouble LeftForeArmRoll
FbxPropertyT< FbxBool LeftForeArmRollMode
FbxPropertyT< FbxDouble RightArmRoll
FbxPropertyT< FbxBool RightArmRollMode
FbxPropertyT< FbxDouble RightForeArmRoll
FbxPropertyT< FbxBool RightForeArmRollMode
FbxPropertyT< FbxDouble LeftUpLegRollEx
FbxPropertyT< FbxBool LeftUpLegRollExMode
FbxPropertyT< FbxDouble LeftLegRollEx
FbxPropertyT< FbxBool LeftLegRollExMode
FbxPropertyT< FbxDouble RightUpLegRollEx
FbxPropertyT< FbxBool RightUpLegRollExMode
FbxPropertyT< FbxDouble RightLegRollEx
FbxPropertyT< FbxBool RightLegRollExMode
FbxPropertyT< FbxDouble LeftArmRollEx
FbxPropertyT< FbxBool LeftArmRollExMode
FbxPropertyT< FbxDouble LeftForeArmRollEx
FbxPropertyT< FbxBool LeftForeArmRollExMode
FbxPropertyT< FbxDouble RightArmRollEx
FbxPropertyT< FbxBool RightArmRollExMode
FbxPropertyT< FbxDouble RightForeArmExRoll
FbxPropertyT< FbxBool RightForeArmRollExMode
FbxPropertyT< EContactBehaviour ContactBehaviour
FbxPropertyT< FbxBool FootFloorContact
FbxPropertyT< FbxBool FootAutomaticToes
FbxPropertyT< EFloorPivot FootFloorPivot
FbxPropertyT< FbxDouble FootBottomToAnkle
FbxPropertyT< FbxDouble FootBackToAnkle
FbxPropertyT< FbxDouble FootMiddleToAnkle
FbxPropertyT< FbxDouble FootFrontToMiddle
FbxPropertyT< FbxDouble FootInToAnkle
FbxPropertyT< FbxDouble FootOutToAnkle
FbxPropertyT< FbxDouble FootContactSize
FbxPropertyT< FbxBool FootFingerContact
FbxPropertyT< EFootContactType FootContactType
FbxPropertyT< EFingerContactMode FootFingerContactMode
FbxPropertyT< FbxDouble FootContactStiffness
FbxPropertyT< FbxDouble FootFingerContactRollStiffness
FbxPropertyT< FbxBool HandFloorContact
FbxPropertyT< FbxBool HandAutomaticFingers
FbxPropertyT< EFloorPivot HandFloorPivot
FbxPropertyT< FbxDouble HandBottomToWrist
FbxPropertyT< FbxDouble HandBackToWrist
FbxPropertyT< FbxDouble HandMiddleToWrist
FbxPropertyT< FbxDouble HandFrontToMiddle
FbxPropertyT< FbxDouble HandInToWrist
FbxPropertyT< FbxDouble HandOutToWrist
FbxPropertyT< FbxDouble HandContactSize
FbxPropertyT< FbxBool HandFingerContact
FbxPropertyT< EHandContactType HandContactType
FbxPropertyT< EFingerContactMode HandFingerContactMode
FbxPropertyT< FbxDouble HandContactStiffness
FbxPropertyT< FbxDouble HandFingerContactRollStiffness
FbxPropertyT< FbxDouble LeftHandThumbTip
FbxPropertyT< FbxDouble LeftHandIndexTip
FbxPropertyT< FbxDouble LeftHandMiddleTip
FbxPropertyT< FbxDouble LeftHandRingTip
FbxPropertyT< FbxDouble LeftHandPinkyTip
FbxPropertyT< FbxDouble LeftHandExtraFingerTip
FbxPropertyT< FbxDouble RightHandThumbTip
FbxPropertyT< FbxDouble RightHandIndexTip
FbxPropertyT< FbxDouble RightHandMiddleTip
FbxPropertyT< FbxDouble RightHandRingTip
FbxPropertyT< FbxDouble RightHandPinkyTip
FbxPropertyT< FbxDouble RightHandExtraFingerTip
FbxPropertyT< FbxDouble LeftFootThumbTip
FbxPropertyT< FbxDouble LeftFootIndexTip
FbxPropertyT< FbxDouble LeftFootMiddleTip
FbxPropertyT< FbxDouble LeftFootRingTip
FbxPropertyT< FbxDouble LeftFootPinkyTip
FbxPropertyT< FbxDouble LeftFootExtraFingerTip
FbxPropertyT< FbxDouble RightFootThumbTip
FbxPropertyT< FbxDouble RightFootIndexTip
FbxPropertyT< FbxDouble RightFootMiddleTip
FbxPropertyT< FbxDouble RightFootRingTip
FbxPropertyT< FbxDouble RightFootPinkyTip
FbxPropertyT< FbxDouble RightFootExtraFingerTip
FbxPropertyT< FbxBool FingerSolving
FbxPropertyT< FbxDouble CtrlPullLeftToeBase
FbxPropertyT< FbxDouble CtrlPullLeftFoot
FbxPropertyT< FbxDouble CtrlPullLeftKnee
FbxPropertyT< FbxDouble CtrlPullRightToeBase
FbxPropertyT< FbxDouble CtrlPullRightFoot
FbxPropertyT< FbxDouble CtrlPullRightKnee
FbxPropertyT< FbxDouble CtrlPullLeftFingerBase
FbxPropertyT< FbxDouble CtrlPullLeftHand
FbxPropertyT< FbxDouble CtrlPullLeftElbow
FbxPropertyT< FbxDouble CtrlPullRightFingerBase
FbxPropertyT< FbxDouble CtrlPullRightHand
FbxPropertyT< FbxDouble CtrlPullRightElbow
FbxPropertyT< FbxDouble CtrlChestPullLeftHand
FbxPropertyT< FbxDouble CtrlChestPullRightHand
FbxPropertyT< FbxDouble CtrlPullHead
FbxPropertyT< FbxDouble CtrlResistHipsPosition
FbxPropertyT< FbxDouble CtrlEnforceGravity
FbxPropertyT< FbxDouble CtrlResistHipsOrientation
FbxPropertyT< FbxDouble CtrlResistChestPosition
FbxPropertyT< FbxDouble CtrlResistChestOrientation
FbxPropertyT< FbxDouble CtrlResistLeftCollar
FbxPropertyT< FbxDouble CtrlResistRightCollar
FbxPropertyT< FbxDouble CtrlResistLeftKnee
FbxPropertyT< FbxDouble CtrlResistMaximumExtensionLeftKnee
FbxPropertyT< FbxDouble CtrlResistCompressionFactorLeftKnee
FbxPropertyT< FbxDouble CtrlResistRightKnee
FbxPropertyT< FbxDouble CtrlResistMaximumExtensionRightKnee
FbxPropertyT< FbxDouble CtrlResistCompressionFactorRightKnee
FbxPropertyT< FbxDouble CtrlResistLeftElbow
FbxPropertyT< FbxDouble CtrlResistMaximumExtensionLeftElbow
FbxPropertyT< FbxDouble CtrlResistCompressionFactorLeftElbow
FbxPropertyT< FbxDouble CtrlResistRightElbow
FbxPropertyT< FbxDouble CtrlResistMaximumExtensionRightElbow
FbxPropertyT< FbxDouble CtrlResistCompressionFactorRightElbow
FbxPropertyT< FbxDouble CtrlSpineStiffness
FbxPropertyT< FbxDouble CtrlNeckStiffness
FbxPropertyT< FbxBool MirrorMode
FbxPropertyT< FbxDouble ShoulderCorrection
FbxPropertyT< FbxBool LeftKneeKillPitch
FbxPropertyT< FbxBool RightKneeKillPitch
FbxPropertyT< FbxBool LeftElbowKillPitch
FbxPropertyT< FbxBool RightElbowKillPitch
FbxPropertyT
< EHipsTranslationMode
HipsTranslationMode
FbxPropertyT< FbxBool WriteReference
FbxPropertyT< FbxBool SyncMode
FbxPropertyT< FbxDouble Damping
FbxPropertyT< FbxDouble OrientationDamping
FbxPropertyT< EOffAutoUser OrientationDampingMode
FbxPropertyT< FbxDouble DisplacementDamping
FbxPropertyT< EOffAutoUser DisplacementDampingMode
FbxPropertyT< FbxDouble DisplacementMemory
FbxPropertyT< EAutoUser DisplacementMemoryMode
FbxPropertyT< FbxDouble HipsDisplacementDamping
FbxPropertyT< EAutoUser HipsDisplacementDampingMode
FbxPropertyT< FbxDouble AnkleDisplacementDamping
FbxPropertyT< EAutoUser AnkleDisplacementDampingMode
FbxPropertyT< FbxDouble WristDisplacementDamping
FbxPropertyT< EAutoUser WristDisplacementDampingMode
FbxPropertyT< FbxDouble Stabilization
FbxPropertyT< FbxDouble AnkleStabilizationTime
FbxPropertyT< EAutoUser AnkleStabilizationTimeMode
FbxPropertyT< FbxDouble AnkleStabilizationPerimeter
FbxPropertyT< EAutoUser AnkleStabilizationPerimeterMode
FbxPropertyT< FbxDouble AnkleStabilizationAngularPerimeter
FbxPropertyT< EOffAutoUser AnkleStabilizationAngularPerimeterMode
FbxPropertyT< FbxDouble AnkleStabilizationFloorProximity
FbxPropertyT< EOffAutoUser AnkleStabilizationFloorProximityMode
FbxPropertyT< FbxDouble AnkleStabilizationDamping
FbxPropertyT< EOffAutoUser AnkleStabilizationDampingMode
FbxPropertyT< FbxDouble AnkleStabilizationRecoveryTime
FbxPropertyT< EOffAutoUser AnkleStabilizationRecoveryTimeMode
FbxPropertyT< FbxReference SourceObject
FbxPropertyT< FbxReference DestinationObject
FbxPropertyT< FbxReference Actor
FbxPropertyT< FbxReference Character
FbxPropertyT< FbxReference ControlSet
FbxPropertyT< FbxDouble HikVersion
FbxPropertyT< FbxBool Characterize
FbxPropertyT< FbxBool LockXForm
FbxPropertyT< FbxBool LockPick
FbxPropertyT< FbxDouble RealisticShoulder
FbxPropertyT< FbxDouble CollarStiffnessX
FbxPropertyT< FbxDouble CollarStiffnessY
FbxPropertyT< FbxDouble CollarStiffnessZ
FbxPropertyT< FbxDouble ExtraCollarRatio
FbxPropertyT< FbxDouble LeftLegMaxExtensionAngle
FbxPropertyT< FbxDouble RightLegMaxExtensionAngle
FbxPropertyT< FbxDouble LeftArmMaxExtensionAngle
FbxPropertyT< FbxDouble RightArmMaxExtensionAngle
FbxPropertyT< FbxDouble StretchStartArmsAndLegs
FbxPropertyT< FbxDouble StretchStopArmsAndLegs
FbxPropertyT< FbxDouble SnSScaleArmsAndLegs
FbxPropertyT< FbxDouble SnSReachLeftWrist
FbxPropertyT< FbxDouble SnSReachRightWrist
FbxPropertyT< FbxDouble SnSReachLeftAnkle
FbxPropertyT< FbxDouble SnSReachRightAnkle
FbxPropertyT< FbxDouble SnSScaleSpine
FbxPropertyT< FbxDouble SnSScaleSpineChildren
FbxPropertyT< FbxDouble SnSSpineFreedom
FbxPropertyT< FbxDouble SnSReachChestEnd
FbxPropertyT< FbxDouble SnSScaleNeck
FbxPropertyT< FbxDouble SnSNeckFreedom
FbxPropertyT< FbxDouble SnSReachHead

Member Enumeration Documentation

enum EInputType

Character input type.

  • eInputActor Not supported.
  • eInputCharacter The character's input is another character.
  • eInputMarkerSet The character's input is a control rig.
  • eOutputMarkerSet Not supported.
  • eInputStancePose The character's input is the stance pose.
Enumerator:
eInputActor 
eInputCharacter 
eInputMarkerSet 
eOutputMarkerSet 
eInputStancePose 

Definition at line 103 of file fbxcharacter.h.

enum ENodeId

Define ID for each character node.

Enumerator:
eHips 
eLeftHip 
eLeftKnee 
eLeftAnkle 
eLeftFoot 
eRightHip 
eRightKnee 
eRightAnkle 
eRightFoot 
eWaist 
eChest 
eLeftCollar 
eLeftShoulder 
eLeftElbow 
eLeftWrist 
eRightCollar 
eRightShoulder 
eRightElbow 
eRightWrist 
eNeck 
eHead 
eLeftHipRoll 
eLeftKneeRoll 
eRightHipRoll 
eRightKneeRoll 
eLeftShoulderRoll 
eLeftElbowRoll 
eRightShoulderRoll 
eRightElbowRoll 
eSpine2 
eSpine3 
eSpine4 
eSpine5 
eSpine6 
eSpine7 
eSpine8 
eSpine9 
eLeftThumbA 
eLeftThumbB 
eLeftThumbC 
eLeftIndexA 
eLeftIndexB 
eLeftIndexC 
eLeftMiddleA 
eLeftMiddleB 
eLeftMiddleC 
eLeftRingA 
eLeftRingB 
eLeftRingC 
eLeftPinkyA 
eLeftPinkyB 
eLeftPinkyC 
eRightThumbA 
eRightThumbB 
eRightThumbC 
eRightIndexA 
eRightIndexB 
eRightIndexC 
eRightMiddleA 
eRightMiddleB 
eRightMiddleC 
eRightRingA 
eRightRingB 
eRightRingC 
eRightPinkyA 
eRightPinkyB 
eRightPinkyC 
eReference 
eLeftFloor 
eRightFloor 
eHipsTranslation 
eProps0 
eProps1 
eProps2 
eProps3 
eProps4 
eGameModeParentLeftHipRoll 
eGameModeParentLeftKnee 
eGameModeParentLeftKneeRoll 
eGameModeParentRightHipRoll 
eGameModeParentRightKnee 
eGameModeParentRightKneeRoll 
eGameModeParentLeftShoulderRoll 
eGameModeParentLeftElbow 
eGameModeParentLeftElbowRoll 
eGameModeParentRightShoulderRoll 
eGameModeParentRightElbow 
eGameModeParentRightElbowRoll 
eLeftUpLegRoll 
eLeftLegRoll 
eRightUpLegRoll 
eRightLegRoll 
eLeftArmRoll 
eLeftForeArmRoll 
eRightArmRoll 
eRightForeArmRoll 
eLeftHandFloor 
eRightHandFloor 
eLeftHand 
eRightHand 
eNeck1 
eNeck2 
eNeck3 
eNeck4 
eNeck5 
eNeck6 
eNeck7 
eNeck8 
eNeck9 
eLeftInHandThumb 
eLeftThumbD 
eLeftInHandIndex 
eLeftIndexD 
eLeftInHandMiddle 
eLeftMiddleD 
eLeftInHandRing 
eLeftRingD 
eLeftInHandPinky 
eLeftPinkyD 
eLeftInHandExtraFinger 
eLeftExtraFingerA 
eLeftExtraFingerB 
eLeftExtraFingerC 
eLeftExtraFingerD 
eRightInHandThumb 
eRightThumbD 
eRightInHandIndex 
eRightIndexD 
eRightInHandMiddle 
eRightMiddleD 
eRightInHandRing 
eRightRingD 
eRightInHandPinky 
eRightPinkyD 
eRightInHandExtraFinger 
eRightExtraFingerA 
eRightExtraFingerB 
eRightExtraFingerC 
eRightExtraFingerD 
eLeftInFootThumb 
eLeftFootThumbA 
eLeftFootThumbB 
eLeftFootThumbC 
eLeftFootThumbD 
eLeftInFootIndex 
eLeftFootIndexA 
eLeftFootIndexB 
eLeftFootIndexC 
eLeftFootIndexD 
eLeftInFootMiddle 
eLeftFootMiddleA 
eLeftFootMiddleB 
eLeftFootMiddleC 
eLeftFootMiddleD 
eLeftInFootRing 
eLeftFootRingA 
eLeftFootRingB 
eLeftFootRingC 
eLeftFootRingD 
eLeftInFootPinky 
eLeftFootPinkyA 
eLeftFootPinkyB 
eLeftFootPinkyC 
eLeftFootPinkyD 
eLeftInFootExtraFinger 
eLeftFootExtraFingerA 
eLeftFootExtraFingerB 
eLeftFootExtraFingerC 
eLeftFootExtraFingerD 
eRightInFootThumb 
eRightFootThumbA 
eRightFootThumbB 
eRightFootThumbC 
eRightFootThumbD 
eRightInFootIndex 
eRightFootIndexA 
eRightFootIndexB 
eRightFootIndexC 
eRightFootIndexD 
eRightInFootMiddle 
eRightFootMiddleA 
eRightFootMiddleB 
eRightFootMiddleC 
eRightFootMiddleD 
eRightInFootRing 
eRightFootRingA 
eRightFootRingB 
eRightFootRingC 
eRightFootRingD 
eRightInFootPinky 
eRightFootPinkyA 
eRightFootPinkyB 
eRightFootPinkyC 
eRightFootPinkyD 
eRightInFootExtraFinger 
eRightFootExtraFingerA 
eRightFootExtraFingerB 
eRightFootExtraFingerC 
eRightFootExtraFingerD 
eLeftCollarExtra 
eRightCollarExtra 
eNodeIdCount 
Examples:
ImportScene/DisplayPose.cxx.

Definition at line 133 of file fbxcharacter.h.

        {       
                eHips,
                eLeftHip,
                eLeftKnee,
                eLeftAnkle,
                eLeftFoot,
                eRightHip,
                eRightKnee,
                eRightAnkle,
                eRightFoot,
                eWaist,
                eChest,
                eLeftCollar,
                eLeftShoulder,
                eLeftElbow,
                eLeftWrist,
                eRightCollar,
                eRightShoulder,
                eRightElbow,
                eRightWrist,
                eNeck,
                eHead,
                eLeftHipRoll,
                eLeftKneeRoll,
                eRightHipRoll,
                eRightKneeRoll,
                eLeftShoulderRoll,
                eLeftElbowRoll,
                eRightShoulderRoll,
                eRightElbowRoll,
                eSpine2,
                eSpine3,
                eSpine4,
                eSpine5,
                eSpine6,
                eSpine7,
                eSpine8,
                eSpine9,
                eLeftThumbA,
                eLeftThumbB,
                eLeftThumbC,
                eLeftIndexA,
                eLeftIndexB,
                eLeftIndexC,
                eLeftMiddleA,
                eLeftMiddleB,
                eLeftMiddleC,
                eLeftRingA,
                eLeftRingB,
                eLeftRingC,
                eLeftPinkyA,
                eLeftPinkyB,
                eLeftPinkyC,
                eRightThumbA,
                eRightThumbB,
                eRightThumbC,
                eRightIndexA,
                eRightIndexB,
                eRightIndexC,
                eRightMiddleA,
                eRightMiddleB,
                eRightMiddleC,
                eRightRingA,
                eRightRingB,
                eRightRingC,
                eRightPinkyA,
                eRightPinkyB,
                eRightPinkyC,
                eReference,
                eLeftFloor,
                eRightFloor,
                eHipsTranslation,
                eProps0,
                eProps1,
                eProps2,
                eProps3,
                eProps4,
                eGameModeParentLeftHipRoll,
                eGameModeParentLeftKnee,
                eGameModeParentLeftKneeRoll,
                eGameModeParentRightHipRoll,
                eGameModeParentRightKnee,
                eGameModeParentRightKneeRoll,
                eGameModeParentLeftShoulderRoll,       
                eGameModeParentLeftElbow,      
                eGameModeParentLeftElbowRoll,  
                eGameModeParentRightShoulderRoll,
                eGameModeParentRightElbow,             
                eGameModeParentRightElbowRoll, 
                eLeftUpLegRoll,
                eLeftLegRoll,
                eRightUpLegRoll,
                eRightLegRoll,
                eLeftArmRoll,
                eLeftForeArmRoll,
                eRightArmRoll,
                eRightForeArmRoll,
                eLeftHandFloor,
                eRightHandFloor,
                eLeftHand,
                eRightHand,
                eNeck1,
                eNeck2,
                eNeck3,
                eNeck4,
                eNeck5,
                eNeck6,
                eNeck7,
                eNeck8,
                eNeck9,
                eLeftInHandThumb,
                eLeftThumbD,
                eLeftInHandIndex,
                eLeftIndexD,
                eLeftInHandMiddle,
                eLeftMiddleD,
                eLeftInHandRing,
                eLeftRingD,
                eLeftInHandPinky,
                eLeftPinkyD,
                eLeftInHandExtraFinger,
                eLeftExtraFingerA,
                eLeftExtraFingerB,
                eLeftExtraFingerC,
                eLeftExtraFingerD,
                eRightInHandThumb,
                eRightThumbD,
                eRightInHandIndex,
                eRightIndexD,
                eRightInHandMiddle,
                eRightMiddleD,
                eRightInHandRing,
                eRightRingD,
                eRightInHandPinky,
                eRightPinkyD,
                eRightInHandExtraFinger,
                eRightExtraFingerA,
                eRightExtraFingerB,
                eRightExtraFingerC,
                eRightExtraFingerD,
                eLeftInFootThumb,
                eLeftFootThumbA,
                eLeftFootThumbB,
                eLeftFootThumbC,
                eLeftFootThumbD,
                eLeftInFootIndex,
                eLeftFootIndexA,
                eLeftFootIndexB,
                eLeftFootIndexC,
                eLeftFootIndexD,
                eLeftInFootMiddle,
                eLeftFootMiddleA,
                eLeftFootMiddleB,
                eLeftFootMiddleC,
                eLeftFootMiddleD,
                eLeftInFootRing,
                eLeftFootRingA,
                eLeftFootRingB,
                eLeftFootRingC,
                eLeftFootRingD,
                eLeftInFootPinky,
                eLeftFootPinkyA,
                eLeftFootPinkyB,
                eLeftFootPinkyC,
                eLeftFootPinkyD,
                eLeftInFootExtraFinger,
                eLeftFootExtraFingerA,
                eLeftFootExtraFingerB,
                eLeftFootExtraFingerC,
                eLeftFootExtraFingerD,
                eRightInFootThumb,
                eRightFootThumbA,
                eRightFootThumbB,
                eRightFootThumbC,
                eRightFootThumbD,
                eRightInFootIndex,
                eRightFootIndexA,
                eRightFootIndexB,
                eRightFootIndexC,
                eRightFootIndexD,
                eRightInFootMiddle,
                eRightFootMiddleA,
                eRightFootMiddleB,
                eRightFootMiddleC,
                eRightFootMiddleD,
                eRightInFootRing,
                eRightFootRingA,
                eRightFootRingB,
                eRightFootRingC,
                eRightFootRingD,
                eRightInFootPinky,
                eRightFootPinkyA,
                eRightFootPinkyB,
                eRightFootPinkyC,
                eRightFootPinkyD,
                eRightInFootExtraFinger,
                eRightFootExtraFingerA,
                eRightFootExtraFingerB,
                eRightFootExtraFingerC,
                eRightFootExtraFingerD,
                eLeftCollarExtra,
                eRightCollarExtra,
                eNodeIdCount
        };
enum EAutoUser
Enumerator:
eParamModeAuto2 
eParamModeUser2 

Definition at line 346 of file fbxcharacter.h.

enum EErrorCode
Enumerator:
eInternalError 
eErrorCount 

Definition at line 426 of file fbxcharacter.h.


Member Function Documentation

void Reset ( )

Reset to default values.

  • Input type will be set to eInputStancePose.
  • Input object will be set to NULL.
  • Each Character link will be reset.
  • The control set will be reset.
void SetInput ( EInputType  pInputType,
FbxObject pInputObject = NULL 
)

Set input type and index.

Parameters:
pInputType Input type.
pInputObject Pointer to input character if input type equals eInputCharacter, otherwise NULL.
EInputType GetInputType ( ) const

Get input type.

FbxObject* GetInputObject ( ) const

Get input actor or character.

Returns:
Pointer or Null, depending on the input type.
  • If the input type is set to eInputCharacter. The returned pointer can be casted to a pointer of type FbxCharacter.
  • Null pointer if the input object has not been set, or if the input type is not set to eInputCharacter.
bool SetCharacterLink ( ENodeId  pCharacterNodeId,
const FbxCharacterLink pCharacterLink,
bool  pUpdateObjectList = true 
)

Associate a character link to a given character node ID.

If a character link already exists for this character node ID, the character link will be removed.

Parameters:
pCharacterNodeId Character node ID.
pCharacterLink Character link.
pUpdateObjectList Set to true to update the object list (default value).
Returns:
true if successful, false otherwise.
bool GetCharacterLink ( ENodeId  pCharacterNodeId,
FbxCharacterLink pCharacterLink = NULL 
) const

Get a character link associated with a given character node ID.

Parameters:
pCharacterNodeId ID of character node requested.
pCharacterLink Optional pointer to receive the character link if function succeeds.
Returns:
true if successful, false otherwise.
Examples:
ImportScene/DisplayPose.cxx.
FbxControlSet& GetControlSet ( ) const

Get control set associated with the character.

Returns:
Return the control set associated with the character.
static int GetCharacterGroupCount ( EGroupId  pCharacterGroupId ) [static]

Get number of elements in a given character group.

Parameters:
pCharacterGroupId Character group ID.
Returns:
The number of elements in the pCharacterGroupId character group.
static ENodeId GetCharacterGroupElementByIndex ( EGroupId  pCharacterGroupId,
int  pIndex 
) [static]

Get character node ID of an element in a given character group.

Parameters:
pCharacterGroupId Character group ID.
pIndex Character index ID.
Returns:
Character node ID.
static char* GetCharacterGroupNameByIndex ( EGroupId  pCharacterGroupId,
int  pIndex 
) [static]

Get character node name of an element in a given character group.

Parameters:
pCharacterGroupId Character group ID.
pIndex Character index ID.
Returns:
Character node name.
static int GetCharacterGroupVersionByIndex ( EGroupId  pCharacterGroupId,
int  pIndex 
) [static]

Get character node version of an element in a given character group.

Parameters:
pCharacterGroupId Character group ID.
pIndex Character index ID.
Returns:
Character node version.
static bool FindCharacterGroupIndexByName ( const char *  pName,
bool  pForceGroupId,
EGroupId pCharacterGroupId,
int &  pIndex 
) [static]

Find the character group index associated with a given character node name.

Parameters:
pName Character node name.
pForceGroupId Set to true to force the character group ID.
pCharacterGroupId Receives character group ID.
pIndex Receives character index ID.
Returns:
true if successful, otherwise false.
static bool GetCharacterGroupIndexByElement ( ENodeId  pCharacterNodeId,
EGroupId pCharacterGroupId,
int &  pIndex 
) [static]

Get character node group and index of a given character node ID.

Parameters:
pCharacterNodeId Character node ID.
pCharacterGroupId if the Character node ID is found, the method returns the group ID through this parameter
pIndex if the Character node ID is found, the method returns the index through this parameter
Remarks:
Only works for a character node ID that is part of a group.
Returns:
true if successful, false otherwise.
static bool GetCharacterGroupVersionByElement ( ENodeId  pCharacterNodeId,
int &  pVersion 
) [static]

Get character node version of a given character node ID.

Parameters:
pCharacterNodeId Character node ID to get version.
pVersion if the node ID is found, the method returns the version through this parameter
Remarks:
Only works for a character node ID is part of a group.
Returns:
true if successful, false otherwise.
static bool GetCharacterNodeNameFromNodeId ( ENodeId  pCharacterNodeId,
char *&  pName 
) [static]

Get character node name associated with a given character node ID.

Parameters:
pCharacterNodeId Character node ID to get name.
pName if the node ID is found, the method returns the node name through this parameter Since the Pointer points to internal data, it is not necessary to allocate a string buffer before calling this function.
Returns:
true if a name exists for the given node ID.
static bool GetCharacterNodeIdFromNodeName ( const char *  pName,
ENodeId pCharacterNodeId 
) [static]

Get the character node ID associated with a given character node name.

Parameters:
pName Character node name to get node ID.
pCharacterNodeId if the node name is found, this method returns the node ID through this parameter
Returns:
true if a node ID exists for the given node name.

Member Data Documentation


The documentation for this class was generated from the following file: