KFbxSkeleton
#include<kfbxskeleton.h>

Inheritance diagram for KFbxSkeleton:

Inheritance graph
[legend]

List of all members.

Detailed Description

This node attribute contains the properties of a skeleton segment.

Definition at line61of filekfbxskeleton.h.


Skeleton Properties

enum ESkeletonType
 Skeleton types.More...
void SetSkeletonType(ESkeletonTypepSkeletonType)
 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.
K_DEPRECATED bool SetLimbLength(double pLength)
 Set limb length.
K_DEPRECATED double GetLimbLength() const
 Get limb length.
K_DEPRECATED 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.
K_DEPRECATED bool SetLimbNodeSize(double pSize)
 Set skeleton limb node size.
K_DEPRECATED double GetLimbNodeSize() const
 Get skeleton limb node size.
K_DEPRECATED 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(constKFbxColor&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.

Property Names

static const char * sSize
static const char * sLimbLength

Property Default Values

static const fbxDouble1 sDefaultSize
static const fbxDouble1 sDefaultLimbLength
KFbxTypedProperty<fbxDouble1> Size
 This property handles the limb node size.
KFbxTypedProperty<fbxDouble1> LimbLength
 This property handles the skeleton limb length.

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

Member Enumeration Documentation

Skeleton types.

  • eROOT
  • eLIMB
  • eLIMB_NODE
  • eEFFECTOR

Remarks:
eEFFECTORis synonymous toeROOT.

TheeLIMB_NODEtype is a bone defined uniquely by a transform and a size value while

theeLIMBtype is a bone defined by a transform and a length.

Definition at line88of filekfbxskeleton.h.

Member Function Documentation

virtual EAttributeType GetAttributeType( ) const[virtual]

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

Reimplemented fromKFbxNodeAttribute.

void Reset( ) 

Reset the skeleton to default values and type toeROOT.

void SetSkeletonType(ESkeletonType pSkeletonType ) 

Set the skeleton type.

Parameters:
pSkeletonType Skeleton type identifier.

ESkeletonTypeGetSkeletonType( ) const

Get the skeleton type.

Returns:
Skeleton type identifier.

bool GetSkeletonTypeIsSet( ) const

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

Returns:
trueif a call toSetSkeletonType()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 tofalsewhenReset()is called.

ESkeletonTypeGetSkeletonTypeDefaultValue( ) const

Get the default value for the skeleton type.

Returns:
eROOT

K_DEPRECATED bool SetLimbLength(double pLength ) 

Set limb length.

Parameters:
pLength Length of the limb.
Returns:
trueif skeleton type iseLIMB,falseotherwise.
Remarks:
Limb length is only set if skeleton type iseLIMB.

This function is deprecated. Use property LimbLength.Set(pLength) instead.

K_DEPRECATED double GetLimbLength( ) const

Get limb length.

Returns:
limb length.
Remarks:
Limb length is only valid if skeleton type iseLIMB.

This function is deprecated. Use property LimbLength.Get() instead.

K_DEPRECATED bool GetLimbLengthIsSet( ) const

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

Returns:
trueif a call toSetLimbLength()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 tofalsewhenReset()is called.

double GetLimbLengthDefaultValue( ) const

Get the default value for the limb length.

Returns:
1.0

K_DEPRECATED bool SetLimbNodeSize(double pSize ) 

Set skeleton limb node size.

Parameters:
pSize Size of the limb node.
Remarks:
This function is deprecated. Use property Size.Set(pSize) instead.

K_DEPRECATED double GetLimbNodeSize( ) const

Get skeleton limb node size.

Returns:
Limb node size value.
Remarks:
This function is deprecated. Use property Size.Get() instead.

K_DEPRECATED bool GetLimbNodeSizeIsSet( ) const

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

Returns:
trueif a call toSetLimbNodeSize()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 tofalsewhenReset()is called.

This function is OBSOLETE, DO NOT USE. It will always return false. It will be removed on in the next release.

This function is deprecated. Use property Size instead.

double GetLimbNodeSizeDefaultValue( ) const

Get the default value for the limb node size.

Returns:
100.0

bool SetLimbNodeColor(constKFbxColorpColor ) 

Set limb or limb node color.

Parameters:
pColor RGB values for the limb color.
Returns:
trueif skeleton type iseLIMBoreLIMB_NODE,falseotherwise.
Remarks:
Limb or limb node color is only set if skeleton type iseLIMBoreLIMB_NODE.

KFbxColorGetLimbNodeColor( ) const

Get limb or limb node color.

Returns:
Currently set limb color.
Remarks:
Limb or limb node color is only valid if skeleton type iseLIMBoreLIMB_NODE.

bool GetLimbNodeColorIsSet( ) const

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

Returns:
trueif a call toSetLimbNodeColor()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 tofalsewhenReset()is called.

KFbxColorGetLimbNodeColorDefaultValue( ) const

Get the default value for the limb node color.

Returns:
R=0.8, G=0.8, B=0.8

Member Data Documentation

KFbxTypedProperty<fbxDouble1>Size

This property handles the limb node size.

To access this property do: Size.Get(). To set this property do: Size.Set(fbxDouble1).

Default value is 100.0

Definition at line226of filekfbxskeleton.h.

KFbxTypedProperty<fbxDouble1>LimbLength

This property handles the skeleton limb length.

To access this property do: LimbLength.Get(). To set this property do: LimbLength.Set(fbxDouble1).

Default value is 1.0

Definition at line235of filekfbxskeleton.h.