Handles the serialization of HRC files. More...

#include <VGearsHRCFileSerializer.h>

Inheritance diagram for VGears::HRCFileSerializer:

Collaboration diagram for VGears::HRCFileSerializer:

[legend]

Classes
struct	Header
	An HRC file header. More...

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

virtual	~HRCFileSerializer ()
	Destructor. More...

virtual void	ImportHRCFile (Ogre::DataStreamPtr &stream, HRCFile *dest)
	Imports a HRC file. More...

Public Member Functions inherited from VGears::Serializer
	Serializer ()
	Constructor. More...

virtual	~Serializer ()
	Destructor. More...

Protected Types
typedef std::vector< String >	Block

typedef HRCFile::Bone	Bone

Protected Member Functions
virtual void	ReadFileHeader (Ogre::DataStreamPtr &stream)
	Reads a file header and sets the instance data. More...

virtual void	ReadBlock (Ogre::DataStreamPtr &stream, Block &dest)
	Reads an object as a block. More...

virtual void	readObject (Ogre::DataStreamPtr &stream, Bone &dest)
	Reads an object as a bone. 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

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

static const String	TAG_VERSION
	File version tag. More...

static const String	TAG_NAME
	The name tag. More...

static const String	TAG_BONE_COUNT
	The bone count tag. More...

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

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

Detailed Description

Handles the serialization of HRC files.

Member Typedef Documentation

◆ Block

typedef std::vector<String> VGears::HRCFileSerializer::Block

protected

◆ Bone

typedef HRCFile::Bone VGears::HRCFileSerializer::Bone

protected

Constructor & Destructor Documentation

◆ HRCFileSerializer()

VGears::HRCFileSerializer::HRCFileSerializer ( )

Constructor.

◆ ~HRCFileSerializer()

VGears::HRCFileSerializer::~HRCFileSerializer ( )

virtual

Destructor.

Member Function Documentation

◆ ImportHRCFile()

void VGears::HRCFileSerializer::ImportHRCFile	(	Ogre::DataStreamPtr &	stream,
		HRCFile *	dest
	)

virtual

Imports a HRC file.

Parameters

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

◆ ReadBlock()

void VGears::HRCFileSerializer::ReadBlock	(	Ogre::DataStreamPtr &	stream,
		Block &	dest
	)

protectedvirtual

Reads an object as a block.

Parameters

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

◆ ReadFileHeader()

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

protectedvirtual

Reads a file header and sets the instance data.

Parameters

[in] stream The contents of the HRC file.

◆ readObject()

void VGears::HRCFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Bone &	dest
	)

protectedvirtual

Reads an object as a bone.

Parameters

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

◆ ReadVector()

template<typename ValueType >

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

protected

Member Data Documentation

◆ header_

Header VGears::HRCFileSerializer::header_

private

The file header.

◆ TAG_BONE_COUNT

const String VGears::HRCFileSerializer::TAG_BONE_COUNT

staticprotected

The bone count tag.

◆ TAG_COMMENT

const String VGears::HRCFileSerializer::TAG_COMMENT

staticprotected

A comment tag.

◆ TAG_NAME

const String VGears::HRCFileSerializer::TAG_NAME

staticprotected

The name tag.

◆ TAG_VERSION

const String VGears::HRCFileSerializer::TAG_VERSION

staticprotected

File version tag.

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

src/data/VGearsHRCFileSerializer.h
src/data/VGearsHRCFileSerializer.cpp

Classes

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Block

◆ Bone

Constructor & Destructor Documentation

◆ HRCFileSerializer()

◆ ~HRCFileSerializer()

Member Function Documentation

◆ ImportHRCFile()

◆ ReadBlock()

◆ ReadFileHeader()

◆ readObject()

◆ ReadVector()

Member Data Documentation

◆ header_

◆ TAG_BONE_COUNT

◆ TAG_COMMENT

◆ TAG_NAME

◆ TAG_VERSION