Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

ChunkIO Class Reference

#include <chunkio.h>

List of all members.


Detailed Description

Reads/writes chunks from/to file.

Author:
Mattias Jansson (mattias@realityrift.com)


Public Types

enum  CHUNKIOMODE { BINARY = 0, ASCII = 1 }
 File mode defines (binary or ascii). More...

enum  CHUNKIOPARSEFLAG { FIRSTBUILTINFLAG = 0x00000000, NONE = 0x00000000, STRIPIFYALL = 0x00000001, LASTBUILTINFLAG = 0x0000FFFF }
 Builtin parse flag identifiers. More...

enum  CHUNKIOVERSIONREQ { MAJORVERSIONREQUIRED = 0, MINORVERSIONREQUIRED = 30 }
 Minimum required version of chunk format. More...


Public Member Functions

 ChunkIO (CHUNKIOMODE eMode=ASCII)
ChunkReadChunk (NeoEngine::File *pkFile)
int ParseChunk (Chunk *pkChunk, unsigned int uiFlags, NeoEngine::FileManager *pkFileManager)
void WriteChunk (Chunk *pkChunk, NeoEngine::File *pkFile, unsigned int uiLevel=0)

Public Attributes

CHUNKIOMODE m_eMode
int m_iMajorVersion
int m_iMinorVersion


Member Enumeration Documentation

enum CHUNKIOMODE
 

File mode defines (binary or ascii).

Enumeration values:
BINARY  Binary file
ASCII  Text file

enum CHUNKIOPARSEFLAG
 

Builtin parse flag identifiers.

Enumeration values:
FIRSTBUILTINFLAG  First reserved flag
NONE  No flags
STRIPIFYALL  Stripify all polygon buffers
LASTBUILTINFLAG  Last reserved flag

enum CHUNKIOVERSIONREQ
 

Minimum required version of chunk format.

Enumeration values:
MAJORVERSIONREQUIRED  Major version required
MINORVERSIONREQUIRED  Minor version required


Constructor & Destructor Documentation

ChunkIO CHUNKIOMODE  eMode = ASCII  )  [inline]
 

Default to text mode


Member Function Documentation

Chunk* ReadChunk NeoEngine::File *  pkFile  ) 
 

Read chunk from file

Parameters:
pkFile File
Returns:
Chunk object read, 0 if invalid file or EOF

int ParseChunk Chunk pkChunk,
unsigned int  uiFlags,
NeoEngine::FileManager *  pkFileManager
 

Parse chunk

Parameters:
pkChunk Chunk to parse
uiFlags Parse flags
pkFileManager File manager
Returns:
<0 if error, >=0 if successful

void WriteChunk Chunk pkChunk,
NeoEngine::File *  pkFile,
unsigned int  uiLevel = 0
 

Write chunk to file

Parameters:
pkChunk Chunk to write
pkFile File
uiLevel Current recursion level (used for ascii files)


Member Data Documentation

CHUNKIOMODE m_eMode
 

File I/O mode

int m_iMajorVersion
 

Chunk format major version

int m_iMinorVersion
 

Chunk format minor version


The documentation for this class was generated from the following file:
Generated on Wed Jan 21 14:21:18 2004 for NeoChunkIO by doxygen 1.3.5