Gazebo Rendering

API Reference

9.0.0
SubMesh Class Referenceabstract

Represents a single mesh geometry. More...

#include <gz/rendering/Mesh.hh>

Public Member Functions

virtual ~SubMesh ()
 Destructor.
 
virtual MaterialPtr Material () const =0
 Get the currently assigned material.
 
virtual void SetMaterial (const std::string &_name, bool _unique=true)=0
 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)=0
 Set the materials of this SubMesh.
 
- Public Member Functions inherited from Object
virtual ~Object ()
 Destructor.
 
virtual void Destroy ()=0
 Destroy any resources associated with this object. Invoking any other functions after destroying an object will result in undefined behavior.
 
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 void PreRender ()=0
 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 ScenePtr Scene () const =0
 Get the Scene that created this object.
 

Detailed Description

Represents a single mesh geometry.

Constructor & Destructor Documentation

◆ ~SubMesh()

virtual ~SubMesh ( )
virtual

Destructor.

Member Function Documentation

◆ Material()

virtual MaterialPtr Material ( ) const
pure virtual

Get the currently assigned material.

Returns
The currently assigned material

Implemented in BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, and BaseSubMesh< OgreObject >.

◆ SetMaterial() [1/2]

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

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

Implemented in BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, and BaseSubMesh< OgreObject >.

◆ SetMaterial() [2/2]

virtual void SetMaterial ( MaterialPtr  _material,
bool  _unique = true 
)
pure virtual

Set the materials of this SubMesh.

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

Implemented in BaseSubMesh< T >, BaseSubMesh< Ogre2Object >, and BaseSubMesh< OgreObject >.


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