KFbxExporter Class Reference

#include <kfbxexporter.h>

Inheritance diagram for KFbxExporter:

[legend]

List of all members.

---

Detailed Description

Class to export SDK objects into an FBX file.

Normally this class is used as is. But for very special needs a user can override Initialize() for special purpose.

An exporter will select the appropriate writer to a particular file. Ex: When an exporter must export an FBX 7 file, the exporter will ask for all registered writers if an FBX 7 file writer is available, then if a writer is found, the exporter will create the specialized FBX 7 writer and write the file. This way, an exporter can "write" many different type of files like FBX 5/6/7, 3DS, Obj, Dxf, Collada, etc.

See also:

KFbxWriter

Typical workflow for using the KFbxExporter class:

1. create a SDKManager
2. create an IOSettings object
3. create an empty scene
4. create an exporter
5. initialize it with a file name
6. set numerous options to control how the exporter will behave.
   ex: set IOSettings values to export Materials or Textures.
7. call KFbxExporter::Export() with the entity to export.

 // ex:
 // create a SdkManager
 KFbxSdkManager *lSdkManager = KFbxSdkManager::Create();

 // create an IOSettings object
 KFbxIOSettings * ios = KFbxIOSettings::Create(lSdkManager, IOSROOT );

 // set some IOSettings options 
 ios->SetBoolProp(EXP_FBX_MATERIAL, true);
 ios->SetBoolProp(EXP_FBX_TEXTURE,  true);

 // create an empty scene
 KFbxScene* lScene = KFbxScene::Create(lSdkManager,"");

 // create an exporter.
 KFbxExporter* lExporter = KFbxExporter::Create(lSdkManager, "");

 // initialize the exporter by providing a filename and the IOSettings to use
 lExporter->Initialize("C:\\myfile.fbx", -1, ios);

 // export the scene.
 lExporter->Export(lScene); 
  
 // destroy the exporter
 lExporter->Destroy();

Remarks:

According to the file suffix, a specialized writer will be created internally.
Ex: for .fbx files a FBX Writer, for .3ds files, a 3ds writer, etc.
Supported files formats: FBX 5/6/7 Binary & ASCII, Collada, DXF, OBJ, 3DS

Definition at line 136 of file kfbxexporter.h.

Export Functions
virtual bool	Initialize (const char *pFileName, int pFileFormat=-1, KFbxIOSettings *pIOSettings=NULL)
	Initialize object.
bool	GetExportOptions ()
	Setup file export options settings.
KFbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
void	SetIOSettings (KFbxIOSettings *pIOSettings)
	Set the IOSettings pointer.
bool	Export (KFbxDocument *pDocument, bool pNonBlocking=false)
	Export the document to the currently created file.
bool	IsExporting (bool &pExportResult)
	Check if the exporter is currently exporting.
float	GetProgress (KString &pStatus)
	Get the progress status in non-blocking mode.
void	SetProgressCallback (KFbxProgressCallback pHandler)
	Register a callback function for progress reporting in single thread mode.
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 FBX 5.3 and lower).
void	SetDefaultRenderResolution (KString pCamName, KString pResolutionMode, double pW, double pH)
	Set the default rendering resolution.
KFbxFileHeaderInfo *	GetFileHeaderInfo ()
	Get the complete file header information.

---

Member Function Documentation

virtual bool Initialize	(	const char *	pFileName,
		int	pFileFormat = -1,
		KFbxIOSettings *	pIOSettings = NULL
	)			[virtual]

Initialize object.

Parameters:

	pFileName	Name of file to access.
	pFileFormat	file format identifier User does not need to specify it by default. if not specified, plugin will detect the file format according to file suffix automatically.
	pIOSettings	client IOSettings, if not specified, a default IOSettings will be created

Returns:

true on success, false otherwise.

Remarks:

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

bool GetExportOptions

(

)

Setup file export options settings.

Returns:

true on success, false otherwise.

KFbxIOSettings* GetIOSettings

(

)

Access to a IOSettings object.

Returns:

The pointer to IOSettings or NULL if the object has not been allocated.

void SetIOSettings

(

KFbxIOSettings *

pIOSettings

)

Set the IOSettings pointer.

Parameters:

pIOSettings

Pointer on a KFbxIOSettings object.

bool Export	(	KFbxDocument *	pDocument,
		bool	pNonBlocking = false
	)

Export the document to the currently created file.

Parameters:

	pDocument	Document to export.
	pNonBlocking	If true, the export process will be executed in a new thread, allowing it to be non-blocking. To determine if the export finished, refer to the function IsExporting().

Returns:

true on success, false otherwise.

Remarks:

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

bool IsExporting

(

bool &

pExportResult

)

Check if the exporter is currently exporting.

Parameters:

pExportResult

This parameter, after the export finished, will contain the result of the export success or failure.

Returns:

Return true if the exporter is currently exporting.

Remarks:

This function will always return false if Export() was called with pNonBlocking set to false. This function should be used only in the context of pNonBlocking set to true. It is very important to periodically check if the export finished using this function, since it will also free up the thread's allocations when its done.

float GetProgress

(

KString &

pStatus

)

Get the progress status in non-blocking mode.

Parameters:

pStatus

KString reference to retrieve current status

Returns:

Percentage of the finished workload

void SetProgressCallback

(

KFbxProgressCallback

pHandler

)

Register a callback function for progress reporting in single thread mode.

Parameters:

pHandler

Pointer of the callback function.

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** string array of writable versions

Remarks:

the strings returned match the writers registered for the current format ex: "FBX" for format 0, "DXF" for format 1, etc

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:

true if mode is set correctly

void SetResamplingRate

(

double

pResamplingRate

)

[inline]

Set the resampling rate (only used when exporting to FBX 5.3 and lower).

Parameters:

pResamplingRate

resampling rate

Definition at line 236 of file kfbxexporter.h.

void SetDefaultRenderResolution	(	KString	pCamName,
		KString	pResolutionMode,
		double	pW,
		double	pH
	)

Set the default rendering resolution.

Parameters:

	pCamName	name of the camera.
	pResolutionMode	resolution mode.
	pW	width.
	pH	height.

KFbxFileHeaderInfo* GetFileHeaderInfo

(

)

Get the complete file header information.

Returns:

valid pointer to the complete header information