Handles the serialization of P files. More...

#include <VGearsPFileSerializer.h>

Inheritance diagram for VGears::PFileSerializer:

Collaboration diagram for VGears::PFileSerializer:

[legend]

Classes
struct	Header
	The header of a P file. More...

Public Types
typedef PFile::BBoxEntry	BBoxEntry

typedef PFile::Edge	Edge

typedef PFile::Group	Group

typedef PFile::MaterialInformation	MaterialInformation

typedef PFile::PolygonDefinition	PolygonDefinition

typedef PFile::Colour	Colour

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

virtual	~PFileSerializer ()
	Destructor. More...

virtual void	ImportPFile (Ogre::DataStreamPtr &stream, PFile *dest)
	Imports a P 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 a file header and sets the instance data. More...

virtual void	readObject (Ogre::DataStreamPtr &stream, Colour &dest)
	Reads an object as a colour. More...

virtual void	readObject (Ogre::DataStreamPtr &stream, Edge &dest)
	Reads an object as an edge. More...

virtual void	readObject (Ogre::DataStreamPtr &stream, PolygonDefinition &dest)
	Reads an object as a polygon definition. More...

virtual void	readObject (Ogre::DataStreamPtr &stream, Group &dest)
	Reads an object as a group. More...

virtual void	readObject (Ogre::DataStreamPtr &stream, BBoxEntry &dest)
	Reads an object as a bounding box. More...

template<typename ValueType >
void	ReadVector (Ogre::DataStreamPtr &stream, std::vector< ValueType > &dest, size_t count)
	Reads a stream as a vector. More...

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...

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

Private Attributes
Header	header_
	The file header. More...

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

Detailed Description

Handles the serialization of P files.

Member Typedef Documentation

◆ BBoxEntry

typedef PFile::BBoxEntry VGears::PFileSerializer::BBoxEntry

◆ Colour

typedef PFile::Colour VGears::PFileSerializer::Colour

◆ Edge

typedef PFile::Edge VGears::PFileSerializer::Edge

◆ Group

typedef PFile::Group VGears::PFileSerializer::Group

◆ MaterialInformation

typedef PFile::MaterialInformation VGears::PFileSerializer::MaterialInformation

◆ PolygonDefinition

typedef PFile::PolygonDefinition VGears::PFileSerializer::PolygonDefinition

Constructor & Destructor Documentation

◆ PFileSerializer()

VGears::PFileSerializer::PFileSerializer ( )

Constructor.

◆ ~PFileSerializer()

VGears::PFileSerializer::~PFileSerializer ( )

virtual

Destructor.

Member Function Documentation

◆ ImportPFile()

void VGears::PFileSerializer::ImportPFile	(	Ogre::DataStreamPtr &	stream,
		PFile *	dest
	)

virtual

Imports a P file.

Parameters

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

◆ ReadFileHeader()

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

protectedvirtual

Reads a file header and sets the instance data.

Parameters

[in] stream The contents of the P file.

◆ readObject() [1/9]

void VGears::PFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		BBoxEntry &	dest
	)

protectedvirtual

Reads an object as a bounding box.

Parameters

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

◆ readObject() [2/9]

void VGears::PFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Colour &	dest
	)

protectedvirtual

Reads an object as a colour.

Parameters

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

◆ readObject() [3/9]

void VGears::PFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Edge &	dest
	)

protectedvirtual

Reads an object as an edge.

Parameters

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

◆ readObject() [4/9]

void VGears::PFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Group &	dest
	)

protectedvirtual

Reads an object as a group.

Parameters

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

◆ readObject() [5/9]

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() [6/9]

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() [7/9]

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() [8/9]

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.

◆ readObject() [9/9]

void VGears::PFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		PolygonDefinition &	dest
	)

protectedvirtual

Reads an object as a polygon definition.

Parameters

[in]	stream	Input data.
[out]	dest	The formed poligon definition data.

◆ ReadVector()

template<typename ValueType >

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

protected

Reads a stream as a vector.

Parameters

[in]	stream	The input stream.
[out]	dest	The vector data will be loaded here.
[in]	count	Data units to copy.

Member Data Documentation

◆ header_

Header VGears::PFileSerializer::header_

private

The file header.

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

src/data/VGearsPFileSerializer.h
src/data/VGearsPFileSerializer.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BBoxEntry

◆ Colour

◆ Edge

◆ Group

◆ MaterialInformation

◆ PolygonDefinition

Constructor & Destructor Documentation

◆ PFileSerializer()

◆ ~PFileSerializer()

Member Function Documentation

◆ ImportPFile()

◆ ReadFileHeader()

◆ readObject() [1/9]

◆ readObject() [2/9]

◆ readObject() [3/9]

◆ readObject() [4/9]

◆ readObject() [5/9]

◆ readObject() [6/9]

◆ readObject() [7/9]

◆ readObject() [8/9]

◆ readObject() [9/9]

◆ ReadVector()

Member Data Documentation

◆ header_