Class 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:: FbxWriter

Typical workflow for using the FbxExporter class:

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

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

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

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

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

 // create an exporter.
 FbxExporter* lExporter = FbxExporter::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

Examples:: Common/Common.cxx, ConvertScene/main.cxx, ExportDocument/main.cxx, ExportScene05/main.cxx, MyOwnWriterReader/MyOwnWriterReader.cxx, MyOwnWriterReader/MyOwnWriterReader.h, UI_Examples/Common/ImportExport.cxx, and UI_Examples/CubeCreator/SDK_Utility.cxx.

Definition at line 89 of file fbxexporter.h.

Inheritance diagram for FbxExporter:

List of all members.

Export Functions
virtual bool	Initialize (const char pFileName, int pFileFormat=-1, FbxIOSettings pIOSettings=NULL)
	Initialize object.
virtual bool	Initialize (FbxStream pStream, void pStreamData=NULL, int pFileFormat=-1, FbxIOSettings *pIOSettings=NULL)
	Initialize object.
bool	GetExportOptions ()
	Setup file export options settings.
FbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
void	SetIOSettings (FbxIOSettings *pIOSettings)
	Set the IOSettings pointer.
bool	Export (FbxDocument *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 (FbxString *pStatus=NULL)
	Get the progress status in non-blocking mode.
void	SetProgressCallback (FbxProgressCallback pCallback, void *pArgs=NULL)
	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.
const char *	GetCurrentWritableVersions ()
	Get writable version for the current file format.
bool	SetFileExportVersion (FbxString pVersion, FbxSceneRenamer::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 (FbxString pCamName, FbxString pResolutionMode, double pW, double pH)
	Set the default rendering resolution.
FbxIOFileHeaderInfo *	GetFileHeaderInfo ()
	Get the complete file header information.

Member Function Documentation

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

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

virtual bool Initialize	(	FbxStream *	pStream,
		void *	pStreamData = `NULL`,
		int	pFileFormat = `-1`,
		FbxIOSettings *	pIOSettings = `NULL`
	)		`[virtual]`

pStream	stream to access.
pStreamData	user-defined stream data.
pFileFormat	file format identifier User does not need to specify it by default. if not specified, plugin will request the file format from the stream.
pIOSettings	client IOSettings, if not specified, a default IOSettings will be created

bool Export	(	FbxDocument *	pDocument,
		bool	pNonBlocking = `false`
	)

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().

void SetProgressCallback	(	FbxProgressCallback	pCallback,
		void *	pArgs = `NULL`
	)

pCallback	Pointer of the callback function.
pArgs	Pointer to the arguments passed to the callback function.

bool SetFileExportVersion	(	FbxString	pVersion,
		FbxSceneRenamer::ERenamingMode	pRenamingMode
	)

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

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

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

Class Description

Export Functions

File Format

Member Function Documentation