Gazebo Rendering

API Reference

6.6.3

Ogre2.x implementation of the submesh class. More...

#include <Ogre2Mesh.hh>

Public Member Functions

virtual ~Ogre2SubMesh ()
 Destructor. More...
 
virtual void Destroy () override
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior. More...
 
virtual Ogre::SubItem * Ogre2SubItem () const
 Get internal ogre subitem created from this submesh. More...
 
void SetMeshName (const std::string &_name)
 Set the name of the mesh stored in Ogre2. More...
 
- Public Member Functions inherited from BaseSubMesh< Ogre2Object >
virtual ~BaseSubMesh ()
 
virtual MaterialPtr Material () const override
 Get the currently assigned material. More...
 
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. More...
 
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. More...
 
virtual void SetMaterial (MaterialPtr _material, bool _unique=true) override
 Set the materials of this SubMesh. More...
 
- Public Member Functions inherited from SubMesh
virtual ~SubMesh ()
 Deconstructor. More...
 
virtual MaterialPtr Material () const =0
 Get the currently assigned material. More...
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor. 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 void PostRender ()=0
 Post process this object and any of its children after rendering. More...
 
virtual ScenePtr Scene () const =0
 Get the Scene that created this object. More...
 
- Public Member Functions inherited from Ogre2Object
virtual ~Ogre2Object ()
 Destructor. More...
 
virtual ScenePtr Scene () const override
 
- Public Member Functions inherited from BaseObject
virtual ~BaseObject ()
 
virtual unsigned int Id () const override
 
virtual std::string Name () const override
 
virtual void PostRender () override
 

Protected Member Functions

 Ogre2SubMesh ()
 Constructor. More...
 
virtual void Init () override
 Initialize the submesh. More...
 
virtual void SetMaterialImpl (MaterialPtr _material) override
 Helper function for setting the material to use. More...
 
- Protected Member Functions inherited from BaseSubMesh< Ogre2Object >
 BaseSubMesh ()
 
- Protected Member Functions inherited from Ogre2Object
 Ogre2Object ()
 Constructor. More...
 
- Protected Member Functions inherited from BaseObject
 BaseObject ()
 
virtual void Load ()
 

Protected Attributes

Ogre::SubItem * ogreSubItem = nullptr
 Ogre subitem representing the submesh. More...
 
- Protected Attributes inherited from BaseSubMesh< Ogre2Object >
MaterialPtr material
 Pointer to currently assigned material. More...
 
bool ownsMaterial
 Flag to indicate whether or not this submesh should be responsible for destroying the material. More...
 
- Protected Attributes inherited from Ogre2Object
Ogre2ScenePtr scene
 Pointer to the ogre scene. More...
 
- Protected Attributes inherited from BaseObject
unsigned int id
 
std::string name
 

Detailed Description

Ogre2.x implementation of the submesh class.

Constructor & Destructor Documentation

◆ Ogre2SubMesh()

Ogre2SubMesh ( )
protected

Constructor.

◆ ~Ogre2SubMesh()

virtual ~Ogre2SubMesh ( )
virtual

Destructor.

Member Function Documentation

◆ Destroy()

virtual void Destroy ( )
overridevirtual

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

Reimplemented from BaseSubMesh< Ogre2Object >.

◆ Init()

virtual void Init ( )
overrideprotectedvirtual

Initialize the submesh.

Reimplemented from BaseObject.

◆ Ogre2SubItem()

virtual Ogre::SubItem* Ogre2SubItem ( ) const
virtual

Get internal ogre subitem created from this submesh.

◆ SetMaterialImpl()

virtual void SetMaterialImpl ( MaterialPtr  _material)
overrideprotectedvirtual

Helper function for setting the material to use.

Parameters
[in]_materialMaterial to be assigned to the submesh

Implements BaseSubMesh< Ogre2Object >.

◆ SetMeshName()

void SetMeshName ( const std::string _name)

Set the name of the mesh stored in Ogre2.

Parameters
[in]_nameName of the mesh

Member Data Documentation

◆ ogreSubItem

Ogre::SubItem* ogreSubItem = nullptr
protected

Ogre subitem representing the submesh.


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