This reference page is linked to from the following overview topics: Customizing File Formats with FBX SDK I/O Plug-ins, Customizing the FBX SDK, Customizing File Formats.

Detailed Description

Base class of other writers used internally.

This class provides the interfaces for writing files.

The role of the writer is to effectively "write" specific file data vs the role of the exporter is to select a specific writer and launch the writing of a file through that writer.

See also:: FbxExporter

ex:

FbxWriterFbx5 can write FBX 5 format files
FbxWriterFbx6 can write FBX 6 format files
FbxWriterFbx7 can write FBX 7 format files
FbxWriterCollada can write Collada files
FbxWriterDxf can write Dxf files
... etc.

A SDK user should - normally - not use this class, except if a custom writer must be created for plug-in extension, then FbxWriter must be the base class for the new custom writer in that particular situation.

Definition at line 58 of file fbxwriter.h.

#include <fbxwriter.h>

Inheritance diagram for FbxWriter:

[legend]

List of all members.

Public Types
enum	EInfoRequest { eInfoExtension, eInfoDescriptions, eInfoVersions, eInfoCompatibleDesc, eInfoUILabel, eReserved1 = 0xFBFB }
	Information type to request. More...
typedef FbxWriter (	CreateFuncType )(FbxManager &pManager, FbxExporter &pExporter, int pSubID, int pPluginID)
	Helper typedef for passing FbxWriter creator function as argument (used internally).
typedef void(*	IOSettingsFillerFuncType )(FbxIOSettings &pIOS)
	Helper typedef for passing FbxIOSettings creator function as argument (used internally).
typedef void (	GetInfoFuncType )(EInfoRequest pRequest, int pWriterTypeId)
	Helper typedef for passing EInfoRequest function as argument (used internally).
Public Member Functions
	FbxWriter (FbxManager &pManager, int pID, FbxStatus &pStatus)
	Constructor.
virtual	~FbxWriter ()
	Destructor.
virtual bool	FileCreate (char *pFileName)=0
	Creates a new file.
virtual bool	FileCreate (FbxStream pStream, void pStreamData)
	Creates a new file via a stream.
virtual bool	FileClose ()=0
	Closes the file.
virtual bool	IsFileOpen ()=0
	Test if the file is open.
virtual void	GetWriteOptions ()=0
	Setup write options.
virtual bool	Write (FbxDocument *pDocument)=0
	Writes content to the specified file with given stream options.
virtual bool	PreprocessScene (FbxScene &pScene)=0
	Pre-processes the scene.
virtual bool	PostprocessScene (FbxScene &pScene)=0
	Post-processes the scene.
virtual void	PluginWriteParameters (FbxObject &pParams)
	Writes extension plug-ins name, version and parameters, so that we can remember if a plug-in was used during export.
virtual FbxNode *	FindRootNode (FbxScene &pScene)
	Finds the selected root node in the specified scene.
virtual bool	CheckSpaceInNodeNameRecursive (FbxNode *pNode, FbxString &pNodeNameList)
	Checks if there are spaces in the names of specified node (and its children nodes), and writes the returned node's name in the specified string list.
bool	SetFileExportVersion (FbxString pVersion)
	Sets the file export version as specified.
void	SetRenamingMode (FbxSceneRenamer::ERenamingMode pRenamingMode)
	Sets the renaming mode as specified.
void	SetResamplingRate (double pResamplingRate)
	Sets the resampling rate as specified.
bool	IsGenuine ()
	Test if file format is an internal plug-in .
virtual FbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
virtual void	SetIOSettings (FbxIOSettings *pIOSettings)
	Set the IOSettings pointer to be used for this writer instance.
virtual void	SetProgressHandler (FbxProgress *)
	Pass a progress handler to the writer.
virtual bool	SupportsStreams () const
	Returns true if this writer supports FbxStream I/O.
FbxStatus &	GetStatus ()
Protected Member Functions
void	PluginsWriteBegin (FbxScene &pScene)
	Function called by FBX before writing out the scene (FbxScene).
void	PluginsWrite (FbxIO &pFbx, bool pWriteObjectId)
	Function called by FBX before writing out any FBX object.
void	PluginsWriteEnd (FbxScene &pScene)
	Function called by FBX after writing out the scene (FbxScene).
FbxWriter &	operator= (FbxWriter const &)
Protected Attributes
FbxStatus &	mStatus
FbxManager &	mManager
FbxString	mFileVersion
double	mResamplingRate
	Resample rate for animation.
FbxSceneRenamer::ERenamingMode	mRenamingMode
	The mode describing from which format to which format when write FBX file.
Friends
struct	FbxWriterFbx7_Impl

Member Typedef Documentation

typedef FbxWriter*(* CreateFuncType)(FbxManager &pManager, FbxExporter &pExporter, int pSubID, int pPluginID)

eInfoExtension	To get the file ext for a writer ex: "FBX". Search for all occurrences
eInfoDescriptions	To get the file description for a writer ex:"Autodesk FBX (*.fbx)". Search for all occurrences
eInfoVersions	To get the file version for a writer ex: 7100. Search for all occurrences
eInfoCompatibleDesc	To get the file compatible description for a writer. Search for all occurrences
eInfoUILabel	To get the file UI label to show for a writer ex: file labels shown in "Open file dialog". Search for all occurrences
eReserved1	Search for all occurrences

FbxWriter	(	FbxManager &	pManager,
		int	pID,
		FbxStatus &	pStatus
	)

pManager	The FbxManager Object.
pID	Id for current writer.
pStatus	The FbxStatus object to hold error codes.

virtual bool FileCreate	(	FbxStream *	pStream,
		void *	pStreamData
	)		`[virtual]`

pStream	The stream to write to.
pStreamData	the user-defined stream data to be written.

virtual bool CheckSpaceInNodeNameRecursive	(	FbxNode *	pNode,
		FbxString &	pNodeNameList
	)		`[virtual]`

pNode	Specifies the node to check.
pNodeNameList	Specifies the string list where the node name that has spaces in it is recorded.

void PluginsWrite	(	FbxIO &	pFbx,
		bool	pWriteObjectId
	)		`[protected]`

FbxWriter Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation