Mezzanine::Graphics::Mesh Class Reference

This class is used to check and modify the properties of a graphics mesh. More...

#include <mesh.h>

Collaboration diagram for Mezzanine::Graphics::Mesh:

Public Types
typedef SubMeshContainer::const_iterator	ConstSubMeshIterator
	A const iterator type for SubMeshes being stored by this class.
typedef std::vector< SubMesh * >	SubMeshContainer
	A convenience type for the storage of SubMeshes in this class.
typedef SubMeshContainer::iterator	SubMeshIterator
	An iterator type for SubMeshes being stored by this class.

Public Member Functions
	Mesh (Ogre::MeshPtr InternalMesh)
	Internal Constructor. More...
	~Mesh ()
	Class Destructor.
Ogre::MeshPtr	_GetInternalMesh () const
	Gets the internal Mesh pointer. More...
ConstString &	GetGroup () const
	Gets the resource group this Mesh belongs to. More...
Whole	GetIndexCount () const
	Gets the number of Indices in this Mesh. More...
ConstString &	GetName () const
	Gets the Name of this Mesh. More...
Whole	GetNumSubMeshes () const
	Gets the number of SubMeshes in this Mesh. More...
SubMesh *	GetSubMesh (const Whole Index) const
	Gets a SubMesh by index. More...
Whole	GetVertexCount () const
	Gets the number of Vertices in this Mesh. More...

Protected Member Functions
void	DestroyAllWrappedSubMeshes ()
	Destroys every wrapped (but not the underlying instance) SubMesh in this Mesh. More...
void	WrapAllSubMeshes ()
	Constructs a Mezzanine wrapper for every SubMesh in the internal Mesh. More...

Protected Attributes
InternalMeshData *	IMD
	A pointer to the internal data this Mesh is based on. More...
Skeleton *	MeshSkel
	If Skeletal animations are enabled on this Mesh, this is a pointer to the Skeleton being used. More...
SubMeshContainer	SubMeshes
	A container storing all the SubMeshes in this Mesh. More...

Detailed Description

This class is used to check and modify the properties of a graphics mesh.

Definition at line 63 of file mesh.h.

Constructor & Destructor Documentation

Mezzanine::Graphics::Mesh::Mesh

(

Ogre::MeshPtr

InternalMesh

)

Internal Constructor.

Parameters

InternalMesh

The internal Mesh this Mesh class is based on.

Definition at line 69 of file mesh.cpp.

Member Function Documentation

Ogre::MeshPtr Mezzanine::Graphics::Mesh::_GetInternalMesh

(

)

const

Gets the internal Mesh pointer.

Returns

Returns a shared pointer pointing to the internal Mesh.

Definition at line 151 of file mesh.cpp.

void Mezzanine::Graphics::Mesh::DestroyAllWrappedSubMeshes ( )

protected

Destroys every wrapped (but not the underlying instance) SubMesh in this Mesh.

Definition at line 99 of file mesh.cpp.

ConstString & Mezzanine::Graphics::Mesh::GetGroup

(

)

const

Gets the resource group this Mesh belongs to.

Returns

Returns a const string reference containing the group this Mesh belongs to.

Definition at line 145 of file mesh.cpp.

Whole Mezzanine::Graphics::Mesh::GetIndexCount

(

)

const

Gets the number of Indices in this Mesh.

Returns

Returns the number of Indices used to assemble the vertices in all SubMeshes in this Mesh.

Definition at line 117 of file mesh.cpp.

ConstString & Mezzanine::Graphics::Mesh::GetName

(

)

const

Gets the Name of this Mesh.

Note

If this Mesh originated from a file, usually the name of the Mesh will be the file name.

Returns

Returns a const string reference containing the name of this Mesh.

Definition at line 142 of file mesh.cpp.

Whole Mezzanine::Graphics::Mesh::GetNumSubMeshes

(

)

const

Gets the number of SubMeshes in this Mesh.

Returns

Returns a Whole representing the number of SubMeshes that make up this Mesh.

Definition at line 131 of file mesh.cpp.

SubMesh * Mezzanine::Graphics::Mesh::GetSubMesh

(

const Whole

Index

)

const

Gets a SubMesh by index.

Parameters

Index

The index of the SubMesh to retrieve.

Returns

Returns a pointer to the SubMesh at the specified index.

Definition at line 128 of file mesh.cpp.

Whole Mezzanine::Graphics::Mesh::GetVertexCount

(

)

const

Gets the number of Vertices in this Mesh.

Returns

Returns the number of Vertices that make up all SubMeshes in this Mesh.

Definition at line 109 of file mesh.cpp.

void Mezzanine::Graphics::Mesh::WrapAllSubMeshes ( )

protected

Constructs a Mezzanine wrapper for every SubMesh in the internal Mesh.

Definition at line 83 of file mesh.cpp.

Member Data Documentation

InternalMeshData* Mezzanine::Graphics::Mesh::IMD

protected

A pointer to the internal data this Mesh is based on.

Definition at line 75 of file mesh.h.

Skeleton* Mezzanine::Graphics::Mesh::MeshSkel

protected

If Skeletal animations are enabled on this Mesh, this is a pointer to the Skeleton being used.

Definition at line 78 of file mesh.h.

SubMeshContainer Mezzanine::Graphics::Mesh::SubMeshes

protected

A container storing all the SubMeshes in this Mesh.

Definition at line 81 of file mesh.h.

---

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

• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/mesh.h
• /home/sqeaky/Code/MezzanineFresh/Mezzanine/src/Graphics/mesh.cpp