KFbxSkeleton Class Reference

#include <kfbxskeleton.h>

Inherits KFbxNodeAttribute.

Inheritance diagram for KFbxSkeleton:

List of all members.

---

Detailed Description

This node attribute contains the properties of a skeleton segment.

Definition at line 62 of file kfbxskeleton.h.

Skeleton Properties
enum	ESkeletonType
	Skeleton types. More...
void	SetSkeletonType (ESkeletonType pSkeletonType)
	Set the skeleton type.
ESkeletonType	GetSkeletonType () const
	Get the skeleton type.
bool	GetSkeletonTypeIsSet () const
	Get a flag to know if the skeleton type was set.
ESkeletonType	GetSkeletonTypeDefaultValue () const
	Get the default value for the skeleton type.
bool	SetLimbLength (double pLength)
	Set limb length.
double	GetLimbLength () const
	Get limb length.
bool	GetLimbLengthIsSet () const
	Get a flag to know if the limb length was set.
double	GetLimbLengthDefaultValue () const
	Get the default value for the limb length.
bool	SetLimbNodeSize (double pSize)
	Set skeleton limb node size.
double	GetLimbNodeSize () const
	Get skeleton limb node size.
bool	GetLimbNodeSizeIsSet () const
	Get a flag to know if the limb node size was set.
double	GetLimbNodeSizeDefaultValue () const
	Get the default value for the limb node size.
bool	SetLimbNodeColor (const KFbxColor &pColor)
	Set limb or limb node color.
KFbxColor	GetLimbNodeColor () const
	Get limb or limb node color.
bool	GetLimbNodeColorIsSet () const
	Get a flag to know if the limb node color was set.
KFbxColor	GetLimbNodeColorDefaultValue () const
	Get the default value for the limb node color.
Public Member Functions
virtual EAttributeType	GetAttributeType () const
	Return the type of node attribute which is EAttributeType::eSKELETON.
void	Reset ()
	Reset the skeleton to default values and type to eROOT.

---

Member Enumeration Documentation

enum ESkeletonType

Skeleton types.

• eROOT
• eLIMB
• eLIMB_NODE
• eEFFECTOR

Remarks:

eEFFECTOR is synonymous to eROOT.

The eLIMB_NODE type is a bone defined uniquely by a transform and a size value while

the eLIMB type is a bone defined by a transform and a length.

Definition at line 89 of file kfbxskeleton.h.

---

Member Function Documentation

virtual EAttributeType GetAttributeType

(

)

const [virtual]

Return the type of node attribute which is EAttributeType::eSKELETON.

Reimplemented from KFbxNodeAttribute.

void Reset

(

)

Reset the skeleton to default values and type to eROOT.

void SetSkeletonType

(

ESkeletonType

pSkeletonType

)

Set the skeleton type.

Parameters:

pSkeletonType

Skeleton type identifier.

ESkeletonType GetSkeletonType

(

)

const

Get the skeleton type.

Returns:

Skeleton type identifier.

bool GetSkeletonTypeIsSet

(

)

const

Get a flag to know if the skeleton type was set.

Returns:

true if a call to SetSkeletonType() has been made.

Remarks:

When the attribute is not set, the application can choose to ignore the attribute or use the default value.

The flag is set back to false when Reset() is called.

ESkeletonType GetSkeletonTypeDefaultValue

(

)

const

Get the default value for the skeleton type.

Returns:

eROOT

bool SetLimbLength

(

double

pLength

)

Set limb length.

Parameters:

pLength

Length of the limb.

Returns:

true if skeleton type is eLIMB, false otherwise.

Remarks:

Limb length is only set if skeleton type is eLIMB.

double GetLimbLength

(

)

const

Get limb length.

Returns:

limb length.

Remarks:

Limb length is only valid if skeleton type is eLIMB.

bool GetLimbLengthIsSet

(

)

const

Get a flag to know if the limb length was set.

Returns:

true if a call to SetLimbLength() has been made.

Remarks:

When the attribute is not set, the application can choose to ignore the attribute or use the default value.

The flag is set back to false when Reset() is called.

double GetLimbLengthDefaultValue

(

)

const

Get the default value for the limb length.

Returns:

1.0

bool SetLimbNodeSize

(

double

pSize

)

Set skeleton limb node size.

Parameters:

pSize

Size of the limb node.

double GetLimbNodeSize

(

)

const

Get skeleton limb node size.

Returns:

Limb node size value.

bool GetLimbNodeSizeIsSet

(

)

const

Get a flag to know if the limb node size was set.

Returns:

true if a call to SetLimbNodeSize() has been made.

Remarks:

When the attribute is not set, the application can choose to ignore the attribute or use the default value.

The flag is set back to false when Reset() is called.

double GetLimbNodeSizeDefaultValue

(

)

const

Get the default value for the limb node size.

Returns:

100.0

bool SetLimbNodeColor

(

const KFbxColor &

pColor

)

Set limb or limb node color.

Parameters:

pColor

RGB values for the limb color.

Returns:

true if skeleton type is eLIMB or eLIMB_NODE, false otherwise.

Remarks:

Limb or limb node color is only set if skeleton type is eLIMB or eLIMB_NODE.

KFbxColor GetLimbNodeColor

(

)

const

Get limb or limb node color.

Returns:

Currently set limb color.

Remarks:

Limb or limb node color is only valid if skeleton type is eLIMB or eLIMB_NODE.

bool GetLimbNodeColorIsSet

(

)

const

Get a flag to know if the limb node color was set.

Returns:

true if a call to SetLimbNodeColor() has been made.

Remarks:

When the attribute is not set, the application can choose to ignore the attribute or use the default value.

The flag is set back to false when Reset() is called.

KFbxColor GetLimbNodeColorDefaultValue

(

)

const

Get the default value for the limb node color.

Returns:

R=0.8, G=0.8, B=0.8