FBX C++ API Reference
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
AnimationElement Class Reference

#include <fbxcolladaanimationelement.h>

Class Description

Representing a COLLADA animation element.

Definition at line 26 of file fbxcolladaanimationelement.h.

+ Inheritance diagram for AnimationElement:

Public Types

typedef ElementBase base_type
 
- Public Types inherited from ElementBase
enum  { MATRIX_STRIDE = 16 }
 

Public Member Functions

 AnimationElement ()
 
virtual ~AnimationElement ()
 
int GetChannelCount () const
 Get the count of animation channels in the element. More...
 
bool FromCOLLADA (xmlNode *pElement, const SourceElementMapType &pSourceElements)
 Initialize with the content of a COLLADA element. More...
 
bool FromFBX (const FbxAnimCurve *pCurve, double pUnitConversion=1.0)
 Initialize with an animation curve. More...
 
bool ToFBX (FbxAnimCurve *pFBXCurve, int pChannelIndex, double pUnitConversion=1.0) const
 Copy the channel with specific index to the FBX animation curve. More...
 
bool ToFBX (FbxNode *pFBXNode, FbxAnimLayer *pAnimLayer, double pUnitConversion=1.0) const
 Copy the matrix animation to the FBX node TRS properties. More...
 
bool ToCOLLADA (xmlNode *pAnimationLibrary, const char *pNodeID, const char *pAttributeSID)
 Add the content to COLLADA animation library. More...
 
- Public Member Functions inherited from ElementBase
 ElementBase ()
 Constructor & Destructor. More...
 
virtual ~ElementBase ()
 
void SetXMLElement (xmlNode *pElement)
 Access for XML element. More...
 
xmlNode * GetXMLElement () const
 
const FbxStringGetID () const
 Get the ID of the element. More...
 
const FbxSystemUnitGetUnit () const
 Get the unit of the element, which takes effect in this element and its children elements. More...
 

Additional Inherited Members

- Static Public Attributes inherited from ElementBase
static const char * smID_PROPERTY_NAME
 

Member Typedef Documentation

◆ base_type

Definition at line 29 of file fbxcolladaanimationelement.h.

Constructor & Destructor Documentation

◆ AnimationElement()

◆ ~AnimationElement()

virtual ~AnimationElement ( )
virtual

Member Function Documentation

◆ GetChannelCount()

int GetChannelCount ( ) const

Get the count of animation channels in the element.

Returns
Return the channel count.

◆ FromCOLLADA()

bool FromCOLLADA ( xmlNode *  pElement,
const SourceElementMapType pSourceElements 
)

Initialize with the content of a COLLADA element.

This method should be called before ToFBX.

◆ FromFBX()

bool FromFBX ( const FbxAnimCurve pCurve,
double  pUnitConversion = 1.0 
)

Initialize with an animation curve.

This method should be called before ToCOLLADA.

Parameters
pCurveThe specific animation curve.
pUnitConversionThe unit conversion for key value.

◆ ToFBX() [1/2]

bool ToFBX ( FbxAnimCurve pFBXCurve,
int  pChannelIndex,
double  pUnitConversion = 1.0 
) const

Copy the channel with specific index to the FBX animation curve.

Parameters
pFBXCurveThe destination FBX animation curve.
pChannelIndexThe index of the source channel.
pUnitConversionThe unit conversion from local element to global.

◆ ToFBX() [2/2]

bool ToFBX ( FbxNode pFBXNode,
FbxAnimLayer pAnimLayer,
double  pUnitConversion = 1.0 
) const

Copy the matrix animation to the FBX node TRS properties.

Parameters
pFBXNodeThe destination FBX node.
pAnimLayerThe animation layer whose X, Y and Z curves will be set up.
pUnitConversionThe unit conversion from local element to global.

◆ ToCOLLADA()

bool ToCOLLADA ( xmlNode *  pAnimationLibrary,
const char *  pNodeID,
const char *  pAttributeSID 
)

Add the content to COLLADA animation library.

Parameters
pAnimationLibraryThe COLLADA animation library element.
pNodeIDThe ID of the element to who this curve is belong.
pAttributeSIDThe ID the attribute to who this curve is belong.

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