Cortex  10.0.0-a4
Public Types | Public Member Functions | Friends | List of all members
IECore::IFFFile::Chunk Class Reference

#include <IFFFile.h>

Public Types

typedef std::vector< Chunk >::iterator ChunkIterator
 

Public Member Functions

Tag type ()
 
unsigned int dataSize ()
 
bool isGroup ()
 
Tag groupName ()
 
ChunkIterator childrenBegin ()
 
ChunkIterator childrenEnd ()
 
template<typename T >
void read (T &data)
 read Chunk data as a single value
 
void read (std::string &data)
 read Chunk data as a string
 
template<typename T >
size_t read (std::vector< T > &data)
 read Chunk data as a vector of values
 
template<typename T >
size_t read (std::vector< Imath::Vec3< T > > &data)
 read Chunk data as a vector of Imath::Vec3 values
 

Friends

class IFFFile
 

Detailed Description

A Chunk is the most basic structure in an IFF file. It consists of a Tag, an integer representing it's data size, and dataSize number of bytes of arbitrary data. If the Chunk is a group, it will have an additional Tag indicating the group name. Groups may contain child Chunks which can be accesed through the ChunkIterators.

Todo:
: the current implementation only supports reading. It may not be well suited for writing.

The documentation for this class was generated from the following file: