This reference page is linked to from the following overview topics: Importing a Scene, Exporting a Scene, FBX SDK Object Model, FBX Objects, List of Python FBX classes.
Detailed Description
#include <kfbxio.h>
Inheritance diagram for KFbxIO:
Public Member Functions |
|
| virtual bool | Initialize (const char *pFileName) |
| Initializes the object. |
|
| virtual KString | GetFileName () |
| Returns the file name. |
|
Protected Member Functions |
|
| KFbxIO (KFbxSdkManager &pManager, char const *pName) | |
| int | DetectReaderFileFormat (const char *pFileName) |
| int | DetectWriterFileFormat (const char *pFileName) |
Protected Attributes |
|
| KError | mError |
| KString | mFilename |
| KFbxSdkManager * | mManager |
| KString | mMessage |
Error Management |
|
| enum | EError
{ 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, eEMBEDDED_OUT_OF_SPACE, eERROR_COUNT } |
|
Error identifiers. More... |
|
| KError & | GetError () |
| Retrieves the error object. |
|
| EError | GetLastErrorID () const |
| Returns the last error code. |
|
| const char * | GetLastErrorString () const |
| Returns the last error string. |
|
| void | GetMessage (KString &pMessage) const |
| Returns the warning message from the file
Reader and Writer. |
|
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
- eEMBEDDED_OUT_OF_SPACE
Constructor & Destructor Documentation
| KFbxIO | ( | KFbxSdkManager & | pManager, |
| char const * | pName | ||
| ) | [protected] |
Member Function Documentation
| virtual bool Initialize | ( | const char * | pFileName | ) | [virtual] |
Initializes the object.
- Parameters:
-
pFileName The name of the file to access.
- Returns:
Trueif successful, returnsfalseotherwise.
- Remarks:
- To identify the error, call KFbxIO::GetLastErrorID().
| virtual KString GetFileName | ( | ) | [virtual] |
Returns the file name.
- Returns:
- The file name or an empty string if no filename has been set.
- Examples:
- ViewScene/main.cxx.
| KError& GetError | ( | ) |
| EError GetLastErrorID | ( | ) | const |
Returns the last error code.
- Returns:
- The last error code.
- Examples:
- Common/Common.cxx, and UIExamples/Common/ImportExport.cxx.
| const char* GetLastErrorString | ( | ) | const |
Returns the last error string.
- Returns:
- A textual description of the last error.
| void GetMessage | ( | KString & | pMessage | ) | const |
Returns the warning message from the file Reader and Writer.
- Parameters:
-
pMessage The warning message.
| int DetectReaderFileFormat | ( | const char * | pFileName | ) | [protected] |
| int DetectWriterFileFormat | ( | const char * | pFileName | ) | [protected] |
Member Data Documentation
KFbxSdkManager* mManager
[protected] |
The documentation for this class was generated from the following file:
- fbxfilesdk/kfbxio/kfbxio.h
