Read file images stored on disk.
This class provides a simple C++ interface to the IFF i/o library (flib). A class called MIffTag is used to create the 4 byte tags that are used to distinguish the different block types within an IFF file.
|Default class constructor. |
|MIffFile (const MString &fileName)|
|Alternate class constructor. More...|
|MStatus||open (const MString &fileName)|
|Opens the file for reading. More...|
|Close the currently open file. More...|
|bool||isActive () const|
|Is the file currently active? More...|
|MStatus||beginReadGroup (MIffTag &id, MIffTag &type)|
|Opens a group for reading. More...|
|Closes group currently being read, skipping remaining data (including nested groups). More...|
|const void *||getChunk (MIffTag &chunkTag, unsigned *byteCount)|
|Opens a chunk for reading. More...|
|MStatus||beginGet (MIffTag &chunkTag, unsigned *byteCount)|
|Begin grabbing the data. More...|
|Finish grabbing the data. More...|
|int||get (void *buf, unsigned byteCount, MStatus *stat=NULL)|
|Attempt to read 'byteCount' bytes from the file into the buffer pointed to by buf. More...|
|MStatus||iffGetShort (short int &result)|
|Grabs a short from the active file. More...|
|MStatus||iffGetInt (int &result)|
|Grabs an integer from the active file. More...|
|MStatus||iffGetFloat (float &result)|
|Grabs a float from the active file. More...|
|static const char *||className ()|
|Returns the name of this class. More...|
Alternate class constructor.
Opens the specified file for reading.
|[in]||fileName||The file name (full path).|
Is the file currently active?
Opens a group for reading.
A group is composed of several chunks (sub-groups). Provides the id and type of the current group. Can be followed by several calls to chunk reading functions or to nested beginReadGroup(...) calls if needed (depending on the file structure). The function endReadGroup(...) is used to closed a group skipping remaining data (including nested groups).
|[out]||id||id of the group being read|
|[out]||type||type of the group being read|
|const void * getChunk||(||MIffTag &||chunkTag,|
Opens a chunk for reading.
A chunk is a block of unstructured data with an associated tag.
|[out]||chunkTag||chunk's associated tag|
|[out]||byteCount||number of bytes in the chunk|
|int get||(||void *||buf,|
|MStatus *||ReturnStatus =
Attempt to read 'byteCount' bytes from the file into the buffer pointed to by buf.
|[out]||buf||pointer to buffer in which to store the data read from the file.|
|[in]||byteCount||maximum number of bytes that buf can hold|
|MStatus iffGetShort||(||short int &||result||)|
|MStatus iffGetInt||(||int &||result||)|
Grabs an integer from the active file.
|[out]||result||the int value read from the file|
|MStatus iffGetFloat||(||float &||result||)|
Returns the name of this class.