BaseSubMesh< T > Class Template Reference

#include <BaseMesh.hh>

Public Member Functions
virtual	~BaseSubMesh ()
virtual void	Destroy () override
	Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
virtual MaterialPtr	Material () const override
	Get the currently assigned material.
virtual void	PreRender () override
	Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.
virtual void	SetMaterial (const std::string &_name, bool _unique=true) override
	Set the materials of this SubMesh. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done.
virtual void	SetMaterial (MaterialPtr _material, bool _unique=true) override
	Set the materials of this SubMesh.
virtual void	SetMaterialImpl (MaterialPtr _material)=0
	Engine implementation for setting the material of this SubMesh.
Public Member Functions inherited from SubMesh
virtual	~SubMesh ()
	Destructor.
Public Member Functions inherited from Object
virtual	~Object ()
	Destructor.
virtual unsigned int	Id () const =0
	Get the object ID. This ID will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
virtual std::string	Name () const =0
	Get the object name. This name will be unique across all objects inside a given scene, but necessarily true for objects across different scenes.
virtual void	PostRender ()=0
	Post process this object and any of its children after rendering.
virtual ScenePtr	Scene () const =0
	Get the Scene that created this object.

Protected Member Functions
	BaseSubMesh ()

Protected Attributes
MaterialPtr	material
	Pointer to currently assigned material.
bool	ownsMaterial = false
	Flag to indicate whether or not this submesh should be responsible for destroying the material.

Constructor & Destructor Documentation

BaseSubMesh()

template<class T >

BaseSubMesh ( )

protected

~BaseSubMesh()

template<class T >

~BaseSubMesh ( )

virtual

Member Function Documentation

Destroy()

template<class T >

void Destroy ( )

overridevirtual

Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.

Implements Object.

Reimplemented in OgreSubMesh, and Ogre2SubMesh.

References Scene::DestroyMaterial().

Material()

template<class T >

MaterialPtr Material ( ) const

overridevirtual

Get the currently assigned material.

Returns

The currently assigned material

Implements SubMesh.

PreRender()

template<class T >

void PreRender ( )

overridevirtual

Prepare this object and any of its children for rendering. This should be called for each object in a scene just before rendering, which can be achieved by a single call to Scene::PreRender.

Implements Object.

References Object::PreRender().

SetMaterial() [1/2]

template<class T >

void SetMaterial ( const std::string &  _name, bool  _unique = true  )

overridevirtual

Set the materials of this SubMesh. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done.

Parameters

[in]	_name	Name of registered Material
[in]	_unique	True if the specified material should be cloned

Implements SubMesh.

References Scene::Material().

SetMaterial() [2/2]

template<class T >

void SetMaterial ( MaterialPtr  _material, bool  _unique = true  )

overridevirtual

Set the materials of this SubMesh.

Parameters

[in]	_material	New Material to be assigned
[in]	_unique	True if the given material should be cloned

Implements SubMesh.

References Scene::DestroyMaterial().

SetMaterialImpl()

template<class T >

virtual void SetMaterialImpl ( MaterialPtr  _material )

pure virtual

Engine implementation for setting the material of this SubMesh.

Parameters

[in]

_material

New Material to be assigned

Implemented in OgreSubMesh, and Ogre2SubMesh.

Member Data Documentation

material

template<class T >

MaterialPtr material

protected

Pointer to currently assigned material.

ownsMaterial

template<class T >

bool ownsMaterial = false

protected

Flag to indicate whether or not this submesh should be responsible for destroying the material.

---

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

• BaseMesh.hh