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

ex:

KFbxWriterFbx can write FBX 5 format files
KFbxWriterFbx6 can write FBX 6 format files
KFbxWriterFbx7 can write FBX 7 format files
KFbxWriterCollada can write Collada files
KFbxWriterDxf 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 KFbxWriter must be the base class for the new custom writer in that particular situation.

Examples:: MyOwnWriterReader/MyOwnWriter.cxx, MyOwnWriterReader/MyOwnWriter.h, MyOwnWriterReader/MyOwnWriterReader.cxx, and MyOwnWriterReader/MyOwnWriterReader.h.

Definition at line 62 of file kfbxwriter.h.

#include <kfbxwriter.h>

List of all members.

Public Types
enum	EError { eFILE_CORRUPTED, eFILE_NOT_OPENED, eFILE_NOT_CREATED, eOUT_OF_DISK_SPACE, eINVALID_DOCUMENT_HANDLE, eDOCUMENT_NOT_SUPPORTED, eUNIDENTIFIED_ERROR, eEMBEDDED_OUT_OF_SPACE, eERROR_COUNT }
	Error identifiers. More...
enum	KInfoRequest { eInfoExtension, eInfoDescriptions, eInfoVersions, eInfoCompatibleDesc, eInfoUILabel, eReserved1 = 0xFBFB }
	Information type to request. More...
typedef KFbxWriter (	CreateFuncType )(KFbxSdkManager &pManager, KFbxExporter &pExporter, int pSubID, int pPluginID)
	Helper typedef for passing KFbxWriter creator function as argument (used internally).
typedef void(*	IOSettingsFillerFuncType )(KFbxIOSettings &pIOS)
	Helper typedef for passing KFbxIOSettings creator function as argument (used internally).
typedef void (	GetInfoFuncType )(KInfoRequest pRequest, int pWriterTypeId)
	Helper typedef for passing KInfoRequest function as argument (used internally).
Public Member Functions
	KFbxWriter (KFbxSdkManager &pManager, int pID)
	Constructor.
virtual	~KFbxWriter ()
	Destructor.
virtual bool	FileCreate (char *pFileName)=0
	Creates a new file.
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 (KFbxDocument *pDocument)=0
	Writes content to the specified file with given stream options.
virtual bool	PreprocessScene (KFbxScene &pScene)=0
	Pre-processes the scene.
virtual bool	PostprocessScene (KFbxScene &pScene)=0
	Post-processes the scene.
virtual void	PluginWriteParameters (KFbxObject &pParams)
	Writes extension plug-ins name, version and parameters, so that we can remember if a plug-in was used during export.
virtual KFbxNode *	FindRootNode (KFbxScene &pScene)
	Finds the selected root node in the specified scene.
virtual bool	CheckSpaceInNodeNameRecursive (KFbxNode *pNode, KString &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 (KString pVersion)
	Sets the file export version as specified.
void	SetRenamingMode (KFbxSceneRenamer::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 .
KError &	GetError ()
	Returns error object(s).
EError	GetLastErrorID () const
	Returns the ID of the last error that occurred when the file was written.
const char *	GetLastErrorString () const
	Returns the error string that describes the last error that occurred when the file was written.
void	GetMessage (KString &pMessage) const
	Returns a warning message that describes what occurred when the file was written.
KString &	GetMessage ()
	Returns a warning message that describes what occurred when the file was written.
void	ClearMessage ()
	Empties the message string.
virtual KFbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object.
virtual void	SetIOSettings (KFbxIOSettings *pIOSettings)
	Set the IOSettings pointer to be used for this writer instance.
virtual void	SetProgressHandler (KFbxProgress *pProgress)
	Pass a progress handler to the writer.
Protected Member Functions
void	PluginsWriteBegin (KFbxScene &pScene)
	Function called by FBX before writing out the scene (KFbxScene).
void	PluginsWrite (KFbx &pFbx, bool pWriteObjectId)
	Function called by FBX before writing out any FBX object.
void	PluginsWriteEnd (KFbxScene &pScene)
	Function called by FBX after writing out the scene (KFbxScene).
KFbxWriter &	operator= (KFbxWriter const &)
Protected Attributes
KFbxSdkManager &	mManager
KString	mFileVersion
double	mResamplingRate
	Resample rate for animation.
KFbxSceneRenamer::ERenamingMode	mRenamingMode
	The mode describing from which format to which format when write FBX file.
Friends
struct	KFbxWriterFbx7Impl

Member Typedef Documentation

typedef KFbxWriter*(* CreateFuncType)(KFbxSdkManager &pManager, KFbxExporter &pExporter, int pSubID, int pPluginID)

eFILE_CORRUPTED	Search for all occurrences
eFILE_NOT_OPENED	Search for all occurrences
eFILE_NOT_CREATED	Search for all occurrences
eOUT_OF_DISK_SPACE	Search for all occurrences
eINVALID_DOCUMENT_HANDLE	Search for all occurrences
eDOCUMENT_NOT_SUPPORTED	Search for all occurrences
eUNIDENTIFIED_ERROR	Search for all occurrences
eEMBEDDED_OUT_OF_SPACE	Search for all occurrences
eERROR_COUNT	Search for all occurrences

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

virtual bool CheckSpaceInNodeNameRecursive	(	KFbxNode *	pNode,
		KString &	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	(	KFbx &	pFbx,
		bool	pWriteObjectId
	)		`[protected]`

pManager	The KFbxSdkManager Object.
pID	Id for current writer.

KFbxWriter 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