Public Types | Public Member Functions | Public Attributes | Protected Attributes

FbxTakeInfo Class Reference

This reference page is linked to from the following overview topics: Migrating to the New Data Structures for Animation, List of Python Fbx classes.


Search for all occurrences

Detailed Description

This class contains take information from an imported file or exported to an output file.

A "take" is in fact a group of animation data grouped by name, so the FBX file format can support many "animation takes" in an FBX file to mimic how a movie is produced by making many takes of the same scene.

The most used data is the "take name", other data are rarely used. Example of use: to get the list of all animation take names of FBX file without loading all the scene content. When a FbxImporter is initialized, the take information can be read and can be available before the long Import() step, this way, we can get the take info data very fast since we don't need to load all the animation scene data.

 // Ex: to get all take names in a FBX file
 for(int lAnimStackCount=0; lAnimStackCount < lImporter->GetAnimStackCount(); lAnimStackCount++) 
 {
   FbxTakeInfo* lTakeInfo = lImporter->GetTakeInfo(lAnimStackCount);
   FbxString lTakeName = lTakeInfo->mName;
 }

Definition at line 56 of file fbxtakeinfo.h.

#include <fbxtakeinfo.h>

List of all members.

Public Types

enum  EImportOffsetType { eAbsolute, eRelative }
 

Import offset types.

More...

Public Member Functions

 FbxTakeInfo ()
 Default constructor.
virtual ~FbxTakeInfo ()
 Destructor.
 FbxTakeInfo (const FbxTakeInfo &pTakeInfo)
 Copy Constructor.
FbxTakeInfooperator= (const FbxTakeInfo &pTakeInfo)
 Assignment operator.
FbxThumbnailGetTakeThumbnail ()
 Returns the thumbnail of the take.
void SetTakeThumbnail (FbxThumbnail *pTakeThumbnail)
 Sets the take thumbnail.
void CopyLayers (const FbxTakeInfo &pTakeInfo)
 Copies the layer information from the take information.

Public Attributes

FbxString mName
 Take name.
FbxString mImportName
 The take name once it is imported in a scene.
FbxString mDescription
 Take description.
bool mSelect
 Import/export flag.
FbxTimeSpan mLocalTimeSpan
 Local time span, set to animation interval if it is left at the default value.
FbxTimeSpan mReferenceTimeSpan
 Reference time span, set to animation interval if it is left at the default value.
FbxTime mImportOffset
 Time value for offsetting the animation keys once they are imported in a scene.
EImportOffsetType mImportOffsetType
 Import offset type.
FbxArray< FbxTakeLayerInfo * > mLayerInfoList
 List of each layer's information.
int mCurrentLayer
 Current Layer.

Protected Attributes

FbxThumbnailmTakeThumbnail
 The take thumbnail.

Member Enumeration Documentation

Import offset types.

  • eAbsolute
  • eRelative
Enumerator:
eAbsolute 
eRelative 

Definition at line 112 of file fbxtakeinfo.h.


Constructor & Destructor Documentation

Default constructor.

virtual ~FbxTakeInfo ( ) [virtual]

Destructor.

FbxTakeInfo ( const FbxTakeInfo pTakeInfo)

Copy Constructor.

Parameters:
pTakeInfoThe take information to be copied.

Member Function Documentation

FbxTakeInfo& operator= ( const FbxTakeInfo pTakeInfo)

Assignment operator.

Parameters:
pTakeInfoThe take information to be assigned. .
FbxThumbnail* GetTakeThumbnail ( )

Returns the thumbnail of the take.

Returns:
Pointer to the thumbnail. Maybe NULL if not found.
void SetTakeThumbnail ( FbxThumbnail pTakeThumbnail)

Sets the take thumbnail.

Parameters:
pTakeThumbnailThe referenced thumbnail object.
void CopyLayers ( const FbxTakeInfo pTakeInfo)

Copies the layer information from the take information.

Parameters:
pTakeInfoThe take information to be copied.

Member Data Documentation

Take name.

Definition at line 79 of file fbxtakeinfo.h.

The take name once it is imported in a scene.

You can modify it if it must be different from the take name in the imported file.

Remarks:
This field is only used when importing a scene.

Definition at line 85 of file fbxtakeinfo.h.

Take description.

Definition at line 88 of file fbxtakeinfo.h.

bool mSelect

Import/export flag.

Set to true by default, set to false if the take must not be imported or exported.

Definition at line 93 of file fbxtakeinfo.h.

Local time span, set to animation interval if it is left at the default value.

Definition at line 96 of file fbxtakeinfo.h.

Reference time span, set to animation interval if it is left at the default value.

Definition at line 99 of file fbxtakeinfo.h.

Time value for offsetting the animation keys once they are imported in a scene.

You can modify it if you need the animation of a take to be offset. The effect depends on the state of mImportOffsetType.

Remarks:
This field is only used when importing a scene.

Definition at line 106 of file fbxtakeinfo.h.

Import offset type.

If set to eAbsolute, mImportOffset gives the absolute time of the first animation key and the appropriate time shift is applied to all of the other animation keys. If set to eRelative, mImportOffset gives the relative time shift applied to all animation keys.

Definition at line 125 of file fbxtakeinfo.h.

List of each layer's information.

Definition at line 143 of file fbxtakeinfo.h.

Current Layer.

Definition at line 146 of file fbxtakeinfo.h.

The take thumbnail.

Definition at line 150 of file fbxtakeinfo.h.


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

FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo
FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo FbxTakeInfo