FbxStream Class Reference
This reference page is linked to from the following overview topics: FBX SDK 2014.
#include <fbxstream.h>
Abstract class for implementing I/O operations through a stream of data.
For instance, it can be used to read data from a memory source, thus making it possible to import files from memory. However, for the time being, the FbxStream class is only supported with FBX files.
Definition at line 26 of file fbxstream.h.
Public Types |
|
| enum | EState { eClosed, eOpen, eEmpty } |
| Current stream state. More... |
|
Public Member Functions |
|
| virtual EState | GetState ()=0 |
| Query the current state of the stream.
|
|
| virtual bool | Open (void *pStreamData)=0 |
| Open the stream. |
|
| virtual bool | Close ()=0 |
| Close the stream. |
|
| virtual bool | Flush ()=0 |
| Empties the internal data of the stream.
|
|
| virtual int | Write (const void *, int)=0 |
| Writes a memory block. |
|
| virtual int | Read (void *, int) const =0 |
| Read bytes from the stream and store them in
the memory block. |
|
| virtual char * | ReadString (char *pBuffer, int pMaxSize, bool pStopAtFirstWhiteSpace=false) |
| Read a string from the stream. |
|
| virtual int | GetReaderID () const =0 |
| If not specified by
KFbxImporter::Initialize(), the importer will ask the stream to
select an appropriate reader ID to associate with the stream.
|
|
| virtual int | GetWriterID () const =0 |
| If not specified by
KFbxExporter::Initialize(), the exporter will ask the stream to
select an appropriate writer ID to associate with the stream.
|
|
| virtual void | Seek (const FbxInt64 &pOffset, const FbxFile::ESeekPos &pSeekPos)=0 |
| Adjust the current stream position. |
|
| virtual long | GetPosition () const =0 |
| Get the current stream position. |
|
| virtual void | SetPosition (long pPosition)=0 |
| Set the current stream position. |
|
| virtual int | GetError () const =0 |
| Return 0 if no errors occurred. |
|
| virtual void | ClearError ()=0 |
| Clear current error condition by setting the
current error value to 0. |
|
| enum EState |
Current stream state.
Definition at line 30 of file fbxstream.h.
| virtual EState GetState | ( | ) | [pure virtual] |
Query the current state of the stream.
| virtual bool Open | ( | void * | pStreamData | ) | [pure virtual] |
Open the stream.
| virtual bool Close | ( | ) | [pure virtual] |
Close the stream.
| virtual bool Flush | ( | ) | [pure virtual] |
| virtual int Write | ( | const void * | , |
| int | |||
| ) | [pure virtual] |
Writes a memory block.
| pData | Pointer to the memory block to write. |
| pSize | Size (in bytes) of the memory block to write. |
| virtual int Read | ( | void * | , |
| int | |||
| ) | const [pure virtual] |
Read bytes from the stream and store them in the memory block.
| pData | Pointer to the memory block where the read bytes are stored. |
| pSize | Number of bytes read from the stream. |
| virtual char* ReadString | ( | char * | pBuffer, |
| int | pMaxSize, | ||
| bool | pStopAtFirstWhiteSpace =
false |
||
| ) | [virtual] |
Read a string from the stream.
The default implementation is written in terms of Read() but does not cope with DOS line endings. Subclasses may need to override this if DOS line endings are to be supported.
| pData | Pointer to the memory block where the read bytes are stored. |
| pMaxSize | Maximum number of bytes to be read from the stream. |
| pStopAtFirstWhiteSpace | Stop reading when any whitespace is encountered. Otherwise read to end of line (like fgets()). |
| virtual int GetReaderID | ( | ) | const [pure virtual] |
If not specified by KFbxImporter::Initialize(), the importer will ask the stream to select an appropriate reader ID to associate with the stream.
FbxIOPluginRegistry can be used to locate id by extension or description. Return -1 to allow FBX to select an appropriate default.
| virtual int GetWriterID | ( | ) | const [pure virtual] |
If not specified by KFbxExporter::Initialize(), the exporter will ask the stream to select an appropriate writer ID to associate with the stream.
KFbxIOPluginRegistry can be used to locate id by extension or description. Return -1 to allow FBX to select an appropriate default.
| virtual void Seek | ( | const FbxInt64 & | pOffset, |
| const FbxFile::ESeekPos & | pSeekPos | ||
| ) | [pure virtual] |
Adjust the current stream position.
| pSeekPos | Pre-defined position where offset is added (FbxFile::eBegin, FbxFile::eCurrent:, FbxFile::eEnd) |
| pOffset | Number of bytes to offset from pSeekPos. |
| virtual long GetPosition | ( | ) | const [pure virtual] |
Get the current stream position.
| virtual void SetPosition | ( | long | pPosition | ) | [pure virtual] |
Set the current stream position.
| pPosition | Number of bytes from the beginning of the stream to seek to. |
| virtual int GetError | ( | ) | const [pure virtual] |
Return 0 if no errors occurred.
Otherwise, return 1 to indicate an error. This method will be invoked whenever FBX needs to verify that the last operation succeeded.
| virtual void ClearError | ( | ) | [pure virtual] |
Clear current error condition by setting the current error value to 0.