Ignition Rendering

API Reference

0.1.0
List of all members | Public Member Functions | Protected Member Functions
BaseMesh< T > Class Template Referenceabstract

#include <BaseMesh.hh>

Public Member Functions

virtual ~BaseMesh ()
 
virtual void Destroy ()
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual bool HasSubMesh (ConstSubMeshPtr _subMesh) const
 Determine if has given sub-mesh. More...
 
virtual bool HasSubMeshName (const std::string &_name) const
 Determine if has sub-mesh with given name. More...
 
virtual MaterialPtr Material () const
 Get the material of this geometry. More...
 
virtual void PreRender ()
 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. More...
 
virtual void SetMaterial (const std::string &_name, bool _unique=true)
 Set the materials of this Geometry. The specified material will be retrieved from the parent Scene. If no material is registered by the given name, no work will be done. More...
 
virtual void SetMaterial (MaterialPtr _material, bool _unique=true)
 Set the materials of this Geometry. More...
 
virtual SubMeshPtr SubMeshByIndex (unsigned int _index) const
 Get sub-mesh at given index. More...
 
virtual SubMeshPtr SubMeshByName (const std::string &_name) const
 Get sub-mesh with given name. More...
 
virtual unsigned int SubMeshCount () const
 Get the sub-mesh count. More...
 
- Public Member Functions inherited from Mesh
virtual ~Mesh ()
 Destructor. More...
 
- Public Member Functions inherited from Geometry
virtual ~Geometry ()
 Deconstructor. More...
 
virtual bool HasParent () const =0
 Determine if this Geometry is attached to a Visual. More...
 
virtual VisualPtr Parent () const =0
 Get the parent Visual. More...
 
virtual void RemoveParent ()=0
 Detach this Geometry from its parent Visual. If this Geometry does not have a parent, no work will be done. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Deconstructor. More...
 
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. More...
 
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. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 

Protected Member Functions

 BaseMesh ()
 
virtual SubMeshStorePtr SubMeshes () const =0
 

Constructor & Destructor Documentation

◆ BaseMesh()

BaseMesh ( )
protected

◆ ~BaseMesh()

~BaseMesh ( )
virtual

Member Function Documentation

◆ Destroy()

void Destroy ( )
virtual

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

Implements Object.

◆ HasSubMesh()

bool HasSubMesh ( ConstSubMeshPtr  _subMesh) const
virtual

Determine if has given sub-mesh.

Parameters
[in]_subMeshSub-mesh in question
Returns
True if has given sub-mesh

Implements Mesh.

◆ HasSubMeshName()

bool HasSubMeshName ( const std::string &  _name) const
virtual

Determine if has sub-mesh with given name.

Parameters
[in]_nameName of sub-mesh in question
Returns
True if has sub-mesh with given name

Implements Mesh.

◆ Material()

MaterialPtr Material ( ) const
virtual

Get the material of this geometry.

Returns
Material used by this geometry

Implements Geometry.

Referenced by BaseSubMesh< OgreObject >::PreRender().

◆ PreRender()

void PreRender ( )
virtual

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.

◆ SetMaterial() [1/2]

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

Set the materials of this Geometry. 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]_nameName of registered Material
[in]_uniqueTrue if the specified material should be cloned

Implements Geometry.

Referenced by BaseMesh< OgreGeometry >::SetMaterial(), and BaseSubMesh< OgreObject >::SetMaterial().

◆ SetMaterial() [2/2]

void SetMaterial ( MaterialPtr  _material,
bool  unique = true 
)
virtual

Set the materials of this Geometry.

Parameters
[in]_materialNew Material to be assigned
[in]_uniqueTrue if the given material should be cloned

Implements Geometry.

◆ SubMeshByIndex()

SubMeshPtr SubMeshByIndex ( unsigned int  _index) const
virtual

Get sub-mesh at given index.

Parameters
[in]_indexIndex of sub-mesh
Returns
The sub-mesh at the given index

Implements Mesh.

Referenced by BaseMesh< OgreGeometry >::Material(), BaseMesh< OgreGeometry >::PreRender(), and BaseMesh< OgreGeometry >::SetMaterial().

◆ SubMeshByName()

SubMeshPtr SubMeshByName ( const std::string &  _name) const
virtual

Get sub-mesh with given name.

Parameters
[in]_nameName of sub-mesh
Returns
The sub-mesh with the given name

Implements Mesh.

◆ SubMeshCount()

unsigned int SubMeshCount ( ) const
virtual

Get the sub-mesh count.

Returns
The sub-mesh count

Implements Mesh.

Referenced by BaseMesh< OgreGeometry >::Material(), BaseMesh< OgreGeometry >::PreRender(), and BaseMesh< OgreGeometry >::SetMaterial().

◆ SubMeshes()

virtual SubMeshStorePtr SubMeshes ( ) const
protectedpure virtual

Implemented in OgreMesh.

Referenced by BaseMesh< OgreGeometry >::Destroy(), BaseMesh< OgreGeometry >::HasSubMesh(), BaseMesh< OgreGeometry >::HasSubMeshName(), BaseMesh< OgreGeometry >::SubMeshByIndex(), BaseMesh< OgreGeometry >::SubMeshByName(), and BaseMesh< OgreGeometry >::SubMeshCount().

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