OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Ogre::RenderQueue::RenderableListener Class Referenceabstract

Class to listen in on items being added to the render queue. More...

#include <OgreRenderQueue.h>

Public Member Functions

 RenderableListener ()
 
virtual ~RenderableListener ()
 
virtual bool renderableQueued (Renderable *rend, uint8 groupID, ushort priority, Technique **ppTech, RenderQueue *pQueue)=0
 Method called when a Renderable is added to the queue. More...
 

Detailed Description

Class to listen in on items being added to the render queue.

Remarks
Use RenderQueue::setRenderableListener to get callbacks when an item is added to the render queue.

Definition at line 105 of file OgreRenderQueue.h.

Constructor & Destructor Documentation

Ogre::RenderQueue::RenderableListener::RenderableListener ( )
inline

Definition at line 108 of file OgreRenderQueue.h.

virtual Ogre::RenderQueue::RenderableListener::~RenderableListener ( )
inlinevirtual

Definition at line 109 of file OgreRenderQueue.h.

Member Function Documentation

virtual bool Ogre::RenderQueue::RenderableListener::renderableQueued ( Renderable rend,
uint8  groupID,
ushort  priority,
Technique **  ppTech,
RenderQueue pQueue 
)
pure virtual

Method called when a Renderable is added to the queue.

Remarks
You can use this event hook to alter the Technique used to render a Renderable as the item is added to the queue. This is a low-level way to override the material settings for a given Renderable on the fly.
Parameters
rendThe Renderable being added to the queue
groupIDThe render queue group this Renderable is being added to
priorityThe priority the Renderable has been given
ppTechA pointer to the pointer to the Technique that is intended to be used; you can alter this to an alternate Technique if you so wish (the Technique doesn't have to be from the same Material either).
pQueuePointer to the render queue that this object is being added to. You can for example call this back to duplicate the object with a different technique
Returns
true to allow the Renderable to be added to the queue, false if you want to prevent it being added

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