This reference page is linked to from the following overview topics: FBX SDK 2011, FBX Objects, Animation data structures, Migrating to the new data structures for animation, Animation classes and their interrelationships, List of Python FBX classes.
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.
- Examples:
-
Animation/main.cxx, Common/AnimationUtility.cxx, Common/AnimationUtility.h, ExportScene01/main.cxx, ExportScene02/main.cxx, ExportScene03/main.cxx, ExportScene04/main.cxx, ImportScene/DisplayAnimation.cxx, Instances/main.cxx, Pivot/main.cxx, UIExamples/CubeCreator/SDK_Utility.cxx, UserProperties/main.cxx, ViewScene/main.cxx, and ViewScene/SetCamera.cxx.
Definition at line 62 of file kfbxanimstack.h.
#include <kfbxanimstack.h>
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.
|
|
| virtual KFbxObject & | Copy (const KFbxObject &pObject) |
| Copy an object content into this object.
|
|
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. |
|
Protected Member Functions |
|
| KFbxAnimStack (KFbxSdkManager &pManager, char const *pName, KError *pError=0) | |
| virtual bool | ConstructProperties (bool pForceSet) |
| virtual KFbxAnimStack * | GetAnimStack () |
Protected Attributes |
|
| KFbxThumbnail * | mTakeThumbnail |
Friends |
|
| class | KFbxObject |
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. |
|
Constructor & Destructor Documentation
| KFbxAnimStack | ( | KFbxSdkManager & | pManager, |
| char const * | pName, | ||
| KError * | pError = 0 |
||
| ) | [protected] |
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:
Trueif the operation was successful andfalsein case of errors.
- Remarks:
- If this AnimStack contains only one AnimLayer, the function will return false and do nothing.
| virtual KFbxObject& Copy | ( | const KFbxObject & | pObject | ) | [virtual] |
Copy an object content into this object.
- Parameters:
-
pObject The source object to copy data from.
- Returns:
- Returns the destination object being modified by the source.
- Remarks:
- This function replace the assignment operator (operator=). It will copy all property values and the name. Connections are NOT copied.
Reimplemented from KFbxObject.
| virtual bool ConstructProperties | ( | bool | pForceSet | ) | [protected, virtual] |
Reimplemented from KFbxObject.
| virtual KFbxAnimStack* GetAnimStack | ( | ) | [protected, virtual] |
Friends And Related Function Documentation
friend class KFbxObject [friend] |
Reimplemented from KFbxPlug.
Definition at line 197 of file kfbxanimstack.h.
Member Data Documentation
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.
- Examples:
- Animation/main.cxx.
Definition at line 78 of file kfbxanimstack.h.
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.
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
- Examples:
- Animation/main.cxx.
Definition at line 98 of file kfbxanimstack.h.
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.
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.
KFbxThumbnail* mTakeThumbnail
[protected] |
Definition at line 187 of file kfbxanimstack.h.
The documentation for this class was generated from the following file:
- fbxfilesdk/kfbxplugins/kfbxanimstack.h
