OgreRenderQueue.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __RenderQueue_H__
29 #define __RenderQueue_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreIteratorWrappers.h"
33 #include "OgreHeaderPrefix.h"
34 
35 namespace Ogre {
36 
37  class Camera;
38  class MovableObject;
39  struct VisibleObjectsBoundsInfo;
40 
54  {
76  RENDER_QUEUE_MAX = 105
77  };
78 
79  #define OGRE_RENDERABLE_DEFAULT_PRIORITY 100
80 
93  {
94  public:
95 
100 
107  {
108  public:
110  virtual ~RenderableListener() {}
111 
131  virtual bool renderableQueued(Renderable* rend, uint8 groupID,
132  ushort priority, Technique** ppTech, RenderQueue* pQueue) = 0;
133  };
134  protected:
140 
144 
146  public:
148  virtual ~RenderQueue();
149 
154  void clear(bool destroyPassMaps = false);
155 
162 
185  void addRenderable(Renderable* pRend, uint8 groupID, ushort priority);
186 
204  void addRenderable(Renderable* pRend, uint8 groupId);
205 
218  void addRenderable(Renderable* pRend);
219 
224 
230 
235 
241 
245 
250 
255 
260  void setSplitNoShadowPasses(bool split);
261 
266  bool getSplitNoShadowPasses(void) const;
267 
272 
277 
284  { mRenderableListener = listener; }
285 
287  { return mRenderableListener; }
288 
291  void merge( const RenderQueue* rhs );
298  Camera* cam,
299  bool onlyShadowCasters,
300  VisibleObjectsBoundsInfo* visibleBounds);
301 
302  };
303 
307 }
308 
309 #include "OgreHeaderSuffix.h"
310 
311 #endif
OgreHeaderSuffix.h
Ogre::RENDER_QUEUE_OVERLAY
@ RENDER_QUEUE_OVERLAY
Use this queue for objects which must be rendered last e.g. overlays.
Definition: OgreRenderQueue.h:74
Ogre::RenderQueue::getShadowCastersCannotBeReceivers
bool getShadowCastersCannotBeReceivers(void) const
Gets whether or not objects which cast shadows should be treated as never receiving shadows.
Ogre::RenderQueue::addRenderable
void addRenderable(Renderable *pRend, uint8 groupID, ushort priority)
Add a renderable object to the queue.
Ogre::RenderQueueGroup
A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same ti...
Definition: OgreRenderQueueSortingGrouping.h:466
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:59
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::RenderQueue::getSplitPassesByLightingType
bool getSplitPassesByLightingType(void) const
Gets whether or not the queue will split passes by their lighting type, ie ambient,...
Ogre::RenderQueue::setDefaultRenderablePriority
void setDefaultRenderablePriority(ushort priority)
Sets the current default renderable priority, which will be used for all renderables which do not spe...
Ogre::map
Definition: OgrePrerequisites.h:534
Ogre::RenderQueue::RenderableListener::renderableQueued
virtual bool renderableQueued(Renderable *rend, uint8 groupID, ushort priority, Technique **ppTech, RenderQueue *pQueue)=0
Method called when a Renderable is added to the queue.
Ogre::ushort
unsigned short ushort
Definition: OgrePrerequisites.h:113
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:87
Ogre::RenderQueue::mDefaultRenderablePriority
ushort mDefaultRenderablePriority
The default priority.
Definition: OgreRenderQueue.h:139
Ogre::RenderQueue::merge
void merge(const RenderQueue *rhs)
Merge render queue.
Ogre::RenderQueue::getDefaultQueueGroup
uint8 getDefaultQueueGroup(void) const
Gets the current default queue group, which will be used for all renderable which do not specify whic...
Ogre::RenderQueue::processVisibleObject
void processVisibleObject(MovableObject *mo, Camera *cam, bool onlyShadowCasters, VisibleObjectsBoundsInfo *visibleBounds)
Utility method to perform the standard actions associated with getting a visible object to add itself...
Ogre::RenderQueue::mGroups
RenderQueueGroupMap mGroups
Definition: OgreRenderQueue.h:135
Ogre::RENDER_QUEUE_BACKGROUND
@ RENDER_QUEUE_BACKGROUND
Use this queue for objects which must be rendered first e.g. backgrounds.
Definition: OgreRenderQueue.h:56
Ogre::RENDER_QUEUE_8
@ RENDER_QUEUE_8
Definition: OgreRenderQueue.h:69
Ogre::MovableObject
Abstract class defining a movable object in a scene.
Definition: OgreMovableObject.h:61
Ogre::RENDER_QUEUE_SKIES_LATE
@ RENDER_QUEUE_SKIES_LATE
Penultimate queue(before overlays), used for skyboxes if rendered last.
Definition: OgreRenderQueue.h:72
Ogre::RENDER_QUEUE_MAIN
@ RENDER_QUEUE_MAIN
The default render queue.
Definition: OgreRenderQueue.h:65
Ogre::RenderQueue::getQueueGroup
RenderQueueGroup * getQueueGroup(uint8 qid)
Get a render queue group.
Ogre::RENDER_QUEUE_4
@ RENDER_QUEUE_4
Definition: OgreRenderQueue.h:63
Ogre::RenderQueue::clear
void clear(bool destroyPassMaps=false)
Empty the queue - should only be called by SceneManagers.
Ogre::RenderQueue::addRenderable
void addRenderable(Renderable *pRend, uint8 groupId)
Add a renderable object to the queue.
Ogre::Technique
Class representing an approach to rendering this particular Material.
Definition: OgreTechnique.h:54
Ogre::RenderQueue::setShadowCastersCannotBeReceivers
void setShadowCastersCannotBeReceivers(bool ind)
Sets whether or not objects which cast shadows should be treated as never receiving shadows.
Ogre::VisibleObjectsBoundsInfo
Structure collecting together information about the visible objects that have been discovered in a sc...
Definition: OgreSceneManager.h:87
Ogre::RenderQueue::setRenderableListener
void setRenderableListener(RenderableListener *listener)
Set a renderable listener on the queue.
Definition: OgreRenderQueue.h:283
Ogre::RenderQueue::RenderQueue
RenderQueue()
Ogre::RenderQueue::getSplitNoShadowPasses
bool getSplitNoShadowPasses(void) const
Gets whether or not the queue will split passes which have shadow receive turned off (in their parent...
Ogre::RenderQueue::RenderableListener::~RenderableListener
virtual ~RenderableListener()
Definition: OgreRenderQueue.h:110
Ogre::RENDER_QUEUE_MAX
@ RENDER_QUEUE_MAX
Final possible render queue, don't exceed this.
Definition: OgreRenderQueue.h:76
OgreHeaderPrefix.h
Ogre::RENDER_QUEUE_2
@ RENDER_QUEUE_2
Definition: OgreRenderQueue.h:60
Ogre::RENDER_QUEUE_9
@ RENDER_QUEUE_9
Definition: OgreRenderQueue.h:70
OgrePrerequisites.h
Ogre::RenderQueue::setDefaultQueueGroup
void setDefaultQueueGroup(uint8 grp)
Sets the current default queue group, which will be used for all renderable which do not specify whic...
Ogre::RENDER_QUEUE_WORLD_GEOMETRY_2
@ RENDER_QUEUE_WORLD_GEOMETRY_2
Definition: OgreRenderQueue.h:68
Ogre::RENDER_QUEUE_SKIES_EARLY
@ RENDER_QUEUE_SKIES_EARLY
First queue (after backgrounds), used for skyboxes if rendered first.
Definition: OgreRenderQueue.h:58
Ogre::RenderQueue::getDefaultRenderablePriority
ushort getDefaultRenderablePriority(void) const
Gets the current default renderable priority, which will be used for all renderables which do not spe...
Ogre::RenderQueue::mDefaultQueueGroup
uint8 mDefaultQueueGroup
The current default queue group.
Definition: OgreRenderQueue.h:137
Ogre::RenderQueue::ConstQueueGroupIterator
ConstMapIterator< RenderQueueGroupMap > ConstQueueGroupIterator
Definition: OgreRenderQueue.h:99
Ogre::RenderQueue::mSplitNoShadowPasses
bool mSplitNoShadowPasses
Definition: OgreRenderQueue.h:142
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::RenderQueue::setSplitNoShadowPasses
void setSplitNoShadowPasses(bool split)
Sets whether or not the queue will split passes which have shadow receive turned off (in their parent...
Ogre::RENDER_QUEUE_WORLD_GEOMETRY_1
@ RENDER_QUEUE_WORLD_GEOMETRY_1
Definition: OgreRenderQueue.h:61
Ogre::uint8
unsigned char uint8
Definition: OgrePlatform.h:361
Ogre::MapIterator
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
Definition: OgreIteratorWrapper.h:319
Ogre::RenderQueue::~RenderQueue
virtual ~RenderQueue()
Ogre::RENDER_QUEUE_6
@ RENDER_QUEUE_6
Definition: OgreRenderQueue.h:66
OgreIteratorWrappers.h
Ogre::RenderQueue::addRenderable
void addRenderable(Renderable *pRend)
Add a renderable object to the queue.
Ogre::RENDER_QUEUE_3
@ RENDER_QUEUE_3
Definition: OgreRenderQueue.h:62
Ogre::RenderQueue::RenderableListener::RenderableListener
RenderableListener()
Definition: OgreRenderQueue.h:109
Ogre::RenderQueue::mShadowCastersCannotBeReceivers
bool mShadowCastersCannotBeReceivers
Definition: OgreRenderQueue.h:143
Ogre::RenderQueue::RenderQueueGroupMap
map< uint8, RenderQueueGroup * >::type RenderQueueGroupMap
Definition: OgreRenderQueue.h:96
Ogre::RenderQueue::_getQueueGroupIterator
QueueGroupIterator _getQueueGroupIterator(void)
Internal method, returns an iterator for the queue groups.
Ogre::Renderable
Abstract class defining the interface all renderable objects must implement.
Definition: OgreRenderable.h:64
Ogre::RenderQueueGroupID
RenderQueueGroupID
Enumeration of queue groups, by which the application may group queued renderables so that they are r...
Definition: OgreRenderQueue.h:54
Ogre::ConstMapIterator
Concrete IteratorWrapper for const access to the underlying key-value container.
Definition: OgreIteratorWrapper.h:352
Ogre::RenderQueue::_getQueueGroupIterator
ConstQueueGroupIterator _getQueueGroupIterator(void) const
Ogre::RenderQueue::setSplitPassesByLightingType
void setSplitPassesByLightingType(bool split)
Sets whether or not the queue will split passes by their lighting type, ie ambient,...
Ogre::RENDER_QUEUE_1
@ RENDER_QUEUE_1
Definition: OgreRenderQueue.h:59
Ogre::RenderQueue::getRenderableListener
RenderableListener * getRenderableListener(void) const
Definition: OgreRenderQueue.h:286
Ogre::RenderQueue::QueueGroupIterator
MapIterator< RenderQueueGroupMap > QueueGroupIterator
Iterator over queue groups.
Definition: OgreRenderQueue.h:98
Ogre::RENDER_QUEUE_7
@ RENDER_QUEUE_7
Definition: OgreRenderQueue.h:67
Ogre::RenderQueue::mRenderableListener
RenderableListener * mRenderableListener
Definition: OgreRenderQueue.h:145
Ogre::RenderQueue
Class to manage the scene object rendering queue.
Definition: OgreRenderQueue.h:93
Ogre::RenderQueue::RenderableListener
Class to listen in on items being added to the render queue.
Definition: OgreRenderQueue.h:107
Ogre::RenderQueue::mSplitPassesByLightingType
bool mSplitPassesByLightingType
Definition: OgreRenderQueue.h:141

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.