KFbxTakeInfo Class Reference

#include <kfbxtakeinfo.h>

List of all members.

---

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 KFbxImporter 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++) 
 {
   KFbxTakeInfo* lTakeInfo = lImporter->GetTakeInfo(lAnimStackCount);
   KString lTakeName = lTakeInfo->mName;
 }

Definition at line 81 of file kfbxtakeinfo.h.

Public Types
enum	EImportOffsetType {    eABSOLUTE,    eRELATIVE }
	Import offset types. More...
Public Member Functions
	KFbxTakeInfo ()
	Default constructor.
virtual	~KFbxTakeInfo ()
	Destructor.
	KFbxTakeInfo (const KFbxTakeInfo &pTakeInfo)
	Copy Constructor.
KFbxTakeInfo &	operator= (const KFbxTakeInfo &pTakeInfo)
	Assignment operator.
KFbxThumbnail *	GetTakeThumbnail ()
	Returns the thumbnail of the take.
void	SetTakeThumbnail (KFbxThumbnail *pTakeThumbnail)
	Sets the take thumbnail.
void	CopyLayers (const KFbxTakeInfo &pTakeInfo)
	Copies the layer information from the take information.
Public Attributes
KString	mName
	Take name.
KString	mImportName
	The take name once it is imported in a scene.
KString	mDescription
	Take description.
bool	mSelect
	Import/export flag.
KTimeSpan	mLocalTimeSpan
	Local time span, set to animation interval if it is left at the default value.
KTimeSpan	mReferenceTimeSpan
	Reference time span, set to animation interval if it is left at the default value.
KTime	mImportOffset
	Time value for offsetting the animation keys once they are imported in a scene.
EImportOffsetType	mImportOffsetType
	Import offset type.
KArrayTemplate< KLayerInfo * >	mLayerInfoList
	List of each layer's information.
int	mCurrentLayer
	Current Layer.
Protected Attributes
KFbxThumbnail *	mTakeThumbnail
	The take thumbnail.

---

Member Enumeration Documentation

enum EImportOffsetType

Import offset types.

• eABSOLUTE
• eRELATIVE

Enumerator:

eABSOLUTE
eRELATIVE

Definition at line 137 of file kfbxtakeinfo.h.

---

Constructor & Destructor Documentation

KFbxTakeInfo

(

)

Default constructor.

virtual ~KFbxTakeInfo

(

)

[virtual]

Destructor.

KFbxTakeInfo

(

const KFbxTakeInfo &

pTakeInfo

)

Copy Constructor.

Parameters:

pTakeInfo

The take information to be copied.

---

Member Function Documentation

KFbxTakeInfo& operator=

(

const KFbxTakeInfo &

pTakeInfo

)

Assignment operator.

Parameters:

pTakeInfo

The take information to be assigned. .

KFbxThumbnail* GetTakeThumbnail

(

)

Returns the thumbnail of the take.

Returns:

Pointer to the thumbnail. Maybe NULL if not found.

void SetTakeThumbnail

(

KFbxThumbnail *

pTakeThumbnail

)

Sets the take thumbnail.

Parameters:

pTakeThumbnail

The referenced thumbnail object.

void CopyLayers

(

const KFbxTakeInfo &

pTakeInfo

)

Copies the layer information from the take information.

Parameters:

pTakeInfo

The take information to be copied.

---

Member Data Documentation

KString mName

Take name.

Definition at line 104 of file kfbxtakeinfo.h.

KString 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.

Definition at line 110 of file kfbxtakeinfo.h.

KString mDescription

Take description.

Definition at line 113 of file kfbxtakeinfo.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 118 of file kfbxtakeinfo.h.

KTimeSpan mLocalTimeSpan

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

Definition at line 121 of file kfbxtakeinfo.h.

KTimeSpan mReferenceTimeSpan

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

Definition at line 124 of file kfbxtakeinfo.h.

KTime 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 131 of file kfbxtakeinfo.h.

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 150 of file kfbxtakeinfo.h.

KArrayTemplate<KLayerInfo*> mLayerInfoList

List of each layer's information.

Definition at line 168 of file kfbxtakeinfo.h.

int mCurrentLayer

Current Layer.

Definition at line 171 of file kfbxtakeinfo.h.

KFbxThumbnail* mTakeThumbnail [protected]

The take thumbnail.

Definition at line 175 of file kfbxtakeinfo.h.