KFbxExporter Class Reference

#include <kfbxexporter.h>

Inherits KFbxIO.

Inheritance diagram for KFbxExporter:

List of all members.

---

Detailed Description

Class to export SDK objects into an FBX file.

Typical workflow for using the KFbxExporter class:

1. create an exporter
2. initialize it with a file name
3. set numerous states, take information, defining how the exporter will behave
4. call KFbxExporter::Export() with the entity to export

Definition at line 84 of file kfbxexporter.h.

Export Functions
virtual bool	Initialize (const char *pFileName)
	Initialize object.
KFbxStreamOptions *	GetExportOptions ()
	Get file export options settings.
bool	Export (KFbxScene &pScene, KFbxStreamOptions *pStreamOptions=NULL)
	Export the scene to the currently created file.
void	ReleaseExportOptions (KFbxStreamOptions *pStreamOptions)
	Release the file export options.
File Format
void	SetFileFormat (int pFileFormat)
	Set the exported file format.
int	GetFileFormat ()
	Get the format of the exported file.
bool	IsFBX ()
	Return true if the file format is a recognized FBX format.
char const *const *	GetCurrentWritableVersions ()
	Get writable version for the current file format.
bool	SetFileExportVersion (KString pVersion, KFbxSceneRenamer::ERenamingMode pRenamingMode)
	Set file version for a given file format.
void	SetResamplingRate (double pResamplingRate)
	Set the resampling rate (only used when exporting to FBX5.3 and lower).

---

Member Function Documentation

virtual bool Initialize

(

const char *

pFileName

)

[virtual]

Initialize object.

Parameters:

pFileName

Name of file to access.

Returns:

true on success, false otherwise.

Remarks:

To identify the error that occured, call KFbxIO::GetLastErrorID().

Reimplemented from KFbxIO.

KFbxStreamOptions* GetExportOptions

(

)

Get file export options settings.

Returns:

Pointer to file export options or NULL on failure.

Remarks:

Caller gets ownership of the returned structure.

bool Export	(	KFbxScene &	pScene,
		KFbxStreamOptions *	pStreamOptions = NULL
	)

Export the scene to the currently created file.

Parameters:

	pScene	Scene to export.
	pStreamOptions	Pointer to file export options.

Returns:

true on success, false otherwise.

Remarks:

To identify the error, call KFbxIO::GetLastErrorID().

void ReleaseExportOptions

(

KFbxStreamOptions *

pStreamOptions

)

Release the file export options.

Parameters:

pStreamOptions

Pointer to file export options.

void SetFileFormat

(

int

pFileFormat

)

Set the exported file format.

Parameters:

pFileFormat

File format identifier.

int GetFileFormat

(

)

Get the format of the exported file.

Returns:

File format identifier.

bool IsFBX

(

)

Return true if the file format is a recognized FBX format.

char const* const* GetCurrentWritableVersions

(

)

Get writable version for the current file format.

Returns:

char**

bool SetFileExportVersion	(	KString	pVersion,
		KFbxSceneRenamer::ERenamingMode	pRenamingMode
	)

Set file version for a given file format.

Parameters:

	pVersionIndex	Index in the version index of the file format.
	pFormat	File format.

Returns:

true if mode is set correctly

void SetResamplingRate

(

double

pResamplingRate

)

[inline]

Set the resampling rate (only used when exporting to FBX5.3 and lower).

Parameters:

pResamplingRate

resampling rate

Definition at line 163 of file kfbxexporter.h.