KFbxAnimStack Class Reference

#include <kfbxanimstack.h>

Inheritance diagram for KFbxAnimStack:

[legend]

List of all members.

---

Detailed Description

The Animation stack is a collection of animation layers.

The Fbx document can have one or more animation stacks. Each stack can be viewed as one "take" in the previous versions of the FBX SDK. The "stack" terminology comes from the fact that the object contains 1 to n animation layers that are evaluated according to their blending modes to produce a resulting animation for a given attribute.

Definition at line 62 of file kfbxanimstack.h.

Utility functions.
KTimeSpan	GetLocalTimeSpan () const
	Get the LocalStart and LocalStop time properties as a KTimeSpan.
void	SetLocalTimeSpan (KTimeSpan &pTimeSpan)
	Set the LocalStart and LocalStop time properties from a KTimeSpan.
KTimeSpan	GetReferenceTimeSpan () const
	Get the ReferenceStart and ReferenceStop time properties as a KTimeSpan.
void	SetReferenceTimeSpan (KTimeSpan &pTimeSpan)
	Set the ReferenceStart and ReferenceStop time properties from a KTimeSpan.
KFbxThumbnail *	GetTakeThumbnail ()
	Get the thumbnail image associated to this animation stack.
void	SetTakeThumbnail (KFbxThumbnail *pTakeThumbnail)
	Set the take thumbnail.
bool	BakeLayers (KFbxAnimEvaluator *pEvaluator, KTime pStart, KTime pStop, KTime pPeriod)
	Bake all the animation layers on the base layer.
Public Member Functions
void	Reset (const KFbxTakeInfo *pTakeInfo=NULL)
	Reset the object time spans either to their default values or from the pTakeInfo structure, if provided.
Public Attributes
KFbxTypedProperty< fbxString >	Description
	This property stores a description string of this animation stack.
KFbxTypedProperty< fbxTime >	LocalStart
	This property stores the local time span "Start" time.
KFbxTypedProperty< fbxTime >	LocalStop
	This property stores the local time span "Stop" time.
KFbxTypedProperty< fbxTime >	ReferenceStart
	This property stores the reference time span "Start" time.
KFbxTypedProperty< fbxTime >	ReferenceStop
	This property stores the reference time span "Stop" time.

---

Member Function Documentation

void Reset

(

const KFbxTakeInfo *

pTakeInfo = NULL

)

Reset the object time spans either to their default values or from the pTakeInfo structure, if provided.

Parameters:

pTakeInfo

The take info to be used during reset.

KTimeSpan GetLocalTimeSpan

(

)

const

Get the LocalStart and LocalStop time properties as a KTimeSpan.

Returns:

The current local time span.

void SetLocalTimeSpan

(

KTimeSpan &

pTimeSpan

)

Set the LocalStart and LocalStop time properties from a KTimeSpan.

Parameters:

pTimeSpan

The new local time span.

KTimeSpan GetReferenceTimeSpan

(

)

const

Get the ReferenceStart and ReferenceStop time properties as a KTimeSpan.

Returns:

The current reference time span.

void SetReferenceTimeSpan

(

KTimeSpan &

pTimeSpan

)

Set the ReferenceStart and ReferenceStop time properties from a KTimeSpan.

Parameters:

pTimeSpan

The new reference time span.

KFbxThumbnail* GetTakeThumbnail

(

)

Get the thumbnail image associated to this animation stack.

This method exists for legacy reasons. In the newer FBX files, there can only be one thumbnail image and it belongs to the KFbxDocument.

Returns:

Pointer to the thumbnail.

void SetTakeThumbnail

(

KFbxThumbnail *

pTakeThumbnail

)

Set the take thumbnail.

This method exists for legacy reasons. In the newer FBX files, there can only be one thumbnail image and it belongs to the KFbxDocument.

Parameters:

pTakeThumbnail

The referenced thumbnail object.

bool BakeLayers	(	KFbxAnimEvaluator *	pEvaluator,
		KTime	pStart,
		KTime	pStop,
		KTime	pPeriod
	)

Bake all the animation layers on the base layer.

This function will process all the properties on every animation layer and will generate a resampled set of animation keys (representing the layers's evaluated result) on the base layer. Once this operation is completed successfully, all the layers (except the base one) are destroyed. Properties that are only defined on the base layer will remain unaffected by the resampling. The stack local timespan is updated with the overall animation range.

Parameters:

	pEvaluator	The layer evaluator. This is the engine that evaluates the overall result of any given property according to the layers flags.
	pStart	The start time of the resampling range.
	pStop	The stop time of the resampling range.
	pPeriod	The time increment for the resampling.

Returns:

True if the operation was successful and false in case of errors.

Remarks:

If this AnimStack contains only one AnimLayer, the function will return false and do nothing.

---

Member Data Documentation

KFbxTypedProperty<fbxString> Description

This property stores a description string of this animation stack.

This string can be used to display, in a human readable format, information relative to this animation stack object. Default value is "".

Remarks:

The applications using the FBX SDK are not required to manipulate this information.

Definition at line 78 of file kfbxanimstack.h.

KFbxTypedProperty<fbxTime> LocalStart

This property stores the local time span "Start" time.

This "start" time should be seen as a time marker. Typically it would represent the whole animation starting time but its use (and update) is left to the calling application (with one exception occurring in the BakeLayers). The FBX SDK do not use this value internally an only guarantee that it will be stored to the FBX file and retrieved from it.

Default value is 0.

Definition at line 88 of file kfbxanimstack.h.

KFbxTypedProperty<fbxTime> LocalStop

This property stores the local time span "Stop" time.

This "stop" time should be seen as a time marker. Typically it would represent the whole animation ending time but its use (and update) is left to the calling application (with one exception occurring in the BakeLayers). The FBX SDK do not use this value internally an only guarantee that it will be stored to the FBX file and retrieved from it.

Default value is 0

Definition at line 98 of file kfbxanimstack.h.

KFbxTypedProperty<fbxTime> ReferenceStart

This property stores the reference time span "Start" time.

This reference start time is another time marker that can be used by the calling application. The FBX SDK never use it and only guarantees that this value is stored in the FBX file and retrieved from it.

Default value is 0

Definition at line 106 of file kfbxanimstack.h.

KFbxTypedProperty<fbxTime> ReferenceStop

This property stores the reference time span "Stop" time.

This reference start time is another time marker that can be used by the calling application. The FBX SDK never use it and only guarantees that this value is stored in the FBX file and retrieved from it.

Default value is 0

Definition at line 114 of file kfbxanimstack.h.