Ogre::MeshSerializer Class Reference

Class for serialising mesh data to/from an OGRE .mesh file. More...

#include <OgreMeshSerializer.h>

Inheritance diagram for Ogre::MeshSerializer:

List of all members.

Public Types

enum Endian { ENDIAN_NATIVE, ENDIAN_BIG, ENDIAN_LITTLE }

The endianness of written files. More...

Public Member Functions

MeshSerializer ()

virtual ~MeshSerializer ()

void exportMesh (const Mesh *pMesh, const String &filename, Endian endianMode=ENDIAN_NATIVE)

Exports a mesh to the file specified.

void importMesh (DataStreamPtr &stream, Mesh *pDest)

Imports Mesh and (optionally) Material data from a .mesh file DataStream.

void setListener (MeshSerializerListener *listener)

Sets the listener for this serializer.

MeshSerializerListener * getListener ()

Returns the current listener.

void * operator new (size_t sz, const char *file, int line, const char *func)

operator new, with debug line info

void * operator new (size_t sz)

void * operator new (size_t sz, void *ptr)

placement operator new

void * operator new[] (size_t sz, const char *file, int line, const char *func)

array operator new, with debug line info

void * operator new[] (size_t sz)

void operator delete (void *ptr)

void operator delete (void *ptr, void *)

void operator delete (void *ptr, const char *, int, const char *)

void operator delete[] (void *ptr)

void operator delete[] (void *ptr, const char *, int, const char *)

Protected Types

typedef std::map< String,
MeshSerializerImpl * > MeshSerializerImplMap

Protected Member Functions

virtual void writeFileHeader (void)

virtual void writeChunkHeader (uint16 id, size_t size)

void writeFloats (const float *const pfloat, size_t count)

void writeFloats (const double *const pfloat, size_t count)

void writeShorts (const uint16 *const pShort, size_t count)

void writeInts (const uint32 *const pInt, size_t count)

void writeBools (const bool *const pLong, size_t count)

void writeObject (const Vector3 &vec)

void writeObject (const Quaternion &q)

void writeString (const String &string)

void writeData (const void *const buf, size_t size, size_t count)

virtual void readFileHeader (DataStreamPtr &stream)

virtual unsigned short readChunk (DataStreamPtr &stream)

void readBools (DataStreamPtr &stream, bool *pDest, size_t count)

void readFloats (DataStreamPtr &stream, float *pDest, size_t count)

void readFloats (DataStreamPtr &stream, double *pDest, size_t count)

void readShorts (DataStreamPtr &stream, uint16 *pDest, size_t count)

void readInts (DataStreamPtr &stream, uint32 *pDest, size_t count)

void readObject (DataStreamPtr &stream, Vector3 &pDest)

void readObject (DataStreamPtr &stream, Quaternion &pDest)

String readString (DataStreamPtr &stream)

String readString (DataStreamPtr &stream, size_t numChars)

virtual void flipToLittleEndian (void *pData, size_t size, size_t count=1)

virtual void flipFromLittleEndian (void *pData, size_t size, size_t count=1)

virtual void flipEndian (void *pData, size_t size, size_t count)

virtual void flipEndian (void *pData, size_t size)

virtual void determineEndianness (DataStreamPtr &stream)

Determine the endianness of the incoming stream compared to native.

virtual void determineEndianness (Endian requestedEndian)

Determine the endianness to write with based on option.

Protected Attributes

MeshSerializerImplMap mImplementations

MeshSerializerListener * mListener

uint32 mCurrentstreamLen

FILE * mpfFile

String mVersion

bool mFlipEndian

Static Protected Attributes

static String msCurrentVersion

Detailed Description

Class for serialising mesh data to/from an OGRE .mesh file.

Remarks:: This class allows exporters to write OGRE .mesh files easily, and allows the OGRE engine to import .mesh files into instantiated OGRE Meshes. Note that a .mesh file can include not only the Mesh, but also definitions of any Materials it uses (although this is optional, the .mesh can rely on the Material being loaded from another source, especially useful if you want to take advantage of OGRE's advanced Material properties which may not be available in your modeller).

To export a Mesh:

Use the MaterialManager methods to create any dependent Material objects, if you want to export them with the Mesh.
Create a Mesh object and populate it using it's methods.
Call the exportMesh method

: It's important to realise that this exporter uses OGRE terminology. In this context, 'Mesh' means a top-level mesh structure which can actually contain many SubMeshes, each of which has only one Material. Modelling packages may refer to these differently, for example in Milkshape, it says 'Model' instead of 'Mesh' and 'Mesh' instead of 'SubMesh', but the theory is the same.

Definition at line 64 of file OgreMeshSerializer.h.

Member Typedef Documentation

typedef std::map<String, MeshSerializerImpl* > Ogre::MeshSerializer::MeshSerializerImplMap [protected]

Definition at line 98 of file OgreMeshSerializer.h.

Member Enumeration Documentation

enum Ogre::Serializer::Endian [inherited]

The endianness of written files.

Enumerator:

ENDIAN_NATIVE	Use the platform native endian.
ENDIAN_BIG	Use big endian (0x1000 is serialised as 0x10 0x00).
ENDIAN_LITTLE	Use little endian (0x1000 is serialised as 0x00 0x10).

Definition at line 51 of file OgreSerializer.h.

Constructor & Destructor Documentation

Ogre::MeshSerializer::MeshSerializer ( )

virtual Ogre::MeshSerializer::~MeshSerializer ( ) [virtual]

Member Function Documentation

void Ogre::MeshSerializer::exportMesh	(	const Mesh *	pMesh,
		const String &	filename,
		Endian	endianMode = `ENDIAN_NATIVE`
	)

Exports a mesh to the file specified.

Remarks:: This method takes an externally created Mesh object, and exports both it and optionally the Materials it uses to a .mesh file.

Parameters:

	pMesh	Pointer to the Mesh to export
	filename	The destination filename
	endianMode	The endian mode of the written file

void Ogre::MeshSerializer::importMesh	(	DataStreamPtr &	stream,
		Mesh *	pDest
	)

Imports Mesh and (optionally) Material data from a .mesh file DataStream.

Remarks:: This method imports data from a DataStream opened from a .mesh file and places it's contents into the Mesh object which is passed in.

Parameters:

	stream	The DataStream holding the .mesh data. Must be initialised (pos at the start of the buffer).
	pDest	Pointer to the Mesh object which will receive the data. Should be blank already.

void Ogre::MeshSerializer::setListener ( MeshSerializerListener * listener )

Sets the listener for this serializer.

MeshSerializerListener* Ogre::MeshSerializer::getListener ( )

Returns the current listener.

virtual void Ogre::Serializer::writeFileHeader ( void ) [protected, virtual, inherited]

virtual void Ogre::Serializer::writeChunkHeader	(	uint16	id,
		size_t	size
	)			`[protected, virtual, inherited]`

void Ogre::Serializer::writeFloats	(	const float *const	pfloat,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::writeFloats	(	const double *const	pfloat,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::writeShorts	(	const uint16 *const	pShort,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::writeInts	(	const uint32 *const	pInt,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::writeBools	(	const bool *const	pLong,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::writeObject ( const Vector3 & vec ) [protected, inherited]

void Ogre::Serializer::writeObject ( const Quaternion & q ) [protected, inherited]

void Ogre::Serializer::writeString ( const String & string ) [protected, inherited]

void Ogre::Serializer::writeData	(	const void *const	buf,
		size_t	size,
		size_t	count
	)			`[protected, inherited]`

virtual void Ogre::Serializer::readFileHeader ( DataStreamPtr & stream ) [protected, virtual, inherited]

virtual unsigned short Ogre::Serializer::readChunk ( DataStreamPtr & stream ) [protected, virtual, inherited]

void Ogre::Serializer::readBools	(	DataStreamPtr &	stream,
		bool *	pDest,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::readFloats	(	DataStreamPtr &	stream,
		float *	pDest,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::readFloats	(	DataStreamPtr &	stream,
		double *	pDest,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::readShorts	(	DataStreamPtr &	stream,
		uint16 *	pDest,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::readInts	(	DataStreamPtr &	stream,
		uint32 *	pDest,
		size_t	count
	)			`[protected, inherited]`

void Ogre::Serializer::readObject	(	DataStreamPtr &	stream,
		Vector3 &	pDest
	)			`[protected, inherited]`

void Ogre::Serializer::readObject	(	DataStreamPtr &	stream,
		Quaternion &	pDest
	)			`[protected, inherited]`

String Ogre::Serializer::readString ( DataStreamPtr & stream ) [protected, inherited]

String Ogre::Serializer::readString	(	DataStreamPtr &	stream,
		size_t	numChars
	)			`[protected, inherited]`

virtual void Ogre::Serializer::flipToLittleEndian	(	void *	pData,
		size_t	size,
		size_t	count = `1`
	)			`[protected, virtual, inherited]`

virtual void Ogre::Serializer::flipFromLittleEndian	(	void *	pData,
		size_t	size,
		size_t	count = `1`
	)			`[protected, virtual, inherited]`

virtual void Ogre::Serializer::flipEndian	(	void *	pData,
		size_t	size,
		size_t	count
	)			`[protected, virtual, inherited]`

virtual void Ogre::Serializer::flipEndian	(	void *	pData,
		size_t	size
	)			`[protected, virtual, inherited]`

virtual void Ogre::Serializer::determineEndianness ( DataStreamPtr & stream ) [protected, virtual, inherited]

Determine the endianness of the incoming stream compared to native.

virtual void Ogre::Serializer::determineEndianness ( Endian requestedEndian ) [protected, virtual, inherited]

Determine the endianness to write with based on option.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

operator new, with debug line info

Definition at line 62 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new ( size_t sz ) [inherited]

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new	(	size_t	sz,
		void *	ptr
	)			`[inherited]`

placement operator new

Definition at line 73 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new[]	(	size_t	sz,
		const char *	file,
		int	line,
		const char *	func
	)			`[inherited]`

array operator new, with debug line info

Definition at line 79 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void* Ogre::AllocatedObject< Alloc >::operator new[] ( size_t sz ) [inherited]

Definition at line 84 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete ( void * ptr ) [inherited]

Definition at line 89 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)			`[inherited]`

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete[] ( void * ptr ) [inherited]

Definition at line 106 of file OgreMemoryAllocatedObject.h.

template<class Alloc>

void Ogre::AllocatedObject< Alloc >::operator delete[]	(	void *	ptr,
		const char *	,
		int	,
		const char *
	)			`[inherited]`

Definition at line 112 of file OgreMemoryAllocatedObject.h.

Member Data Documentation

String Ogre::MeshSerializer::msCurrentVersion [static, protected]

Definition at line 96 of file OgreMeshSerializer.h.

MeshSerializerImplMap Ogre::MeshSerializer::mImplementations [protected]

Definition at line 99 of file OgreMeshSerializer.h.

MeshSerializerListener* Ogre::MeshSerializer::mListener [protected]

Definition at line 101 of file OgreMeshSerializer.h.

uint32 Ogre::Serializer::mCurrentstreamLen [protected, inherited]

Definition at line 64 of file OgreSerializer.h.

FILE* Ogre::Serializer::mpfFile [protected, inherited]

Definition at line 65 of file OgreSerializer.h.

String Ogre::Serializer::mVersion [protected, inherited]

Definition at line 66 of file OgreSerializer.h.

bool Ogre::Serializer::mFlipEndian [protected, inherited]

Definition at line 67 of file OgreSerializer.h.

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

OgreMeshSerializer.h


Public Types
enum	Endian { ENDIAN_NATIVE, ENDIAN_BIG, ENDIAN_LITTLE }
	The endianness of written files. More...
Public Member Functions
	MeshSerializer ()
virtual	~MeshSerializer ()
void	exportMesh (const Mesh *pMesh, const String &filename, Endian endianMode=ENDIAN_NATIVE)
	Exports a mesh to the file specified.
void	importMesh (DataStreamPtr &stream, Mesh *pDest)
	Imports Mesh and (optionally) Material data from a .mesh file DataStream.
void	setListener (MeshSerializerListener *listener)
	Sets the listener for this serializer.
MeshSerializerListener *	getListener ()
	Returns the current listener.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, void )
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Protected Types
typedef std::map< String, MeshSerializerImpl * >	MeshSerializerImplMap
Protected Member Functions
virtual void	writeFileHeader (void)
virtual void	writeChunkHeader (uint16 id, size_t size)
void	writeFloats (const float *const pfloat, size_t count)
void	writeFloats (const double *const pfloat, size_t count)
void	writeShorts (const uint16 *const pShort, size_t count)
void	writeInts (const uint32 *const pInt, size_t count)
void	writeBools (const bool *const pLong, size_t count)
void	writeObject (const Vector3 &vec)
void	writeObject (const Quaternion &q)
void	writeString (const String &string)
void	writeData (const void *const buf, size_t size, size_t count)
virtual void	readFileHeader (DataStreamPtr &stream)
virtual unsigned short	readChunk (DataStreamPtr &stream)
void	readBools (DataStreamPtr &stream, bool *pDest, size_t count)
void	readFloats (DataStreamPtr &stream, float *pDest, size_t count)
void	readFloats (DataStreamPtr &stream, double *pDest, size_t count)
void	readShorts (DataStreamPtr &stream, uint16 *pDest, size_t count)
void	readInts (DataStreamPtr &stream, uint32 *pDest, size_t count)
void	readObject (DataStreamPtr &stream, Vector3 &pDest)
void	readObject (DataStreamPtr &stream, Quaternion &pDest)
String	readString (DataStreamPtr &stream)
String	readString (DataStreamPtr &stream, size_t numChars)
virtual void	flipToLittleEndian (void *pData, size_t size, size_t count=1)
virtual void	flipFromLittleEndian (void *pData, size_t size, size_t count=1)
virtual void	flipEndian (void *pData, size_t size, size_t count)
virtual void	flipEndian (void *pData, size_t size)
virtual void	determineEndianness (DataStreamPtr &stream)
	Determine the endianness of the incoming stream compared to native.
virtual void	determineEndianness (Endian requestedEndian)
	Determine the endianness to write with based on option.
Protected Attributes
MeshSerializerImplMap	mImplementations
MeshSerializerListener *	mListener
uint32	mCurrentstreamLen
FILE *	mpfFile
String	mVersion
bool	mFlipEndian
Static Protected Attributes
static String	msCurrentVersion