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

Detailed Description

Character is 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 KFbxCharacterLink, KFbxControlSet

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

See also:: KFbxCharacterLink, KFbxControlSet

Examples:: ImportScene/DisplayPose.cxx.

Definition at line 420 of file kfbxcharacter.h.

#include <kfbxcharacter.h>

Inheritance diagram for KFbxCharacter:

[legend]

List of all members.

Public Types
enum	EError { eINTERNAL_ERROR, eERROR_COUNT }
	Error identifiers. More...
Public Member Functions
void	Reset ()
	Reset to default values.
void	SetInput (ECharacterInputType pInputType, KFbxObject *pInputObject=NULL)
	Set input type and index.
ECharacterInputType	GetInputType () const
	Get input type.
KFbxObject *	GetInputObject () const
	Get input actor or character.
bool	SetCharacterLink (ECharacterNodeId pCharacterNodeId, const KFbxCharacterLink &pCharacterLink, bool pUpdateObjectList=true)
	Associate a character link to a given character node ID.
bool	GetCharacterLink (ECharacterNodeId pCharacterNodeId, KFbxCharacterLink *pCharacterLink=NULL) const
	Get a character link associated with a given character node ID.
KFbxControlSet &	GetControlSet () const
	Get control set associated with the character.
virtual KFbxObject &	Copy (const KFbxObject &pObject)
	Copy an object content into this object.
	KFbxCharacter (KFbxSdkManager &pManager, char const *pName)
virtual void	Construct (const KFbxCharacter *pFrom)
virtual void	Destruct (bool pRecursive, bool pDependents)
virtual EConstraintType	GetConstraintType () const
	Access the type of the constraint.
virtual KStringList	GetTypeFlags () const
virtual bool	ConnecNotify (KFbxConnectEvent const &pEvent)
const void	GetKFbxCharacterPropertyFromHIKProperty (char &pKFbxCharacterPropertyName, char &pKFbxCharacterPropertyModeName, kCharacterPropertyUnit &pUnit, int &pPropertyIndex, const char *pHIKPropertyName) const
const void	GetHIKPropertyFromKFbxCharacterProperty (char &pHIKPropertyName, kCharacterPropertyUnit &pUnit, const char pKFbxCharacterPropertyName) const
const void	GetPropertyInfo (char &pKFbxCharacterPropertyName, char &pKFbxCharacterPropertyModeName, kCharacterPropertyUnit &pUnit, int &pPropertyIndex, char *&pHIKPropertyName, int pIndex) const
int	GetPropertyInfoCount ()
Static Public Member Functions
static int	GetCharacterGroupCount (ECharacterGroupId pCharacterGroupId)
	Get number of elements in a given character group.
static ECharacterNodeId	GetCharacterGroupElementByIndex (ECharacterGroupId pCharacterGroupId, int pIndex)
	Get character node ID of an element in a given character group.
static char *	GetCharacterGroupNameByIndex (ECharacterGroupId pCharacterGroupId, int pIndex)
	Get character node name of an element in a given character group.
static int	GetCharacterGroupVersionByIndex (ECharacterGroupId pCharacterGroupId, int pIndex)
	Get character node version of an element in a given character group.
static bool	FindCharacterGroupIndexByName (const char *pName, bool pForceGroupId, ECharacterGroupId &pCharacterGroupId, int &pIndex)
	Find the character group index associated with a given character node name.
static bool	GetCharacterGroupIndexByElement (ECharacterNodeId pCharacterNodeId, ECharacterGroupId &pCharacterGroupId, int &pIndex)
	Get character node group and index of a given character node ID.
static bool	GetCharacterGroupVersionByElement (ECharacterNodeId pCharacterNodeId, int &pVersion)
	Get character node version of a given character node ID.
static bool	GetCharacterNodeNameFromNodeId (ECharacterNodeId pCharacterNodeId, char *&pName)
	Get character node name associated with a given character node ID.
static bool	GetCharacterNodeIdFromNodeName (const char *pName, ECharacterNodeId &pCharacterNodeId)
	Get the character node ID associated with a given character node name.
Public Attributes
KFbxTypedProperty< fbxInteger1 >	PullIterationCount
KFbxTypedProperty < kCharacterPosture >	Posture
KFbxTypedProperty< fbxBool1 >	ForceActorSpace
KFbxTypedProperty< fbxDouble1 >	ScaleCompensation
KFbxTypedProperty < kCharacterOffAutoUser >	ScaleCompensationMode
KFbxTypedProperty< fbxDouble1 >	HipsHeightCompensation
KFbxTypedProperty < kCharacterOffAutoUser >	HipsHeightCompensationMode
KFbxTypedProperty< fbxDouble1 >	AnkleHeightCompensation
KFbxTypedProperty < kCharacterOffAutoUser >	AnkleHeightCompensationMode
KFbxTypedProperty< fbxDouble1 >	AnkleProximityCompensation
KFbxTypedProperty < kCharacterOffAutoUser >	AnkleProximityCompensationMode
KFbxTypedProperty< fbxDouble1 >	MassCenterCompensation
KFbxTypedProperty< fbxBool1 >	ApplyLimits
KFbxTypedProperty< fbxDouble1 >	ChestReduction
KFbxTypedProperty< fbxDouble1 >	CollarReduction
KFbxTypedProperty< fbxDouble1 >	NeckReduction
KFbxTypedProperty< fbxDouble1 >	HeadReduction
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftAnkle
KFbxTypedProperty< fbxDouble1 >	ReachActorRightAnkle
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftKnee
KFbxTypedProperty< fbxDouble1 >	ReachActorRightKnee
KFbxTypedProperty< fbxDouble1 >	ReachActorChest
KFbxTypedProperty< fbxDouble1 >	ReachActorHead
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftWrist
KFbxTypedProperty< fbxDouble1 >	ReachActorRightWrist
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftElbow
KFbxTypedProperty< fbxDouble1 >	ReachActorRightElbow
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftFingerBase
KFbxTypedProperty< fbxDouble1 >	ReachActorRightFingerBase
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftToesBase
KFbxTypedProperty< fbxDouble1 >	ReachActorRightToesBase
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftFingerBaseRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorRightFingerBaseRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftToesBaseRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorRightToesBaseRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftAnkleRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorRightAnkleRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorHeadRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorLeftWristRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorRightWristRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorChestRotation
KFbxTypedProperty< fbxDouble1 >	ReachActorLowerChestRotation
KFbxTypedProperty< fbxDouble3 >	HipsTOffset
KFbxTypedProperty< fbxDouble3 >	ChestTOffset
KFbxTypedProperty < kCharacterRollExtractionMode >	RollExtractionMode
KFbxTypedProperty< fbxDouble1 >	LeftUpLegRoll
KFbxTypedProperty< fbxBool1 >	LeftUpLegRollMode
KFbxTypedProperty< fbxDouble1 >	LeftLegRoll
KFbxTypedProperty< fbxBool1 >	LeftLegRollMode
KFbxTypedProperty< fbxDouble1 >	RightUpLegRoll
KFbxTypedProperty< fbxBool1 >	RightUpLegRollMode
KFbxTypedProperty< fbxDouble1 >	RightLegRoll
KFbxTypedProperty< fbxBool1 >	RightLegRollMode
KFbxTypedProperty< fbxDouble1 >	LeftArmRoll
KFbxTypedProperty< fbxBool1 >	LeftArmRollMode
KFbxTypedProperty< fbxDouble1 >	LeftForeArmRoll
KFbxTypedProperty< fbxBool1 >	LeftForeArmRollMode
KFbxTypedProperty< fbxDouble1 >	RightArmRoll
KFbxTypedProperty< fbxBool1 >	RightArmRollMode
KFbxTypedProperty< fbxDouble1 >	RightForeArmRoll
KFbxTypedProperty< fbxBool1 >	RightForeArmRollMode
KFbxTypedProperty < kCharacterContactBehaviour >	ContactBehaviour
KFbxTypedProperty< fbxBool1 >	FootFloorContact
KFbxTypedProperty< fbxBool1 >	FootAutomaticToes
KFbxTypedProperty < kCharacterFloorPivot >	FootFloorPivot
KFbxTypedProperty< fbxDouble1 >	FootBottomToAnkle
KFbxTypedProperty< fbxDouble1 >	FootBackToAnkle
KFbxTypedProperty< fbxDouble1 >	FootMiddleToAnkle
KFbxTypedProperty< fbxDouble1 >	FootFrontToMiddle
KFbxTypedProperty< fbxDouble1 >	FootInToAnkle
KFbxTypedProperty< fbxDouble1 >	FootOutToAnkle
KFbxTypedProperty< fbxDouble1 >	FootContactSize
KFbxTypedProperty< fbxBool1 >	FootFingerContact
KFbxTypedProperty < kCharacterFootContactType >	FootContactType
KFbxTypedProperty < kCharacterFingerContactMode >	FootFingerContactMode
KFbxTypedProperty< fbxDouble1 >	FootContactStiffness
KFbxTypedProperty< fbxDouble1 >	FootFingerContactRollStiffness
KFbxTypedProperty< fbxBool1 >	HandFloorContact
KFbxTypedProperty< fbxBool1 >	HandAutomaticFingers
KFbxTypedProperty < kCharacterFloorPivot >	HandFloorPivot
KFbxTypedProperty< fbxDouble1 >	HandBottomToWrist
KFbxTypedProperty< fbxDouble1 >	HandBackToWrist
KFbxTypedProperty< fbxDouble1 >	HandMiddleToWrist
KFbxTypedProperty< fbxDouble1 >	HandFrontToMiddle
KFbxTypedProperty< fbxDouble1 >	HandInToWrist
KFbxTypedProperty< fbxDouble1 >	HandOutToWrist
KFbxTypedProperty< fbxDouble1 >	HandContactSize
KFbxTypedProperty< fbxBool1 >	HandFingerContact
KFbxTypedProperty < kCharacterHandContactType >	HandContactType
KFbxTypedProperty < kCharacterFingerContactMode >	HandFingerContactMode
KFbxTypedProperty< fbxDouble1 >	HandContactStiffness
KFbxTypedProperty< fbxDouble1 >	HandFingerContactRollStiffness
KFbxTypedProperty< fbxDouble1 >	LeftHandThumbTip
KFbxTypedProperty< fbxDouble1 >	LeftHandIndexTip
KFbxTypedProperty< fbxDouble1 >	LeftHandMiddleTip
KFbxTypedProperty< fbxDouble1 >	LeftHandRingTip
KFbxTypedProperty< fbxDouble1 >	LeftHandPinkyTip
KFbxTypedProperty< fbxDouble1 >	LeftHandExtraFingerTip
KFbxTypedProperty< fbxDouble1 >	RightHandThumbTip
KFbxTypedProperty< fbxDouble1 >	RightHandIndexTip
KFbxTypedProperty< fbxDouble1 >	RightHandMiddleTip
KFbxTypedProperty< fbxDouble1 >	RightHandRingTip
KFbxTypedProperty< fbxDouble1 >	RightHandPinkyTip
KFbxTypedProperty< fbxDouble1 >	RightHandExtraFingerTip
KFbxTypedProperty< fbxDouble1 >	LeftFootThumbTip
KFbxTypedProperty< fbxDouble1 >	LeftFootIndexTip
KFbxTypedProperty< fbxDouble1 >	LeftFootMiddleTip
KFbxTypedProperty< fbxDouble1 >	LeftFootRingTip
KFbxTypedProperty< fbxDouble1 >	LeftFootPinkyTip
KFbxTypedProperty< fbxDouble1 >	LeftFootExtraFingerTip
KFbxTypedProperty< fbxDouble1 >	RightFootThumbTip
KFbxTypedProperty< fbxDouble1 >	RightFootIndexTip
KFbxTypedProperty< fbxDouble1 >	RightFootMiddleTip
KFbxTypedProperty< fbxDouble1 >	RightFootRingTip
KFbxTypedProperty< fbxDouble1 >	RightFootPinkyTip
KFbxTypedProperty< fbxDouble1 >	RightFootExtraFingerTip
KFbxTypedProperty< fbxBool1 >	FingerSolving
KFbxTypedProperty< fbxDouble1 >	CtrlPullLeftToeBase
KFbxTypedProperty< fbxDouble1 >	CtrlPullLeftFoot
KFbxTypedProperty< fbxDouble1 >	CtrlPullLeftKnee
KFbxTypedProperty< fbxDouble1 >	CtrlPullRightToeBase
KFbxTypedProperty< fbxDouble1 >	CtrlPullRightFoot
KFbxTypedProperty< fbxDouble1 >	CtrlPullRightKnee
KFbxTypedProperty< fbxDouble1 >	CtrlPullLeftFingerBase
KFbxTypedProperty< fbxDouble1 >	CtrlPullLeftHand
KFbxTypedProperty< fbxDouble1 >	CtrlPullLeftElbow
KFbxTypedProperty< fbxDouble1 >	CtrlPullRightFingerBase
KFbxTypedProperty< fbxDouble1 >	CtrlPullRightHand
KFbxTypedProperty< fbxDouble1 >	CtrlPullRightElbow
KFbxTypedProperty< fbxDouble1 >	CtrlChestPullLeftHand
KFbxTypedProperty< fbxDouble1 >	CtrlChestPullRightHand
KFbxTypedProperty< fbxDouble1 >	CtrlPullHead
KFbxTypedProperty< fbxDouble1 >	CtrlResistHipsPosition
KFbxTypedProperty< fbxDouble1 >	CtrlEnforceGravity
KFbxTypedProperty< fbxDouble1 >	CtrlResistHipsOrientation
KFbxTypedProperty< fbxDouble1 >	CtrlResistChestPosition
KFbxTypedProperty< fbxDouble1 >	CtrlResistChestOrientation
KFbxTypedProperty< fbxDouble1 >	CtrlResistLeftCollar
KFbxTypedProperty< fbxDouble1 >	CtrlResistRightCollar
KFbxTypedProperty< fbxDouble1 >	CtrlResistLeftKnee
KFbxTypedProperty< fbxDouble1 >	CtrlResistMaximumExtensionLeftKnee
KFbxTypedProperty< fbxDouble1 >	CtrlResistCompressionFactorLeftKnee
KFbxTypedProperty< fbxDouble1 >	CtrlResistRightKnee
KFbxTypedProperty< fbxDouble1 >	CtrlResistMaximumExtensionRightKnee
KFbxTypedProperty< fbxDouble1 >	CtrlResistCompressionFactorRightKnee
KFbxTypedProperty< fbxDouble1 >	CtrlResistLeftElbow
KFbxTypedProperty< fbxDouble1 >	CtrlResistMaximumExtensionLeftElbow
KFbxTypedProperty< fbxDouble1 >	CtrlResistCompressionFactorLeftElbow
KFbxTypedProperty< fbxDouble1 >	CtrlResistRightElbow
KFbxTypedProperty< fbxDouble1 >	CtrlResistMaximumExtensionRightElbow
KFbxTypedProperty< fbxDouble1 >	CtrlResistCompressionFactorRightElbow
KFbxTypedProperty< fbxDouble1 >	CtrlSpineStiffness
KFbxTypedProperty< fbxDouble1 >	CtrlNeckStiffness
KFbxTypedProperty< fbxBool1 >	MirrorMode
KFbxTypedProperty< fbxDouble1 >	ShoulderCorrection
KFbxTypedProperty< fbxBool1 >	LeftKneeKillPitch
KFbxTypedProperty< fbxBool1 >	RightKneeKillPitch
KFbxTypedProperty< fbxBool1 >	LeftElbowKillPitch
KFbxTypedProperty< fbxBool1 >	RightElbowKillPitch
KFbxTypedProperty < kCharacterHipsTranslationMode >	HipsTranslationMode
KFbxTypedProperty< fbxBool1 >	WriteReference
KFbxTypedProperty< fbxBool1 >	SyncMode
KFbxTypedProperty< fbxDouble1 >	Damping
KFbxTypedProperty< fbxDouble1 >	OrientationDamping
KFbxTypedProperty < kCharacterOffAutoUser >	OrientationDampingMode
KFbxTypedProperty< fbxDouble1 >	DisplacementDamping
KFbxTypedProperty < kCharacterOffAutoUser >	DisplacementDampingMode
KFbxTypedProperty< fbxDouble1 >	DisplacementMemory
KFbxTypedProperty < kCharacterAutoUser >	DisplacementMemoryMode
KFbxTypedProperty< fbxDouble1 >	HipsDisplacementDamping
KFbxTypedProperty < kCharacterAutoUser >	HipsDisplacementDampingMode
KFbxTypedProperty< fbxDouble1 >	AnkleDisplacementDamping
KFbxTypedProperty < kCharacterAutoUser >	AnkleDisplacementDampingMode
KFbxTypedProperty< fbxDouble1 >	WristDisplacementDamping
KFbxTypedProperty < kCharacterAutoUser >	WristDisplacementDampingMode
KFbxTypedProperty< fbxDouble1 >	Stabilization
KFbxTypedProperty< fbxDouble1 >	AnkleStabilizationTime
KFbxTypedProperty < kCharacterAutoUser >	AnkleStabilizationTimeMode
KFbxTypedProperty< fbxDouble1 >	AnkleStabilizationPerimeter
KFbxTypedProperty < kCharacterAutoUser >	AnkleStabilizationPerimeterMode
KFbxTypedProperty< fbxDouble1 >	AnkleStabilizationAngularPerimeter
KFbxTypedProperty < kCharacterOffAutoUser >	AnkleStabilizationAngularPerimeterMode
KFbxTypedProperty< fbxDouble1 >	AnkleStabilizationFloorProximity
KFbxTypedProperty < kCharacterOffAutoUser >	AnkleStabilizationFloorProximityMode
KFbxTypedProperty< fbxDouble1 >	AnkleStabilizationDamping
KFbxTypedProperty < kCharacterOffAutoUser >	AnkleStabilizationDampingMode
KFbxTypedProperty< fbxDouble1 >	AnkleStabilizationRecoveryTime
KFbxTypedProperty < kCharacterOffAutoUser >	AnkleStabilizationRecoveryTimeMode
KFbxTypedProperty< fbxReference * >	SourceObject
KFbxTypedProperty< fbxReference * >	DestinationObject
KFbxTypedProperty< fbxReference * >	Actor
KFbxTypedProperty< fbxReference * >	Character
KFbxTypedProperty< fbxReference * >	ControlSet
KFbxTypedProperty< fbxDouble1 >	HikVersion
KFbxTypedProperty< fbxBool1 >	Characterize
KFbxTypedProperty< fbxBool1 >	LockXForm
KFbxTypedProperty< fbxBool1 >	LockPick
KError	mError
KString	mName
KFbxCharacterLink	mCharacterLink [eCharacterLastNodeId]
KFbxControlSet *	mControlSet
Friends
class	KFbxScene
class	KFbxNode

eINTERNAL_ERROR	Search for all occurrences
eERROR_COUNT	Search for all occurrences

KFbxCharacter	(	KFbxSdkManager &	pManager,
		char const *	pName
	)

void SetInput	(	ECharacterInputType	pInputType,
		KFbxObject *	pInputObject = `NULL`
	)

pInputType	Input type.
pInputObject	Pointer to input character if input type equals eCharacterInputCharacter, otherwise `NULL`.

bool SetCharacterLink	(	ECharacterNodeId	pCharacterNodeId,
		const KFbxCharacterLink &	pCharacterLink,
		bool	pUpdateObjectList = `true`
	)

pCharacterNodeId	Character node ID.
pCharacterLink	Character link.
pUpdateObjectList	Set to `true` to update the object list (default value).

bool GetCharacterLink	(	ECharacterNodeId	pCharacterNodeId,
		KFbxCharacterLink *	pCharacterLink = `NULL`
	)		const

pCharacterNodeId	ID of character node requested.
pCharacterLink	Optional pointer to receive the character link if function succeeds.

static ECharacterNodeId GetCharacterGroupElementByIndex	(	ECharacterGroupId	pCharacterGroupId,
		int	pIndex
	)		`[static]`

pCharacterGroupId	Character group ID.
pIndex	Character index ID.

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.

static char* GetCharacterGroupNameByIndex	(	ECharacterGroupId	pCharacterGroupId,
		int	pIndex
	)		`[static]`

static int GetCharacterGroupVersionByIndex	(	ECharacterGroupId	pCharacterGroupId,
		int	pIndex
	)		`[static]`

static bool FindCharacterGroupIndexByName	(	const char *	pName,
		bool	pForceGroupId,
		ECharacterGroupId &	pCharacterGroupId,
		int &	pIndex
	)		`[static]`

pName	Character node name.
pForceGroupId	Set to `true` to force the character group ID.
pCharacterGroupId	Receives character group ID.
pIndex	Receives character index ID.

static bool GetCharacterGroupIndexByElement	(	ECharacterNodeId	pCharacterNodeId,
		ECharacterGroupId &	pCharacterGroupId,
		int &	pIndex
	)		`[static]`

static bool GetCharacterGroupVersionByElement	(	ECharacterNodeId	pCharacterNodeId,
		int &	pVersion
	)		`[static]`

pCharacterNodeId	Character node ID to get version.
pVersion	if the node ID is found, the method returns the version through this parameter

static bool GetCharacterNodeNameFromNodeId	(	ECharacterNodeId	pCharacterNodeId,
		char *&	pName
	)		`[static]`

static bool GetCharacterNodeIdFromNodeName	(	const char *	pName,
		ECharacterNodeId &	pCharacterNodeId
	)		`[static]`

pName	Character node name to get node ID.
pCharacterNodeId	if the node name is found, this method returns the node ID through this parameter

KFbxCharacter Class Reference

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

virtual void Destruct	(	bool	pRecursive,
		bool	pDependents
	)		`[virtual]`

const void GetKFbxCharacterPropertyFromHIKProperty	(	char *&	pKFbxCharacterPropertyName,
		char *&	pKFbxCharacterPropertyModeName,
		kCharacterPropertyUnit &	pUnit,
		int &	pPropertyIndex,
		const char *	pHIKPropertyName
	)		const

const void GetHIKPropertyFromKFbxCharacterProperty	(	char *&	pHIKPropertyName,
		kCharacterPropertyUnit &	pUnit,
		const char *	pKFbxCharacterPropertyName
	)		const

const void GetPropertyInfo	(	char *&	pKFbxCharacterPropertyName,
		char *&	pKFbxCharacterPropertyModeName,
		kCharacterPropertyUnit &	pUnit,
		int &	pPropertyIndex,
		char *&	pHIKPropertyName,
		int	pIndex
	)		const