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  {
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:
147  RenderQueue();
148  virtual ~RenderQueue();
149 
154  void clear(bool destroyPassMaps = false);
155 
161  RenderQueueGroup* getQueueGroup(uint8 qid);
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 
223  uint8 getDefaultQueueGroup(void) const;
224 
229  void setDefaultRenderablePriority(ushort priority);
230 
234  ushort getDefaultRenderablePriority(void) const;
235 
240  void setDefaultQueueGroup(uint8 grp);
241 
243  QueueGroupIterator _getQueueGroupIterator(void);
244  ConstQueueGroupIterator _getQueueGroupIterator(void) const;
245 
249  void setSplitPassesByLightingType(bool split);
250 
254  bool getSplitPassesByLightingType(void) const;
255 
260  void setSplitNoShadowPasses(bool split);
261 
266  bool getSplitNoShadowPasses(void) const;
267 
271  void setShadowCastersCannotBeReceivers(bool ind);
272 
276  bool getShadowCastersCannotBeReceivers(void) const;
277 
284  { mRenderableListener = listener; }
285 
287  { return mRenderableListener; }
288 
291  void merge( const RenderQueue* rhs );
297  void processVisibleObject(MovableObject* mo,
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
Use this queue for objects which must be rendered last e.g. overlays.
Definition: OgreRenderQueue.h:74
Ogre::RenderQueueGroup
A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same ti...
Definition: OgreRenderQueueSortingGrouping.h:465
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::map
Definition: OgrePrerequisites.h:533
Ogre::ushort
unsigned short ushort
Definition: OgrePrerequisites.h:113
Ogre::Camera
A viewpoint from which the scene will be rendered.
Definition: OgreCamera.h:86
Ogre::RenderQueue::mDefaultRenderablePriority
ushort mDefaultRenderablePriority
The default priority.
Definition: OgreRenderQueue.h:139
Ogre::RenderQueue::mGroups
RenderQueueGroupMap mGroups
Definition: OgreRenderQueue.h:135
Ogre::RENDER_QUEUE_BACKGROUND
Use this queue for objects which must be rendered first e.g. backgrounds.
Definition: OgreRenderQueue.h:56
Ogre::RENDER_QUEUE_8
Definition: OgreRenderQueue.h:69
Ogre::MovableObject
Abstract class defining a movable object in a scene.
Definition: OgreMovableObject.h:60
Ogre::RENDER_QUEUE_SKIES_LATE
Penultimate queue(before overlays), used for skyboxes if rendered last.
Definition: OgreRenderQueue.h:72
Ogre::RENDER_QUEUE_MAIN
The default render queue.
Definition: OgreRenderQueue.h:65
Ogre::RENDER_QUEUE_4
Definition: OgreRenderQueue.h:63
Ogre::Technique
Class representing an approach to rendering this particular Material.
Definition: OgreTechnique.h:53
Ogre::VisibleObjectsBoundsInfo
Structure collecting together information about the visible objects that have been discovered in a sc...
Definition: OgreSceneManager.h:86
Ogre::RenderQueue::setRenderableListener
void setRenderableListener(RenderableListener *listener)
Set a renderable listener on the queue.
Definition: OgreRenderQueue.h:283
Ogre::RenderQueue::RenderableListener::~RenderableListener
virtual ~RenderableListener()
Definition: OgreRenderQueue.h:110
Ogre::RENDER_QUEUE_MAX
Final possible render queue, don't exceed this.
Definition: OgreRenderQueue.h:76
OgreHeaderPrefix.h
Ogre::RENDER_QUEUE_2
Definition: OgreRenderQueue.h:60
Ogre::RENDER_QUEUE_9
Definition: OgreRenderQueue.h:70
OgrePrerequisites.h
Ogre::RENDER_QUEUE_WORLD_GEOMETRY_2
Definition: OgreRenderQueue.h:68
Ogre::RENDER_QUEUE_SKIES_EARLY
First queue (after backgrounds), used for skyboxes if rendered first.
Definition: OgreRenderQueue.h:58
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::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::RENDER_QUEUE_6
Definition: OgreRenderQueue.h:66
OgreIteratorWrappers.h
Ogre::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::Renderable
Abstract class defining the interface all renderable objects must implement.
Definition: OgreRenderable.h:63
Ogre::RenderQueueGroupID
RenderQueueGroupID
Enumeration of queue groups, by which the application may group queued renderables so that they are r...
Definition: OgreRenderQueue.h:53
Ogre::ConstMapIterator
Concrete IteratorWrapper for const access to the underlying key-value container.
Definition: OgreIteratorWrapper.h:352
Ogre::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
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:92
Ogre::RenderQueue::RenderableListener
Class to listen in on items being added to the render queue.
Definition: OgreRenderQueue.h:106
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.