resource::Serializer Class Reference

#include <Serializer.h>

List of all members.

Public Member Functions
virtual bool	exportResource (Resource *source, const std::string &filename)
	Exports a resource to the file specified.
virtual bool	importResource (DataStream *stream, Resource *dest)
	Imports a resource from a file DataStream.
	Serializer ()
virtual	~Serializer ()
Protected Member Functions
void	readBools (DataStream *stream, bool *dest, u32 count)
virtual u16	readChunk (DataStream *stream)
virtual void	readFileHeader (DataStream *stream)
void	readFloats (DataStream *stream, f32 *dest, u32 count)
void	readLongs (DataStream *stream, u32 *dest, u32 count)
void	readObject (DataStream *stream, core::vector3d *dest)
void	readObject (DataStream *stream, core::quaternion *dest)
void	readShorts (DataStream *stream, u16 *dest, u32 count)
std::string	readString (DataStream *stream)
void	writebools (const bool *src, u32 count)
virtual void	writeChunkHeader (u16 id, u32 size)
void	writeData (const void *buf, u32 size, u32 count)
virtual void	writeFileHeader ()
void	writeFloats (const f32 *src, u32 count)
void	writeLongs (const u32 *src, u32 count)
void	writeObject (const core::quaternion &q)
void	writeObject (const core::vector3d &vec)
void	writeShorts (const u16 *src, u32 count)
void	writeString (const std::string &string)
Protected Attributes
u32	mCurrentChunkLen
platform::File *	mFile
ResourceType	mResourceType
std::string	mVersion

---

Detailed Description

Generic class for serialising data to / from binary chunk-based files.

This class provides a number of useful methods for exporting / importing data from chunk-oriented binary files (e.g. .mesh).

---

Constructor & Destructor Documentation

resource::Serializer::Serializer

(

)

References mVersion.

resource::Serializer::~Serializer

(

)

[virtual]

---

Member Function Documentation

bool resource::Serializer::exportResource	(	Resource *	source,
		const std::string &	filename
	)		[virtual]

Exports a resource to the file specified.

bool resource::Serializer::importResource	(	DataStream *	stream,
		Resource *	dest
	)		[virtual]

Imports a resource from a file DataStream.

Referenced by resource::Resource::loadImpl().

void resource::Serializer::readBools	(	DataStream *	stream,
		bool *	dest,
		u32	count
	)		[protected]

References resource::DataStream::read().

u16 resource::Serializer::readChunk

(

DataStream *

stream

)

[protected, virtual]

References mCurrentChunkLen, readLongs(), and readShorts().

void resource::Serializer::readFileHeader

(

DataStream *

stream

)

[protected, virtual]

References engine::LogManager::getInstance(), resource::HEADER_CHUNK_ID, engine::LL_ERROR, mVersion, readShorts(), and readString().

void resource::Serializer::readFloats	(	DataStream *	stream,
		f32 *	dest,
		u32	count
	)		[protected]

References resource::DataStream::read().

Referenced by readObject().

void resource::Serializer::readLongs	(	DataStream *	stream,
		u32 *	dest,
		u32	count
	)		[protected]

References resource::DataStream::read().

Referenced by readChunk().

void resource::Serializer::readObject	(	DataStream *	stream,
		core::vector3d *	dest
	)		[protected]

References readFloats(), core::vector3d::X, core::vector3d::Y, and core::vector3d::Z.

void resource::Serializer::readObject	(	DataStream *	stream,
		core::quaternion *	dest
	)		[protected]

References readFloats(), core::quaternion::W, core::quaternion::X, core::quaternion::Y, and core::quaternion::Z.

void resource::Serializer::readShorts	(	DataStream *	stream,
		u16 *	dest,
		u32	count
	)		[protected]

References resource::DataStream::read().

Referenced by readChunk(), and readFileHeader().

std::string resource::Serializer::readString

(

DataStream *

stream

)

[protected]

References resource::DataStream::getLine(), and core::STRING_BLANK.

Referenced by readFileHeader().

void resource::Serializer::writebools	(	const bool *	src,
		u32	count
	)		[protected]

References writeData().

void resource::Serializer::writeChunkHeader	(	u16	id,
		u32	size
	)		[protected, virtual]

References writeLongs(), and writeShorts().

void resource::Serializer::writeData	(	const void *	buf,
		u32	size,
		u32	count
	)		[protected]

References mFile, and platform::File::write().

Referenced by writebools(), writeFloats(), writeLongs(), and writeShorts().

void resource::Serializer::writeFileHeader

(

)

[protected, virtual]

References resource::HEADER_CHUNK_ID, mVersion, writeShorts(), and writeString().

void resource::Serializer::writeFloats	(	const f32 *	src,
		u32	count
	)		[protected]

References writeData().

Referenced by writeObject().

void resource::Serializer::writeLongs	(	const u32 *	src,
		u32	count
	)		[protected]

References writeData().

Referenced by writeChunkHeader().

void resource::Serializer::writeObject

(

const core::quaternion &

q

)

[protected]

References core::quaternion::W, writeFloats(), core::quaternion::X, core::quaternion::Y, and core::quaternion::Z.

void resource::Serializer::writeObject

(

const core::vector3d &

vec

)

[protected]

References writeFloats(), core::vector3d::X, core::vector3d::Y, and core::vector3d::Z.

void resource::Serializer::writeShorts	(	const u16 *	src,
		u32	count
	)		[protected]

References writeData().

Referenced by writeChunkHeader(), and writeFileHeader().

void resource::Serializer::writeString

(

const std::string &

string

)

[protected]

References mFile, and platform::File::writeLine().

Referenced by writeFileHeader().

---

Member Data Documentation

u32 resource::Serializer::mCurrentChunkLen [protected]

Referenced by readChunk().

platform::File* resource::Serializer::mFile [protected]

Referenced by writeData(), and writeString().

ResourceType resource::Serializer::mResourceType [protected]

std::string resource::Serializer::mVersion [protected]

Referenced by readFileHeader(), Serializer(), and writeFileHeader().

---

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

• E:/Programming/MyProject/K_Game_hg/GameEngine/include/resource/Serializer.h
• E:/Programming/MyProject/K_Game_hg/GameEngine/src/resource/Serializer.cpp