VGears::LGPArchiveSerializer Class Reference

Manages LGP archives serialization. More...

#include <VGearsLGPArchiveSerializer.h>

Inheritance diagram for VGears::LGPArchiveSerializer:

Collaboration diagram for VGears::LGPArchiveSerializer:

Public Types
enum	{ MAGIC_STRING_LENGTH = 10 , FILE_NAME_LENGTH = 20 }
typedef LGPArchive::FileEntry	FileEntry
typedef LGPArchive::FileList	FileList

Public Member Functions
	LGPArchiveSerializer ()
	Constructor. More...
virtual	~LGPArchiveSerializer ()
	Destructor. More...
virtual void	ImportLGPArchive (Ogre::DataStreamPtr &stream, LGPArchive *dest)
	Imports an A file. More...
Public Member Functions inherited from VGears::Serializer
	Serializer ()
	Constructor. More...
virtual	~Serializer ()
	Destructor. More...

Protected Member Functions
virtual void	ReadFileHeader (Ogre::DataStreamPtr &stream)
	Reads an archive header and sets the instance data. More...
virtual void	readObject (Ogre::DataStreamPtr &stream, FileEntry &file_entry)
	Reads an object as a LGP archive. More...
template<typename ValueType >
void	ReadVector (Ogre::DataStreamPtr &stream, std::vector< ValueType > &dest, size_t count)
Protected Member Functions inherited from VGears::Serializer
void	readObject (Ogre::DataStreamPtr &stream, Ogre::Vector2 &dest)
	Reads an object as a 2 dimensional vector. More...
void	readObject (Ogre::DataStreamPtr &stream, Ogre::Vector3 &dest)
	Reads an object as a 3 dimensional vector. More...
void	readObject (Ogre::DataStreamPtr &stream, Ogre::AxisAlignedBox &dest)
	Reads an object as an axis aligned box. More...
void	readObject (Ogre::DataStreamPtr &stream, Pixel &dest)
	Reads an object as a pixel. More...
void	ReadChars (Ogre::DataStreamPtr &stream, char *dest, size_t count)
	Reads a stream as text. More...
void	Read1ByteBool (Ogre::DataStreamPtr &stream, bool &dest)
	Reads one byte from a stream and evaluates it as a boolean. More...
void	Read2ByteBool (Ogre::DataStreamPtr &stream, bool &dest)
	Reads two bytes from a stream and evaluates them as a boolean. More...
void	ReadShort (Ogre::DataStreamPtr &stream, uint16 &dest)
	Reads 16 bytes from a stream and evaluates as an unsigned short. More...
void	ReadInt16 (Ogre::DataStream &stream, sint16 &dest)
	Reads 16 bytes from a stream and evaluates as a signed integer. More...
void	ReadUInt16 (Ogre::DataStream &stream, uint16 &dest)
	Reads 16 bytes from a stream and evaluates as an unsigned int. More...
void	ReadInt16 (Ogre::DataStreamPtr &stream, sint16 &dest)
	Reads 16 bytes from a stream and evaluates as a signed integer. More...
void	ReadUInt16 (Ogre::DataStreamPtr &stream, uint16 &dest)
	Reads 16 bytes from a stream and evaluates as an unsigned int. More...
void	ReadUInt32 (Ogre::DataStreamPtr &stream, uint32 &dest)
	Reads 32 bytes from a stream and evaluates as an unsigned int. More...
void	ReadSInt32 (Ogre::DataStreamPtr &stream, sint32 &dest)
	Reads 32 bytes from a stream and evaluates as a signed int. More...
void	ReadUInt32 (Ogre::DataStream &stream, uint32 &dest)
	Reads 32 bytes from a stream and evaluates as an unsigned int. More...
void	ReadUInt8 (Ogre::DataStream &stream, uint8 &dest)
	Reads 8 bytes from a stream and evaluates as an unsigned int. More...
void	ReadUInt8 (Ogre::DataStreamPtr &stream, uint8 &dest)
	Reads 8 bytes from a stream and evaluates as an unsigned int. More...
void	ReadFloat (Ogre::DataStreamPtr &stream, float &dest)
	Reads bytes from a stream and evaluates them as a float. More...
void	ReadEndString (Ogre::DataStreamPtr &stream, const String &end_text)
String	GetLine (Ogre::DataStreamPtr &stream) const

Additional Inherited Members
Static Protected Attributes inherited from VGears::Serializer
static const String	TAG_COMMENT
	A comment tag. More...

Detailed Description

Manages LGP archives serialization.

Member Typedef Documentation

FileEntry

typedef LGPArchive::FileEntry VGears::LGPArchiveSerializer::FileEntry

FileList

typedef LGPArchive::FileList VGears::LGPArchiveSerializer::FileList

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
MAGIC_STRING_LENGTH	Magic MIME string length.
FILE_NAME_LENGTH	Max file name length.

Constructor & Destructor Documentation

LGPArchiveSerializer()

VGears::LGPArchiveSerializer::LGPArchiveSerializer

(

)

Constructor.

~LGPArchiveSerializer()

VGears::LGPArchiveSerializer::~LGPArchiveSerializer ( )

virtual

Destructor.

Member Function Documentation

ImportLGPArchive()

void VGears::LGPArchiveSerializer::ImportLGPArchive ( Ogre::DataStreamPtr &  stream, LGPArchive *  dest  )

virtual

Imports an A file.

Parameters

[in]	stream	The contents of the archive.
[out]	dest	The formed LGP archive file.

ReadFileHeader()

void VGears::LGPArchiveSerializer::ReadFileHeader ( Ogre::DataStreamPtr &  stream )

protectedvirtual

Reads an archive header and sets the instance data.

Parameters

[in]

stream

The contents of the LGP archive.

readObject()

void VGears::LGPArchiveSerializer::readObject ( Ogre::DataStreamPtr &  stream, FileEntry &  file_entry  )

protectedvirtual

Reads an object as a LGP archive.

Parameters

[in]	stream	Input data.
[out]	file_entry	The formed LGP archive.

ReadVector()

template<typename ValueType >

void VGears::LGPArchiveSerializer::ReadVector ( Ogre::DataStreamPtr &  stream, std::vector< ValueType > &  dest, size_t  count  )

inlineprotected

---

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

• src/data/VGearsLGPArchiveSerializer.h
• src/data/VGearsLGPArchiveSerializer.cpp