Handles file serialization. More...

#include <VGearsSerializer.h>

Inheritance diagram for VGears::Serializer:

[legend]

Collaboration diagram for VGears::Serializer:

Public Member Functions
	Serializer ()
	Constructor. More...

virtual	~Serializer ()
	Destructor. More...

Protected Member Functions
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

Static Protected Attributes
static const String	TAG_COMMENT
	A comment tag. More...

Detailed Description

Handles file serialization.

Constructor & Destructor Documentation

◆ Serializer()

VGears::Serializer::Serializer ( )

Constructor.

Determines the endian mode of the file.

◆ ~Serializer()

VGears::Serializer::~Serializer ( )

virtual

Destructor.

Member Function Documentation

◆ GetLine()

String VGears::Serializer::GetLine ( Ogre::DataStreamPtr & stream ) const

protected

Todo:: Understand and document.

◆ Read1ByteBool()

void VGears::Serializer::Read1ByteBool	(	Ogre::DataStreamPtr &	stream,
		bool &	dest
	)

protected

Reads one byte from a stream and evaluates it as a boolean.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated boolean.

Todo:: 1 is true?

◆ Read2ByteBool()

void VGears::Serializer::Read2ByteBool	(	Ogre::DataStreamPtr &	stream,
		bool &	dest
	)

protected

Reads two bytes from a stream and evaluates them as a boolean.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated boolean.

Todo:: 1 is true?

◆ ReadChars()

void VGears::Serializer::ReadChars	(	Ogre::DataStreamPtr &	stream,
		char *	dest,
		size_t	count
	)

protected

Reads a stream as text.

Parameters

[in]	stream	Input data.
[out]	dest	The read characters will be stored here.
[in]	count	Read this many characters.

◆ ReadEndString()

void VGears::Serializer::ReadEndString	(	Ogre::DataStreamPtr &	stream,
		const String &	end_text
	)

protected

Todo:: Understand and document.

◆ ReadFloat()

void VGears::Serializer::ReadFloat	(	Ogre::DataStreamPtr &	stream,
		float &	dest
	)

protected

Reads bytes from a stream and evaluates them as a float.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadInt16() [1/2]

void VGears::Serializer::ReadInt16	(	Ogre::DataStream &	stream,
		sint16 &	dest
	)

protected

Reads 16 bytes from a stream and evaluates as a signed integer.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadInt16() [2/2]

void VGears::Serializer::ReadInt16	(	Ogre::DataStreamPtr &	stream,
		sint16 &	dest
	)

protected

Reads 16 bytes from a stream and evaluates as a signed integer.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ readObject() [1/4]

void VGears::Serializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Ogre::AxisAlignedBox &	dest
	)

protected

Reads an object as an axis aligned box.

Can be used for bounding boxes.

Parameters

[in]	stream	Input data.
[out]	dest	The formed box data.

◆ readObject() [2/4]

void VGears::Serializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Ogre::Vector2 &	dest
	)

protected

Reads an object as a 2 dimensional vector.

Parameters

[in]	stream	Input data.
[out]	dest	The formed vector data.

◆ readObject() [3/4]

void VGears::Serializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Ogre::Vector3 &	dest
	)

protected

Reads an object as a 3 dimensional vector.

Parameters

[in]	stream	Input data.
[out]	dest	The formed vector data.

◆ readObject() [4/4]

void VGears::Serializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Pixel &	dest
	)

protected

Reads an object as a pixel.

Parameters

[in]	stream	Input data.
[out]	dest	The formed pixel data.

◆ ReadShort()

void VGears::Serializer::ReadShort	(	Ogre::DataStreamPtr &	stream,
		uint16 &	dest
	)

protected

Reads 16 bytes from a stream and evaluates as an unsigned short.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadSInt32()

void VGears::Serializer::ReadSInt32	(	Ogre::DataStreamPtr &	stream,
		sint32 &	dest
	)

protected

Reads 32 bytes from a stream and evaluates as a signed int.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadUInt16() [1/2]

void VGears::Serializer::ReadUInt16	(	Ogre::DataStream &	stream,
		uint16 &	dest
	)

protected

Reads 16 bytes from a stream and evaluates as an unsigned int.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadUInt16() [2/2]

void VGears::Serializer::ReadUInt16	(	Ogre::DataStreamPtr &	stream,
		uint16 &	dest
	)

protected

Reads 16 bytes from a stream and evaluates as an unsigned int.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadUInt32() [1/2]

void VGears::Serializer::ReadUInt32	(	Ogre::DataStream &	stream,
		uint32 &	dest
	)

protected

Reads 32 bytes from a stream and evaluates as an unsigned int.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadUInt32() [2/2]

void VGears::Serializer::ReadUInt32	(	Ogre::DataStreamPtr &	stream,
		uint32 &	dest
	)

protected

Reads 32 bytes from a stream and evaluates as an unsigned int.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadUInt8() [1/2]

void VGears::Serializer::ReadUInt8	(	Ogre::DataStream &	stream,
		uint8 &	dest
	)

protected

Reads 8 bytes from a stream and evaluates as an unsigned int.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

◆ ReadUInt8() [2/2]

void VGears::Serializer::ReadUInt8	(	Ogre::DataStreamPtr &	stream,
		uint8 &	dest
	)

protected

Reads 8 bytes from a stream and evaluates as an unsigned int.

Parameters

[in]	stream	Input data.
[out]	dest	The evaluated number.

Member Data Documentation

◆ TAG_COMMENT

const String VGears::Serializer::TAG_COMMENT

staticprotected

A comment tag.

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

src/data/VGearsSerializer.h
src/data/VGearsSerializer.cpp

Public Member Functions

Protected Member Functions

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Serializer()

◆ ~Serializer()

Member Function Documentation

◆ GetLine()

◆ Read1ByteBool()

◆ Read2ByteBool()

◆ ReadChars()

◆ ReadEndString()

◆ ReadFloat()

◆ ReadInt16() [1/2]

◆ ReadInt16() [2/2]

◆ readObject() [1/4]

◆ readObject() [2/4]

◆ readObject() [3/4]

◆ readObject() [4/4]

◆ ReadShort()

◆ ReadSInt32()

◆ ReadUInt16() [1/2]

◆ ReadUInt16() [2/2]

◆ ReadUInt32() [1/2]

◆ ReadUInt32() [2/2]

◆ ReadUInt8() [1/2]

◆ ReadUInt8() [2/2]

Member Data Documentation

◆ TAG_COMMENT