FBX C++ API Reference
FbxTakeInfo Class Reference

#include <fbxtakeinfo.h>

Class 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;
}
Examples:
Common/Common.cxx, and ViewScene/SceneContext.cxx.

Definition at line 56 of file fbxtakeinfo.h.

Public Types

enum  EImportOffsetType { eAbsolute, eRelative }
 Import offset types. More...
 

Public Member Functions

 FbxTakeInfo ()
 Default constructor. More...
 
virtual ~FbxTakeInfo ()
 Destructor. More...
 
 FbxTakeInfo (const FbxTakeInfo &pTakeInfo)
 Copy Constructor. More...
 
FbxTakeInfooperator= (const FbxTakeInfo &pTakeInfo)
 Assignment operator. More...
 
void CopyLayers (const FbxTakeInfo &pTakeInfo)
 Copies the layer information from the take information. More...
 

Public Attributes

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

Member Enumeration Documentation

◆ EImportOffsetType

Import offset types.

  • eAbsolute
  • eRelative
Enumerator
eAbsolute 
eRelative 

Definition at line 112 of file fbxtakeinfo.h.

Constructor & Destructor Documentation

◆ FbxTakeInfo() [1/2]

Default constructor.

◆ ~FbxTakeInfo()

virtual ~FbxTakeInfo ( )
virtual

Destructor.

◆ FbxTakeInfo() [2/2]

FbxTakeInfo ( const FbxTakeInfo pTakeInfo)

Copy Constructor.

Parameters
pTakeInfoThe take information to be copied.

Member Function Documentation

◆ operator=()

FbxTakeInfo& operator= ( const FbxTakeInfo pTakeInfo)

Assignment operator.

Parameters
pTakeInfoThe take information to be assigned. .

◆ CopyLayers()

void CopyLayers ( const FbxTakeInfo pTakeInfo)

Copies the layer information from the take information.

Parameters
pTakeInfoThe take information to be copied.

Member Data Documentation

◆ mName

FbxString mName

Take name.

Examples:
Common/Common.cxx.

Definition at line 79 of file fbxtakeinfo.h.

◆ mImportName

FbxString mImportName

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.
Examples:
Common/Common.cxx.

Definition at line 85 of file fbxtakeinfo.h.

◆ mDescription

FbxString mDescription

Take description.

Examples:
Common/Common.cxx.

Definition at line 88 of file fbxtakeinfo.h.

◆ mSelect

bool mSelect

Import/export flag.

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

Examples:
Common/Common.cxx.

Definition at line 93 of file fbxtakeinfo.h.

◆ mLocalTimeSpan

FbxTimeSpan mLocalTimeSpan

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

Examples:
ViewScene/SceneContext.cxx.

Definition at line 96 of file fbxtakeinfo.h.

◆ mReferenceTimeSpan

FbxTimeSpan mReferenceTimeSpan

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

Definition at line 99 of file fbxtakeinfo.h.

◆ mImportOffset

FbxTime mImportOffset

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.

◆ mImportOffsetType

EImportOffsetType mImportOffsetType

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.

◆ mLayerInfoList

FbxArray<FbxTakeLayerInfo*> mLayerInfoList

List of each layer's information.

Definition at line 133 of file fbxtakeinfo.h.

◆ mCurrentLayer

int mCurrentLayer

Current Layer.

Definition at line 136 of file fbxtakeinfo.h.


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