OGRE  2.0
Object-Oriented Graphics Rendering Engine
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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-2014 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 "OgreHeaderPrefix.h"
33 #include "OgreIteratorWrappers.h"
34 
35 namespace Ogre {
36 
37  class Camera;
38  class MovableObject;
39 
53  {
76  };
77 
78  #define OGRE_RENDERABLE_DEFAULT_PRIORITY 100
79 
92  {
93  public:
94 
99 
106  {
107  public:
109  virtual ~RenderableListener() {}
110 
130  virtual bool renderableQueued(Renderable* rend, uint8 groupID,
131  ushort priority, Technique** ppTech, RenderQueue* pQueue) = 0;
132  };
133  protected:
139 
141 
143  public:
144  RenderQueue();
145  virtual ~RenderQueue();
146 
151  void clear(bool destroyPassMaps = false);
152 
158  RenderQueueGroup* getQueueGroup(uint8 qid);
159 
182  void addRenderable(Renderable* pRend, uint8 groupID, ushort priority);
183 
201  void addRenderable(Renderable* pRend, uint8 groupId);
202 
215  void addRenderable(Renderable* pRend);
216 
220  uint8 getDefaultQueueGroup(void) const;
221 
226  void setDefaultRenderablePriority(ushort priority);
227 
231  ushort getDefaultRenderablePriority(void) const;
232 
237  void setDefaultQueueGroup(uint8 grp);
238 
240  QueueGroupIterator _getQueueGroupIterator(void);
241  ConstQueueGroupIterator _getQueueGroupIterator(void) const;
242 
247  void setSplitNoShadowPasses(bool split);
248 
253  bool getSplitNoShadowPasses(void) const;
254 
261  { mRenderableListener = listener; }
262 
264  { return mRenderableListener; }
265 
268  void merge( const RenderQueue* rhs );
269  };
270 
274 }
275 
276 #include "OgreHeaderSuffix.h"
277 
278 #endif
unsigned char uint8
Definition: OgrePlatform.h:422
#define _OgreExport
Definition: OgrePlatform.h:255
A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same ti...
ConstMapIterator< RenderQueueGroupMap > ConstQueueGroupIterator
First queue (after backgrounds), used for skyboxes if rendered first.
Use this queue for objects which must be rendered first e.g. backgrounds.
Class representing an approach to rendering this particular Material.
Definition: OgreTechnique.h:50
Class to listen in on items being added to the render queue.
Abstract class defining the interface all renderable objects must implement.
Concrete IteratorWrapper for nonconst access to the underlying key-value container.
Use this queue for objects which must be rendered last e.g. overlays.
RenderableListener * getRenderableListener(void) const
uint8 mDefaultQueueGroup
The current default queue group.
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
RenderQueueGroupMap mGroups
ushort mDefaultRenderablePriority
The default priority.
unsigned short ushort
Penultimate queue(before overlays), used for skyboxes if rendered last.
RenderQueueGroupID
Enumeration of queue groups, by which the application may group queued renderables so that they are r...
Class to manage the scene object rendering queue.
Concrete IteratorWrapper for const access to the underlying key-value container.
map< uint8, RenderQueueGroup * >::type RenderQueueGroupMap
MapIterator< RenderQueueGroupMap > QueueGroupIterator
Iterator over queue groups.
Final possible render queue, don't exceed this.
The default render queue.
void setRenderableListener(RenderableListener *listener)
Set a renderable listener on the queue.
RenderableListener * mRenderableListener