#include <MIffFile.h>
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.
Public Member Functions | |
MIffFile () | |
MIffFile (const MString &fileName) | |
virtual | ~MIffFile () |
MStatus | open (const MString &fileName) |
MStatus | close () |
bool | isActive () const |
MStatus | beginReadGroup (MIffTag &id, MIffTag &type) |
MStatus | endReadGroup () |
const void * | getChunk (MIffTag &chunkTag, unsigned *byteCount) |
MStatus | beginGet (MIffTag &chunkTag, unsigned *byteCount) |
MStatus | endGet () |
int | get (void *buf, unsigned byteCount, MStatus *stat=NULL) |
MStatus | iffGetShort (short int &result) |
MStatus | iffGetInt (int &result) |
MStatus | iffGetFloat (float &result) |
MIffFile::MIffFile | ( | ) |
Default class constructor.
MIffFile::MIffFile | ( | const MString & | fileName | ) |
Alternate class constructor. Opens the specified file for reading.
[in] | fileName | The file name (full path). |
MIffFile::~MIffFile | ( | ) | [virtual] |
Destructor.
Opens the file for reading.
MStatus MIffFile::close | ( | ) |
Close the currently open file.
bool MIffFile::isActive | ( | ) | const |
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).
MStatus MIffFile::endReadGroup | ( | ) |
Closes group currently being read, skipping remaining data (including nested groups).
const void * MIffFile::getChunk | ( | MIffTag & | chunkTag, | |
unsigned * | byteCount | |||
) |
Opens a chunk for reading. A chunk is a block of unstructured data with an associated tag.
MStatus MIffFile::endGet | ( | ) |
int MIffFile::get | ( | void * | buf, | |
unsigned | byteCount, | |||
MStatus * | ReturnStatus = NULL | |||
) |
Attempt to read 'byteCount' bytes from the file into the buffer pointed to by buf.
MStatus MIffFile::iffGetShort | ( | short int & | result | ) |
Grabs a short from the active file.
MStatus MIffFile::iffGetInt | ( | int & | result | ) |
Grabs an integer from the active file.
MStatus MIffFile::iffGetFloat | ( | float & | result | ) |
Grabs a float from the active file.
Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. | Generated with 1.5.6 |