KFbxIO Class Reference

#include <kfbxio.h>

Inherits KFbxObject.

Inherited by KFbxExporter, and KFbxImporter.

Inheritance diagram for KFbxIO:

Inheritance graph
List of all members.

Detailed Description

Base class for FBX file import and export.

Definition at line 75 of file kfbxio.h.

Error Management

enum  EError
 Error identifiers. More...
KError & GetError ()
 Retrieve error object.
EError GetLastErrorID ()
 Get last error code.
char * GetLastErrorString ()
 Get last error string.
void GetMessage (KString &pMessage)
 Get warning message from file reader/writer.

Public Member Functions

virtual bool Initialize (const char *pFileName)
 Initialize object.
virtual KString GetFileName ()
 Get the file name.
virtual void ProgressUpdate (char *pTitle, char *pMessage, char *pDetail, float pPercentDone)
 Progress update function.

Static Public Member Functions

static void GetCurrentVersion (int &pMajor, int &pMinor, int &pRevision)
 Get the FBX version number for this version of the FBX SDK.

Member Enumeration Documentation

enum EError

Error identifiers.

  • eFILE_CORRUPTED
  • eFILE_VERSION_NOT_SUPPORTED_YET
  • eFILE_VERSION_NOT_SUPPORTED_ANYMORE
  • eFILE_NOT_OPENED
  • eFILE_NOT_CREATED
  • eOUT_OF_DISK_SPACE
  • eUNINITIALIZED_FILENAME
  • eUNIDENTIFIED_ERROR
  • eINDEX_OUT_OF_RANGE
  • ePASSWORD_ERROR
  • eSTREAM_OPTIONS_NOT_SET
  • eEMBEDDED_OUT_OF_SPACE

Definition at line 141 of file kfbxio.h.

Member Function Documentation

static void GetCurrentVersion ( int &  pMajor,
int &  pMinor,
int &  pRevision 
) [static]

Get the FBX version number for this version of the FBX SDK.

FBX version numbers start at 5.0.0.

Parameters:
pMajor Version major number.
pMinor Version minor number.
pRevision Version revision number.

virtual bool Initialize ( const char *  pFileName  )  [virtual]

Initialize object.

Parameters:
pFileName Name of file to access.
Returns:
true if successful, false otherwise.
Remarks:
To identify the error, call KFbxIO::GetLastErrorID().

Reimplemented in KFbxExporter, and KFbxImporter.

virtual KString GetFileName (  )  [virtual]

Get the file name.

Returns:
Filename or an empty string if the filename has not been set.

virtual void ProgressUpdate ( char *  pTitle,
char *  pMessage,
char *  pDetail,
float  pPercentDone 
) [virtual]

Progress update function.

Parameters:
pTitle Title of status box.
pMessage Description of current file read/write step.
pDetail Additional string appended to previous parameter.
pPercentDone Finished percent of current file read/write.
Remarks:
Overload this function to receive an update of current file read/write.

KError& GetError (  ) 

Retrieve error object.

Returns:
Reference to error object.

EError GetLastErrorID (  ) 

Get last error code.

Returns:
Last error code.

char* GetLastErrorString (  ) 

Get last error string.

Returns:
Textual description of the last error.

void GetMessage ( KString &  pMessage  ) 

Get warning message from file reader/writer.

Parameters:
pMessage Warning message