FBX C++ API Reference
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
FbxWriterCollada Class Reference

#include <fbxwritercollada14.h>

Class Description

Class to export FBX scene into a Collada file.

Definition at line 25 of file fbxwritercollada14.h.

+ Inheritance diagram for FbxWriterCollada:

Constructors and Destructor

 FbxWriterCollada (FbxManager &pManager, int pID, FbxStatus &pStatus)
 Constructor. More...
 
virtual ~FbxWriterCollada ()
 Destructor. More...
 

File Management

virtual bool FileCreate (char *pFileName)
 Create and open file with the given name. More...
 
virtual bool FileClose ()
 Close file. More...
 
virtual bool IsFileOpen ()
 Check if current file is open. More...
 

Write Functions

virtual void GetWriteOptions ()
 Get Collada export options settings. More...
 
virtual bool Write (FbxDocument *pDocument)
 Export the FBX document to Collada file, according to the given options settings. More...
 
virtual bool PreprocessScene (FbxScene &pScene)
 Process FBX scene before exporting FBX scene to Collada file. More...
 
virtual bool PostprocessScene (FbxScene &pScene)
 Process FBX scene after exporting FBX scene to Collada file. More...
 

Additional Inherited Members

- 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 inherited from FbxWriter
 FbxWriter (FbxManager &pManager, int pID, FbxStatus &pStatus)
 Constructor. More...
 
virtual ~FbxWriter ()
 Destructor. More...
 
virtual bool FileCreate (FbxStream *pStream, void *pStreamData)
 Creates a new file via a stream. 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 FbxNodeFindRootNode (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 FbxIOSettingsGetIOSettings ()
 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...
 
virtual bool SupportsStreams () const
 Returns true if this writer supports FbxStream I/O. More...
 
- 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...
 

Constructor & Destructor Documentation

◆ FbxWriterCollada()

FbxWriterCollada ( FbxManager pManager,
int  pID,
FbxStatus pStatus 
)

Constructor.

Parameters
pManagerFBX SDK object Manager.
pIDInternal ID.
pStatusThe FbxStatus object to hold error codes.

◆ ~FbxWriterCollada()

virtual ~FbxWriterCollada ( )
virtual

Destructor.

Member Function Documentation

◆ FileCreate()

virtual bool FileCreate ( char *  pFileName)
virtual

Create and open file with the given name.

Parameters
pFileNamethe name of file.
Returns
Return true if the specified file is created and opened.

Implements FbxWriter.

◆ FileClose()

virtual bool FileClose ( )
virtual

Close file.

Returns
Return true if file is closed successfully, false otherwise.

Implements FbxWriter.

◆ IsFileOpen()

virtual bool IsFileOpen ( )
virtual

Check if current file is open.

Returns
Return true if file is open, false otherwise.

Implements FbxWriter.

◆ GetWriteOptions()

virtual void GetWriteOptions ( )
inlinevirtual

Get Collada export options settings.

Implements FbxWriter.

Definition at line 75 of file fbxwritercollada14.h.

75 {}

◆ Write()

virtual bool Write ( FbxDocument pDocument)
virtual

Export the FBX document to Collada file, according to the given options settings.

Parameters
pDocumentFBX Document to export.
Returns
true on success, false otherwise.

Implements FbxWriter.

◆ PreprocessScene()

virtual bool PreprocessScene ( FbxScene pScene)
virtual

Process FBX scene before exporting FBX scene to Collada file.

Parameters
pScenethe FBX scene to precess.
Returns
Return true if the given scene is processed successfully.
Remarks
This function is processing name clash, special transformation conversion etc.

Implements FbxWriter.

◆ PostprocessScene()

virtual bool PostprocessScene ( FbxScene pScene)
virtual

Process FBX scene after exporting FBX scene to Collada file.

Parameters
pScenethe FBX scene to precess.
Returns
Return true if the given scene is processed successfully.

Implements FbxWriter.


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