#include<kfbxexporter.h>

Inheritance diagram for KFbxExporter:

[legend]

List of all members.

Detailed Description

Class to export SDK objects into an FBX file.

Typical workflow for using theKFbxExporterclass:

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

Definition at line104of filekfbxexporter.h.

Export Functions
virtual bool	Initialize(const char *pFileName)
	Initialize object.
KFbxStreamOptions*	GetExportOptions()
	Get file export options settings.
bool	Export(KFbxDocument*pDocument,KFbxStreamOptions*pStreamOptions=NULL)
	Export the document 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()
	Returntrueif the file format is a recognized FBX format.
char const *const *	GetCurrentWritableVersions()
	Get writable version for the current file format.
bool	SetFileExportVersion(KStringpVersion,KFbxSceneRenamer::ERenamingModepRenamingMode)
	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:

trueon success,falseotherwise.

Remarks:

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

Reimplemented fromKFbxIO.

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	(	KFbxDocument*	pDocument,
		KFbxStreamOptions*	pStreamOptions=NULL
	)

Export the document to the currently created file.

Parameters:

	pDocument	Document to export.
	pStreamOptions	Pointer to file export options.

Returns:

trueon success,falseotherwise.

Remarks:

To identify the error, callKFbxIO::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

(

)

Returntrueif 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:

	pVersion	String description of the file format.
	pRenamingMode	Renaming mode.

Returns:

trueif 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 line183of filekfbxexporter.h.