Handles the serialization of colour palette files. More...

#include <VGearsPaletteFileSerializer.h>

Inheritance diagram for VGears::PaletteFileSerializer:

Collaboration diagram for VGears::PaletteFileSerializer:

[legend]

Classes
struct	Header
	A colour palette file header. More...

Public Types
enum	{ BIT_MASK_RED = 0x001F , BIT_MASK_GREEN = 0x03E0 , BIT_MASK_BLUE = 0x7C00 , BIT_SIZE = 0x001F , BIT_MASK_RGB = BIT_MASK_BLUE \| BIT_MASK_GREEN \| BIT_MASK_RED , BIT_MASK_ALPHA = 0x8000 }

typedef PaletteFile::Color	Color

typedef PaletteFile::Page	Page

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

virtual	~PaletteFileSerializer ()
	Destructor. More...

virtual void	ImportPaletteFile (Ogre::DataStreamPtr &stream, PaletteFile *dest)
	Imports a colour palette 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, Color &dest)
	Reads an object as a colour. More...

virtual void	readObject (Ogre::DataStreamPtr &stream, Page &dest)
	Reads an object as a palette page. More...

virtual void	ConvertColour (uint16 &colour) const
	Converts a colour. 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

Static Protected Attributes
static const Ogre::PixelFormat	PIXEL_FORMAT
	A pixel format. 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 colour palette files.

Member Typedef Documentation

◆ Color

typedef PaletteFile::Color VGears::PaletteFileSerializer::Color

◆ Page

typedef PaletteFile::Page VGears::PaletteFileSerializer::Page

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
BIT_MASK_RED	Bitmask for red colour.
BIT_MASK_GREEN	Bitmask for green colour.
BIT_MASK_BLUE	Bitmask for blie colour.
BIT_SIZE	Bitmask for palette size.
BIT_MASK_RGB	Bitmask for RGB colour.
BIT_MASK_ALPHA	Bitmask for alpha component.

Constructor & Destructor Documentation

◆ PaletteFileSerializer()

VGears::PaletteFileSerializer::PaletteFileSerializer ( )

Constructor.

◆ ~PaletteFileSerializer()

VGears::PaletteFileSerializer::~PaletteFileSerializer ( )

virtual

Destructor.

Member Function Documentation

◆ ConvertColour()

void VGears::PaletteFileSerializer::ConvertColour ( uint16 & colour ) const

protectedvirtual

Converts a colour.

Parameters

[in,out] colour Colour to convert.

Todo:: What kind of conversion is it doing?

◆ ImportPaletteFile()

void VGears::PaletteFileSerializer::ImportPaletteFile	(	Ogre::DataStreamPtr &	stream,
		PaletteFile *	dest
	)

virtual

Imports a colour palette file.

Parameters

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

◆ ReadFileHeader()

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

protectedvirtual

Reads a file header and sets the instance data.

Parameters

[in] stream The contents of the HRC file.

◆ readObject() [1/6]

void VGears::PaletteFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Color &	dest
	)

protectedvirtual

Reads an object as a colour.

Parameters

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

◆ readObject() [2/6]

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

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

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

void VGears::PaletteFileSerializer::readObject	(	Ogre::DataStreamPtr &	stream,
		Page &	dest
	)

protectedvirtual

Reads an object as a palette page.

Parameters

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

◆ readObject() [6/6]

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.

◆ ReadVector()

template<typename ValueType >

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

inlineprotected

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::PaletteFileSerializer::header_

private

The file header.

◆ PIXEL_FORMAT

const Ogre::PixelFormat VGears::PaletteFileSerializer::PIXEL_FORMAT

staticprotected

A pixel format.

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

src/data/VGearsPaletteFileSerializer.h
src/data/VGearsPaletteFileSerializer.cpp

Classes

Public Types

Public Member Functions

Protected Member Functions

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ Color

◆ Page

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ PaletteFileSerializer()

◆ ~PaletteFileSerializer()

Member Function Documentation

◆ ConvertColour()

◆ ImportPaletteFile()

◆ ReadFileHeader()

◆ readObject() [1/6]

◆ readObject() [2/6]

◆ readObject() [3/6]

◆ readObject() [4/6]

◆ readObject() [5/6]

◆ readObject() [6/6]

◆ ReadVector()

Member Data Documentation

◆ header_

◆ PIXEL_FORMAT