Ignition Rendering

API Reference

6.3.1
List of all members | Public Member Functions
OgreMaterialSwitcher Class Reference

Helper class to assign unique colors to renderables. More...

#include <OgreMaterialSwitcher.hh>

Public Member Functions

 OgreMaterialSwitcher ()
 Constructor. More...
 
 ~OgreMaterialSwitcher ()
 Destructor. More...
 
std::string EntityName (const ignition::math::Color &_color) const
 Get the entity with a specific color. More...
 
virtual Ogre::Technique * handleSchemeNotFound (uint16_t _schemeIndex, const Ogre::String &_schemeName, Ogre::Material *_originalMaterial, uint16_t _lodIndex, const Ogre::Renderable *_rend)
 Ogre callback that assigns colors to new renderables when the requested scheme is not found. More...
 
virtual void postRenderTargetUpdate (const Ogre::RenderTargetEvent &_evt)
 Ogre's post render update callback. More...
 
virtual void preRenderTargetUpdate (const Ogre::RenderTargetEvent &_evt)
 Ogre's pre render update callback. More...
 
void Reset ()
 Reset the color value incrementor. More...
 

Detailed Description

Helper class to assign unique colors to renderables.

Constructor & Destructor Documentation

◆ OgreMaterialSwitcher()

OgreMaterialSwitcher ( )

Constructor.

◆ ~OgreMaterialSwitcher()

~OgreMaterialSwitcher ( )

Destructor.

Member Function Documentation

◆ EntityName()

std::string EntityName ( const ignition::math::Color &  _color) const

Get the entity with a specific color.

Parameters
[in]_colorThe entity's color.

◆ handleSchemeNotFound()

virtual Ogre::Technique* handleSchemeNotFound ( uint16_t  _schemeIndex,
const Ogre::String &  _schemeName,
Ogre::Material *  _originalMaterial,
uint16_t  _lodIndex,
const Ogre::Renderable *  _rend 
)
virtual

Ogre callback that assigns colors to new renderables when the requested scheme is not found.

Parameters
[in]_schemeIndexIndex of scheme requested
[in]_schemeNameName of scheme requested
[in]_originalMaterialOrignal material that does not contain the requested scheme
[in]_lodIndexThe material level-of-detail
[in]_rendPointer to the Ogre::Renderable object requesting the use of the techinique
Returns
The Ogre material technique to use when scheme is not found.

◆ postRenderTargetUpdate()

virtual void postRenderTargetUpdate ( const Ogre::RenderTargetEvent &  _evt)
virtual

Ogre's post render update callback.

Parameters
[in]_evtOgre render target event containing information about the source render target.

◆ preRenderTargetUpdate()

virtual void preRenderTargetUpdate ( const Ogre::RenderTargetEvent &  _evt)
virtual

Ogre's pre render update callback.

Parameters
[in]_evtOgre render target event containing information about the source render target.

◆ Reset()

void Reset ( )

Reset the color value incrementor.

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