Handles the serialization of flevel files. More...

#include <VGearsFLevelFileSerializer.h>

Inheritance diagram for VGears::FLevelFileSerializer:

Collaboration diagram for VGears::FLevelFileSerializer:

[legend]

Classes
struct	Header
	A flevel file header. More...

Public Types
enum	{ SECTION_SCRIPT , SECTION_CAMERA_MATRIX , SECTION_MODEL_LOADER , SECTION_PALETTE , SECTION_WALKMESH , SECTION_TILE_MAP , SECTION_ENCOUNTER , SECTION_TRIGGER , SECTION_BACKGROUND , SECTION_COUNT }

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

virtual	~FLevelFileSerializer ()
	Destructor. More...

virtual void	ImportFLevelFile (Ogre::DataStreamPtr &stream, FLevelFile *dest)

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

virtual	~Serializer ()
	Destructor. More...

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

void	ReadSectionData (Ogre::DataStreamPtr &stream, Ogre::DataStreamPtr &out_buffer, size_t section_size)
	Reads a section data. More...

virtual void	ReadSection (Ogre::DataStreamPtr &stream, FLevelFile *dest, const size_t section_index)
	Reads a file section. More...

template<typename ResourceManagerType >
Ogre::ResourcePtr	CreateResource (FLevelFile *dest, const String &extension)
	Creates a resource. More...

void	ReadCameraMatrix (Ogre::DataStreamPtr &stream, FLevelFile *dest)
	Reads camera matrix data from a flevel file. More...

void	ReadModelList (Ogre::DataStreamPtr &stream, FLevelFile *dest)
	Reads model list data from a flevel file. More...

void	ReadPalette (Ogre::DataStreamPtr &stream, FLevelFile *dest)
	Reads color palette data from a flevel file. More...

void	ReadWalkmesh (Ogre::DataStreamPtr &stream, FLevelFile *dest)
	Reads walkmesh data from a flevel file. More...

void	ReadBackground (Ogre::DataStreamPtr &stream, FLevelFile *dest)
	Reads background data from a flevel file. More...

void	ReadTriggers (Ogre::DataStreamPtr &stream, FLevelFile *dest)
	Reads trigger data from a flevel file. More...

void	ReadEnd (Ogre::DataStreamPtr &stream)

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

virtual String	GetBaseName (const FLevelFile *dest) const
	Retrieves the base name of a flevel file. 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

Static Protected Attributes
static const String	TAG_FILE_END
	End-of-file 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 flevel files.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
SECTION_SCRIPT	Scripts section.
SECTION_CAMERA_MATRIX	Camera matrix section/.
SECTION_MODEL_LOADER	Model section.
SECTION_PALETTE	Color palette section/.
SECTION_WALKMESH	Walkmesh section.
SECTION_TILE_MAP	Tile map section.
SECTION_ENCOUNTER	Battle encounter section.
SECTION_TRIGGER	Triggers section.
SECTION_BACKGROUND	Background section.
SECTION_COUNT	Todo: Count of what?

Constructor & Destructor Documentation

◆ FLevelFileSerializer()

VGears::FLevelFileSerializer::FLevelFileSerializer ( )

Constructor.

◆ ~FLevelFileSerializer()

VGears::FLevelFileSerializer::~FLevelFileSerializer ( )

virtual

Destructor.

Member Function Documentation

◆ CreateResource()

template<typename ResourceManagerType >

Ogre::ResourcePtr VGears::FLevelFileSerializer::CreateResource	(	FLevelFile *	dest,
		const String &	extension
	)

protected

Creates a resource.

Parameters

[out]	dest	The crteated resource.
[in]	extension	The resource file extension.

◆ GetBaseName()

String VGears::FLevelFileSerializer::GetBaseName ( const FLevelFile * dest ) const

protectedvirtual

Retrieves the base name of a flevel file.

Parameters

[in] dest Flevel file.

Returns: The filename, without path or extension.

◆ ImportFLevelFile()

void VGears::FLevelFileSerializer::ImportFLevelFile	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest
	)

virtual

◆ ReadBackground()

void VGears::FLevelFileSerializer::ReadBackground	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest
	)

protected

Reads background data from a flevel file.

Parameters

[in]	stream	Input stream.
[out]	dest	The data will be set on this file.

◆ ReadCameraMatrix()

void VGears::FLevelFileSerializer::ReadCameraMatrix	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest
	)

protected

Reads camera matrix data from a flevel file.

Parameters

[in]	stream	Input stream.
[out]	dest	The data will be set on this file.

◆ ReadEnd()

void VGears::FLevelFileSerializer::ReadEnd ( Ogre::DataStreamPtr & stream )

protected

Todo:: Understand and document.

Parameters

[in] stream Input stream.

◆ ReadFileHeader()

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

protected

Reads the file header and sets instance data.

Parameters

[in] stream Contents of the file.

◆ ReadModelList()

void VGears::FLevelFileSerializer::ReadModelList	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest
	)

protected

Reads model list data from a flevel file.

Parameters

[in]	stream	Input stream.
[out]	dest	The data will be set on this file.

◆ ReadPalette()

void VGears::FLevelFileSerializer::ReadPalette	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest
	)

protected

Reads color palette data from a flevel file.

Parameters

[in]	stream	Input stream.
[out]	dest	The data will be set on this file.

◆ ReadSection()

void VGears::FLevelFileSerializer::ReadSection	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest,
		const size_t	section_index
	)

protectedvirtual

Reads a file section.

Parameters

[in]	stream	Contents of the file.
[out]	dest	The section data will be loaded here.
[in]	section_index	Index of the section to read.

◆ ReadSectionData()

void VGears::FLevelFileSerializer::ReadSectionData	(	Ogre::DataStreamPtr &	stream,
		Ogre::DataStreamPtr &	out_buffer,
		size_t	section_size
	)

protected

Reads a section data.

Parameters

[in]	stream	Contents of the file.
[out]	out_buffer	The contents of the section are loaded here.
[in]	section_size	Size of the section to read, in bytes.

◆ ReadTriggers()

void VGears::FLevelFileSerializer::ReadTriggers	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest
	)

protected

Reads trigger data from a flevel file.

Parameters

[in]	stream	Input stream.
[out]	dest	The data will be set on this file.

◆ ReadVector()

template<typename ValueType >

void VGears::FLevelFileSerializer::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.

◆ ReadWalkmesh()

void VGears::FLevelFileSerializer::ReadWalkmesh	(	Ogre::DataStreamPtr &	stream,
		FLevelFile *	dest
	)

protected

Reads walkmesh data from a flevel file.

Parameters

[in]	stream	Input stream.
[out]	dest	The data will be set on this file.

Member Data Documentation

◆ header_

Header VGears::FLevelFileSerializer::header_

private

The file header.

◆ TAG_FILE_END

const String VGears::FLevelFileSerializer::TAG_FILE_END

staticprotected

End-of-file tag.

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

src/data/VGearsFLevelFileSerializer.h
src/data/VGearsFLevelFileSerializer.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ FLevelFileSerializer()

◆ ~FLevelFileSerializer()

Member Function Documentation

◆ CreateResource()

◆ GetBaseName()

◆ ImportFLevelFile()

◆ ReadBackground()

◆ ReadCameraMatrix()

◆ ReadEnd()

◆ ReadFileHeader()

◆ ReadModelList()

◆ ReadPalette()

◆ ReadSection()

◆ ReadSectionData()

◆ ReadTriggers()

◆ ReadVector()

◆ ReadWalkmesh()

Member Data Documentation

◆ header_

◆ TAG_FILE_END