VGears::TriggerFileSerializer Class Reference

Handles the serialization of trigger files. More...

#include <VGearsTriggersFile.h>

Inheritance diagram for VGears::TriggerFileSerializer:

Collaboration diagram for VGears::TriggerFileSerializer:

Public Member Functions
	TriggerFileSerializer ()
	Constructor. More...
void	ImportTriggerFile (Ogre::DataStreamPtr &stream, TriggersFile *dest)
	Imports a trigger file. More...
Public Member Functions inherited from VGears::Serializer
	Serializer ()
	Constructor. More...
virtual	~Serializer ()
	Destructor. More...

Private Member Functions
void	ReadTriggerVertex (Ogre::DataStreamPtr &stream, TriggersFile::TriggerVertex &vertex)
	Reads trigger vertex data from the trigger file. More...
void	ReadRange (Ogre::DataStreamPtr &stream, TriggersFile::Range &range)
	Reads range data from the trigger file. More...
void	ReadGateway (Ogre::DataStreamPtr &stream, TriggersFile::Gateway &exit)
	Reads gateway data from the trigger file. More...
void	ReadArrow (Ogre::DataStreamPtr &stream, TriggersFile::Arrow &arrow)
	Reads arrow data from the trigger file. More...
void	ReadTrigger (Ogre::DataStreamPtr &stream, TriggersFile::Trigger &trigger)
	Reads trigger data from the trigger file. More...

Additional Inherited Members
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
Static Protected Attributes inherited from VGears::Serializer
static const String	TAG_COMMENT
	A comment tag. More...

Detailed Description

Handles the serialization of trigger files.

Constructor & Destructor Documentation

TriggerFileSerializer()

VGears::TriggerFileSerializer::TriggerFileSerializer

(

)

Constructor.

Member Function Documentation

ImportTriggerFile()

void VGears::TriggerFileSerializer::ImportTriggerFile	(	Ogre::DataStreamPtr &	stream,
		TriggersFile *	dest
	)

Imports a trigger file.

Parameters

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

ReadArrow()

void VGears::TriggerFileSerializer::ReadArrow ( Ogre::DataStreamPtr &  stream, TriggersFile::Arrow &  arrow  )

private

Reads arrow data from the trigger file.

Parameters

[in]	stream	The contents of the trigger file.
[out]	arrow	The arrow data.

ReadGateway()

void VGears::TriggerFileSerializer::ReadGateway ( Ogre::DataStreamPtr &  stream, TriggersFile::Gateway &  exit  )

private

Reads gateway data from the trigger file.

Parameters

[in]	stream	The contents of the trigger file.
[out]	exit	The gateway data.

ReadRange()

void VGears::TriggerFileSerializer::ReadRange ( Ogre::DataStreamPtr &  stream, TriggersFile::Range &  range  )

private

Reads range data from the trigger file.

Parameters

[in]	stream	The contents of the trigger file.
[out]	range	The range data.

ReadTrigger()

void VGears::TriggerFileSerializer::ReadTrigger ( Ogre::DataStreamPtr &  stream, TriggersFile::Trigger &  trigger  )

private

Reads trigger data from the trigger file.

Parameters

[in]	stream	The contents of the trigger file.
[out]	trigger	The trigger data.

ReadTriggerVertex()

void VGears::TriggerFileSerializer::ReadTriggerVertex ( Ogre::DataStreamPtr &  stream, TriggersFile::TriggerVertex &  vertex  )

private

Reads trigger vertex data from the trigger file.

Parameters

[in]	stream	The contents of the trigger file.
[out]	vertex	The vertex data.

---

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

• src/data/VGearsTriggersFile.h
• src/data/VGearsTriggersFile.cpp