Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::Serializer Class Reference

Generic class for serialising data to / from binary chunk-based files. More...

#include <OgreSerializer.h>

Inheritance diagram for Ogre::Serializer:

Ogre::MeshSerializer Ogre::SkeletonSerializer List of all members.

Public Methods

 Serializer ()
virtual ~Serializer ()

Protected Methods

virtual void writeFileHeader (void)
virtual void writeChunkHeader (unsigned short id, unsigned long size)
void writeReals (const Real *pReal, unsigned short count)
void writeShorts (const unsigned short *pShort, unsigned short count)
void writeLongs (const unsigned long *pLong, unsigned short count)
void writeBools (const bool *pLong, unsigned short count)
void writeObject (const Vector3 &vec)
void writeObject (const Quaternion &q)
void writeString (const String &string)
void writeData (const void *buf, size_t size, size_t count)
virtual void readFileHeader (DataChunk &chunk)
virtual unsigned short readChunk (DataChunk &chunk)
void readBools (DataChunk &chunk, bool *pDest, unsigned short count)
void readReals (DataChunk &chunk, Real *pDest, unsigned short count)
void readShorts (DataChunk &chunk, unsigned short *pDest, unsigned short count)
void readLongs (DataChunk &chunk, unsigned long *pDest, unsigned short count)
void readObject (DataChunk &chunk, Vector3 *pDest)
void readObject (DataChunk &chunk, Quaternion *pDest)
String readString (DataChunk &chunk)
void flipToLittleEndian (void *pData, size_t size, unsigned short count=1)
void flipFromLittleEndian (void *pData, size_t size, unsigned short count=1)
void flipEndian (void *pData, size_t size, unsigned short count)
void flipEndian (void *pData, size_t size)

Protected Attributes

unsigned long mCurrentChunkLen
FILE * mpfFile
String mVersion

Detailed Description

Generic class for serialising data to / from binary chunk-based files.

Remarks:
This class provides a number of useful methods for exporting / importing data from chunk-oriented binary files (e.g. .mesh and .skeleton).

Constructor & Destructor Documentation

Ogre::Serializer::Serializer (    ) 
 

Ogre::Serializer::~Serializer (    )  [virtual]
 

Member Function Documentation

void Ogre::Serializer::flipEndian (  void *    pData,
size_t    size
)  [protected]
 

void Ogre::Serializer::flipEndian (  void *    pData,
size_t    size,
unsigned short    count
)  [protected]
 

void Ogre::Serializer::flipFromLittleEndian (  void *    pData,
size_t    size,
unsigned short    count = 1
)  [protected]
 

void Ogre::Serializer::flipToLittleEndian (  void *    pData,
size_t    size,
unsigned short    count = 1
)  [protected]
 

void Ogre::Serializer::readBools (  DataChunk &    chunk,
bool *    pDest,
unsigned short    count
)  [protected]
 

unsigned short Ogre::Serializer::readChunk (  DataChunk &    chunk )  [protected, virtual]
 

void Ogre::Serializer::readFileHeader (  DataChunk &    chunk )  [protected, virtual]
 

void Ogre::Serializer::readLongs (  DataChunk &    chunk,
unsigned long *    pDest,
unsigned short    count
)  [protected]
 

void Ogre::Serializer::readObject (  DataChunk &    chunk,
Quaternion *    pDest
)  [protected]
 

void Ogre::Serializer::readObject (  DataChunk &    chunk,
Vector3 *    pDest
)  [protected]
 

void Ogre::Serializer::readReals (  DataChunk &    chunk,
Real *    pDest,
unsigned short    count
)  [protected]
 

void Ogre::Serializer::readShorts (  DataChunk &    chunk,
unsigned short *    pDest,
unsigned short    count
)  [protected]
 

String Ogre::Serializer::readString (  DataChunk &    chunk )  [protected]
 

void Ogre::Serializer::writeBools (  const bool *    pLong,
unsigned short    count
)  [protected]
 

void Ogre::Serializer::writeChunkHeader (  unsigned short    id,
unsigned long    size
)  [protected, virtual]
 

void Ogre::Serializer::writeData (  const void *    buf,
size_t    size,
size_t    count
)  [protected]
 

void Ogre::Serializer::writeFileHeader (  void    )  [protected, virtual]
 

void Ogre::Serializer::writeLongs (  const unsigned long *    pLong,
unsigned short    count
)  [protected]
 

void Ogre::Serializer::writeObject (  const Quaternion &    q )  [protected]
 

void Ogre::Serializer::writeObject (  const Vector3 &    vec )  [protected]
 

void Ogre::Serializer::writeReals (  const Real *    pReal,
unsigned short    count
)  [protected]
 

void Ogre::Serializer::writeShorts (  const unsigned short *    pShort,
unsigned short    count
)  [protected]
 

void Ogre::Serializer::writeString (  const String &    string )  [protected]
 

Member Data Documentation

unsigned long Ogre::Serializer::mCurrentChunkLen [protected]
 

FILE* Ogre::Serializer::mpfFile [protected]
 

String Ogre::Serializer::mVersion [protected]
 

Copyright © 2002 by The OGRE Team