Ogre2MeshFactory Class Reference

Ogre2.x implementation of the mesh factory class. More...

#include <Ogre2MeshFactory.hh>

Public Member Functions
	Ogre2MeshFactory (Ogre2ScenePtr _scene)
	Constructor. More...
virtual	~Ogre2MeshFactory ()
	Destructor. More...
virtual void	Clear ()
	Cleanup and clear all internal ogre v2 meshes created by this factory. More...
void	ClearMaterialsCache (const std::string &_name)
	Remove internal material cache for a specific material. More...
virtual Ogre2MeshPtr	Create (const MeshDescriptor &_desc)
	Create a mesh from a descriptor. More...

Protected Member Functions
virtual bool	IsLoaded (const MeshDescriptor &_desc)
	Check if the mesh is loaded using a mesh descriptor. More...
virtual bool	Load (const MeshDescriptor &_desc)
	Load a mesh using a mesh descriptor. More...
virtual bool	LoadImpl (const MeshDescriptor &_desc)
	Helper function to load the mesh from the input mesh descriptor. More...
virtual std::string	MeshName (const MeshDescriptor &_desc)
	Get the mesh name from the mesh descriptor. More...
virtual Ogre::Item *	OgreItem (const MeshDescriptor &_desc)
	Get the ogre item based on the mesh descriptor. More...
virtual bool	Validate (const MeshDescriptor &_desc)
	Validate the mesh descriptor to make sure it contains all the needed information to create a mesh. More...

Protected Attributes
std::vector< std::string >	ogreMeshes
	A list of ogre meshes created by this factory. More...
Ogre2ScenePtr	scene
	Pointer to the scene object. More...

Detailed Description

Ogre2.x implementation of the mesh factory class.

Constructor & Destructor Documentation

Ogre2MeshFactory()

Ogre2MeshFactory ( Ogre2ScenePtr  _scene )

explicit

Constructor.

Parameters

[in]

_scene

Pointer to the scene

~Ogre2MeshFactory()

virtual ~Ogre2MeshFactory ( )

virtual

Destructor.

Member Function Documentation

Clear()

virtual void Clear ( )

virtual

Cleanup and clear all internal ogre v2 meshes created by this factory.

ClearMaterialsCache()

void ClearMaterialsCache

(

const std::string &

_name

)

Remove internal material cache for a specific material.

Create()

virtual Ogre2MeshPtr Create ( const MeshDescriptor &  _desc )

virtual

Create a mesh from a descriptor.

Parameters

[in]

_desc

Mesh descriptor containing data needed to create a mesh

IsLoaded()

virtual bool IsLoaded ( const MeshDescriptor &  _desc )

protectedvirtual

Check if the mesh is loaded using a mesh descriptor.

Parameters

[in]

_desc

Mesh descriptor containing the mesh name used by this function for checking the loaded state

Load()

virtual bool Load ( const MeshDescriptor &  _desc )

protectedvirtual

Load a mesh using a mesh descriptor.

Parameters

[in]

_desc

Mesh descriptor

LoadImpl()

virtual bool LoadImpl ( const MeshDescriptor &  _desc )

protectedvirtual

Helper function to load the mesh from the input mesh descriptor.

Parameters

[in]

_desc

Input mesh descriptor

MeshName()

virtual std::string MeshName ( const MeshDescriptor &  _desc )

protectedvirtual

Get the mesh name from the mesh descriptor.

Parameters

[in]

_desc

Mesh descriptor containing the mesh name

OgreItem()

virtual Ogre::Item* OgreItem ( const MeshDescriptor &  _desc )

protectedvirtual

Get the ogre item based on the mesh descriptor.

Parameters

[in]

_desc

Descriptor describing the target mesh

Validate()

virtual bool Validate ( const MeshDescriptor &  _desc )

protectedvirtual

Validate the mesh descriptor to make sure it contains all the needed information to create a mesh.

Parameters

[in]

_desc

Mesh descriptor to be validated

Member Data Documentation

ogreMeshes

std::vector<std::string> ogreMeshes

protected

A list of ogre meshes created by this factory.

scene

Ogre2ScenePtr scene

protected

Pointer to the scene object.

---

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

• gz/rendering/ogre2/Ogre2MeshFactory.hh