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

#include <OgreMeshSerializer.h>

Inheritance diagram for Ogre::MeshSerializer:

Collaboration diagram for Ogre::MeshSerializer:

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. More...

MeshSerializerListener *	getListener ()
	Returns the current listener. More...

void	importMesh (DataStreamPtr &stream, Mesh *pDest)
	Imports Mesh and (optionally) Material data from a .mesh file DataStream. More...

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 *)

void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info More...

void *	operator new (size_t sz)

void *	operator new (size_t sz, void *ptr)
	placement operator new More...

void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info More...

void *	operator new[] (size_t sz)

void	setListener (MeshSerializerListener *listener)
	Sets the listener for this serializer. More...

Protected Types
typedef map< String, MeshSerializerImpl * >::type	MeshSerializerImplMap

Protected Member Functions
virtual void	determineEndianness (DataStreamPtr &stream)
	Determine the endianness of the incoming stream compared to native. More...

virtual void	determineEndianness (Endian requestedEndian)
	Determine the endianness to write with based on option. More...

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

virtual void	flipEndian (void *pData, size_t size)

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

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

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

virtual unsigned short	readChunk (DataStreamPtr &stream)

virtual void	readFileHeader (DataStreamPtr &stream)

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

void	readFloats (DataStreamPtr &stream, double *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)

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

String	readString (DataStreamPtr &stream)

String	readString (DataStreamPtr &stream, size_t numChars)

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

virtual void	writeChunkHeader (uint16 id, size_t size)

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

virtual void	writeFileHeader (void)

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

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

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

void	writeObject (const Vector3 &vec)

void	writeObject (const Quaternion &q)

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

void	writeString (const String &string)

Protected Attributes
uint32	mCurrentstreamLen

bool	mFlipEndian

MeshSerializerImplMap	mImplementations

MeshSerializerListener *	mListener

FILE *	mpfFile

String	mVersion

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 69 of file OgreMeshSerializer.h.

Member Typedef Documentation

typedef map<String, MeshSerializerImpl* >::type Ogre::MeshSerializer::MeshSerializerImplMap

protected

Definition at line 103 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 56 of file OgreSerializer.h.

Constructor & Destructor Documentation

Ogre::MeshSerializer::MeshSerializer ( )

virtual Ogre::MeshSerializer::~MeshSerializer ( )

virtual

Member Function Documentation

virtual void Ogre::Serializer::determineEndianness ( DataStreamPtr & stream )

protectedvirtualinherited

Determine the endianness of the incoming stream compared to native.

virtual void Ogre::Serializer::determineEndianness ( Endian requestedEndian )

protectedvirtualinherited

Determine the endianness to write with based on option.

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

virtual void Ogre::Serializer::flipEndian	(	void *	pData,
		size_t	size,
		size_t	count
	)

protectedvirtualinherited

virtual void Ogre::Serializer::flipEndian	(	void *	pData,
		size_t	size
	)

protectedvirtualinherited

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

protectedvirtualinherited

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

protectedvirtualinherited

MeshSerializerListener* Ogre::MeshSerializer::getListener ( )

Returns the current listener.

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.

template<class Alloc >

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

inlineinherited

Definition at line 95 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

void Ogre::AllocatedObject< Alloc >::operator delete	(	void *	ptr,
		void *
	)

inlineinherited

Definition at line 101 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 107 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 112 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 118 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

operator new, with debug line info

Definition at line 67 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 72 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

placement operator new

Definition at line 78 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

array operator new, with debug line info

Definition at line 85 of file OgreMemoryAllocatedObject.h.

template<class Alloc >

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

inlineinherited

Definition at line 90 of file OgreMemoryAllocatedObject.h.

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

protectedinherited

virtual unsigned short Ogre::Serializer::readChunk ( DataStreamPtr & stream )

protectedvirtualinherited

virtual void Ogre::Serializer::readFileHeader ( DataStreamPtr & stream )

protectedvirtualinherited

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

protectedinherited

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

protectedinherited

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

protectedinherited

void Ogre::Serializer::readObject	(	DataStreamPtr &	stream,
		Vector3 &	pDest
	)

protectedinherited

void Ogre::Serializer::readObject	(	DataStreamPtr &	stream,
		Quaternion &	pDest
	)

protectedinherited

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

protectedinherited

String Ogre::Serializer::readString ( DataStreamPtr & stream )

protectedinherited

String Ogre::Serializer::readString	(	DataStreamPtr &	stream,
		size_t	numChars
	)

protectedinherited

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

Sets the listener for this serializer.

void Ogre::Serializer::writeBools	(	const bool *const	pLong,
		size_t	count
	)

protectedinherited

virtual void Ogre::Serializer::writeChunkHeader	(	uint16	id,
		size_t	size
	)

protectedvirtualinherited

void Ogre::Serializer::writeData	(	const void *const	buf,
		size_t	size,
		size_t	count
	)

protectedinherited

virtual void Ogre::Serializer::writeFileHeader ( void )

protectedvirtualinherited

void Ogre::Serializer::writeFloats	(	const float *const	pfloat,
		size_t	count
	)

protectedinherited

void Ogre::Serializer::writeFloats	(	const double *const	pfloat,
		size_t	count
	)

protectedinherited

void Ogre::Serializer::writeInts	(	const uint32 *const	pInt,
		size_t	count
	)

protectedinherited

void Ogre::Serializer::writeObject ( const Vector3 & vec )

protectedinherited

void Ogre::Serializer::writeObject ( const Quaternion & q )

protectedinherited

void Ogre::Serializer::writeShorts	(	const uint16 *const	pShort,
		size_t	count
	)

protectedinherited

void Ogre::Serializer::writeString ( const String & string )

protectedinherited

Member Data Documentation

uint32 Ogre::Serializer::mCurrentstreamLen

protectedinherited

Definition at line 69 of file OgreSerializer.h.

bool Ogre::Serializer::mFlipEndian

protectedinherited

Definition at line 72 of file OgreSerializer.h.

MeshSerializerImplMap Ogre::MeshSerializer::mImplementations

protected

Definition at line 104 of file OgreMeshSerializer.h.

MeshSerializerListener* Ogre::MeshSerializer::mListener

protected

Definition at line 106 of file OgreMeshSerializer.h.

FILE* Ogre::Serializer::mpfFile

protectedinherited

Definition at line 70 of file OgreSerializer.h.

String Ogre::MeshSerializer::msCurrentVersion

staticprotected

Definition at line 101 of file OgreMeshSerializer.h.

String Ogre::Serializer::mVersion

protectedinherited

Definition at line 71 of file OgreSerializer.h.

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

OgreMeshSerializer.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Typedef Documentation

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation