FbxWriterFbx5 Class Reference

#include <fbxwriterfbx5.h>

Class Description

Definition at line 23 of file fbxwriterfbx5.h.

Inheritance diagram for FbxWriterFbx5:

Public Types
enum	EExportMode { eASCII, eBINARY, eENCRYPTED }
Public Types inherited from FbxWriter
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). More...
typedef void(*	IOSettingsFillerFuncType) (FbxIOSettings &pIOS)
	Helper typedef for passing FbxIOSettings creator function as argument (used internally). More...
typedef void *(*	GetInfoFuncType) (EInfoRequest pRequest, int pWriterTypeId)
	Helper typedef for passing EInfoRequest function as argument (used internally). More...

Public Member Functions
	FbxWriterFbx5 (FbxManager &pManager, FbxExporter &pExporter, int pID, FbxStatus &pStatus)
virtual	~FbxWriterFbx5 ()
virtual bool	FileCreate (char *pFileName)
	Creates a new file. More...
virtual bool	FileCreate (FbxStream *pStream, void *pStreamData)
	Creates a new file via a stream. More...
virtual bool	FileClose ()
	Closes the file. More...
virtual bool	IsFileOpen ()
	Test if the file is open. More...
void	SetExportMode (EExportMode pMode)
virtual void	GetWriteOptions ()
	Setup write options. More...
virtual bool	Write (FbxDocument *pDocument)
	Writes content to the specified file with given stream options. More...
virtual bool	Write (FbxDocument *pDocument, FbxIO *pFbx)
virtual bool	PreprocessScene (FbxScene &pScene)
	Pre-processes the scene. More...
virtual bool	PostprocessScene (FbxScene &pScene)
	Post-processes the scene. More...
virtual bool	SupportsStreams () const
	Returns true if this writer supports FbxStream I/O. More...
Public Member Functions inherited from FbxWriter
	FbxWriter (FbxManager &pManager, int pID, FbxStatus &pStatus)
	Constructor. More...
virtual	~FbxWriter ()
	Destructor. More...
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. More...
virtual FbxNode *	FindRootNode (FbxScene &pScene)
	Finds the selected root node in the specified scene. More...
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. More...
bool	SetFileExportVersion (FbxString pVersion)
	Sets the file export version as specified. More...
void	SetRenamingMode (FbxSceneRenamer::ERenamingMode pRenamingMode)
	Sets the renaming mode as specified. More...
void	SetResamplingRate (double pResamplingRate)
	Sets the resampling rate as specified. More...
bool	IsGenuine ()
	Test if file format is an internal plug-in . More...
virtual FbxIOSettings *	GetIOSettings ()
	Access to a IOSettings object. More...
virtual void	SetIOSettings (FbxIOSettings *pIOSettings)
	Set the IOSettings pointer to be used for this writer instance. More...
virtual void	SetProgressHandler (FbxProgress *)
	Pass a progress handler to the writer. More...

Additional Inherited Members
Protected Member Functions inherited from FbxWriter
void	PluginsWriteBegin (FbxScene &pScene)
	Function called by FBX before writing out the scene (FbxScene). More...
void	PluginsWrite (FbxIO &pFbx, bool pWriteObjectId)
	Function called by FBX before writing out any FBX object. More...
void	PluginsWriteEnd (FbxScene &pScene)
	Function called by FBX after writing out the scene (FbxScene). More...

Member Enumeration Documentation

EExportMode

enum EExportMode

Enumerator
eASCII
eBINARY
eENCRYPTED

Definition at line 34 of file fbxwriterfbx5.h.

    {
        eASCII,
        eBINARY,
        eENCRYPTED
    } EExportMode;

Constructor & Destructor Documentation

FbxWriterFbx5()

FbxWriterFbx5	(	FbxManager &	pManager,
		FbxExporter &	pExporter,
		int	pID,
		FbxStatus &	pStatus
	)

~FbxWriterFbx5()

virtual ~FbxWriterFbx5 ( )

virtual

Member Function Documentation

FileCreate() [1/2]

virtual bool FileCreate ( char *  pFileName )

virtual

Creates a new file.

Parameters

pFileName

The name of the newly created file.

Implements FbxWriter.

FileCreate() [2/2]

virtual bool FileCreate ( FbxStream *  pStream, void *  pStreamData  )

virtual

Creates a new file via a stream.

Parameters

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

Reimplemented from FbxWriter.

FileClose()

virtual bool FileClose ( )

virtual

Closes the file.

Implements FbxWriter.

IsFileOpen()

virtual bool IsFileOpen ( )

virtual

Test if the file is open.

Implements FbxWriter.

SetExportMode()

void SetExportMode

(

EExportMode

pMode

)

GetWriteOptions()

virtual void GetWriteOptions ( )

virtual

Setup write options.

Implements FbxWriter.

Write() [1/2]

virtual bool Write ( FbxDocument *  pDocument )

virtual

Writes content to the specified file with given stream options.

Parameters

pDocument

FbxDocument to write file data to.

Implements FbxWriter.

Write() [2/2]

virtual bool Write ( FbxDocument *  pDocument, FbxIO *  pFbx  )

virtual

PreprocessScene()

virtual bool PreprocessScene ( FbxScene &  pScene )

virtual

Pre-processes the scene.

Parameters

pScene

The scene needs to be pre-processed.

Implements FbxWriter.

PostprocessScene()

virtual bool PostprocessScene ( FbxScene &  pScene )

virtual

Post-processes the scene.

Parameters

pScene

The scene needs to be post-processed.

Implements FbxWriter.

SupportsStreams()

virtual bool SupportsStreams ( ) const

inlinevirtual

Returns true if this writer supports FbxStream I/O.

Default value is false.

Reimplemented from FbxWriter.

Definition at line 50 of file fbxwriterfbx5.h.

{ return true; }

---

The documentation for this class was generated from the following file:

• fbxsdk/fileio/fbx/fbxwriterfbx5.h