OgreRenderQueueInvocation.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 __RenderQueueInvocation_H__
29 #define __RenderQueueInvocation_H__
30 
31 #include "OgrePrerequisites.h"
33 #include "OgreIteratorWrappers.h"
34 
35 namespace Ogre {
36 
67  {
68  protected:
79  public:
85  RenderQueueInvocation(uint8 renderQueueGroupID,
86  const String& invocationName = StringUtil::BLANK);
88 
90  virtual uint8 getRenderQueueGroupID(void) const { return mRenderQueueGroupID; }
91 
93  virtual const String& getInvocationName(void) const { return mInvocationName; }
94 
98  virtual void setSolidsOrganisation(
100  { mSolidsOrganisation = org; }
101 
106  getSolidsOrganisation(void) const { return mSolidsOrganisation; }
107 
113  virtual void setSuppressShadows(bool suppress)
114  { mSuppressShadows = suppress; }
115 
118  virtual bool getSuppressShadows(void) const { return mSuppressShadows; }
119 
140  virtual void setSuppressRenderStateChanges(bool suppress)
141  { mSuppressRenderStateChanges = suppress; }
142 
145  virtual bool getSuppressRenderStateChanges(void) const { return mSuppressRenderStateChanges; }
146 
152  virtual void invoke(RenderQueueGroup* group, SceneManager* targetSceneManager);
153 
156  };
157 
158 
162 
174  {
175  protected:
178  public:
181 
183  const String& getName(void) const { return mName; }
184 
191  RenderQueueInvocation* add(uint8 renderQueueGroupID,
192  const String& invocationName);
193 
201 
203  size_t size(void) const { return mInvocations.size(); }
204 
206  void clear(void);
207 
209  RenderQueueInvocation* get(size_t index);
210 
212  void remove(size_t index);
213 
216 
217 
218  };
222 }
223 
224 #endif
225 
#define _OgreExport
Definition: OgrePlatform.h:257
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
OrganisationMode
Organisation modes required for this collection.
A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same ti...
Class to hold a linear sequence of RenderQueueInvocation objects.
RenderQueueInvocationIterator iterator(void)
Get an iterator over the invocations.
RenderQueueInvocation * get(size_t index)
Gets the details of an invocation at a given index.
void remove(size_t index)
Removes (and deletes) an invocation by index.
void clear(void)
Clear and delete all invocations in this sequence.
size_t size(void) const
Get the number of invocations in this sequence.
RenderQueueInvocation * add(uint8 renderQueueGroupID, const String &invocationName)
Add a standard invocation to the sequence.
void add(RenderQueueInvocation *i)
Add a custom invocation to the sequence.
RenderQueueInvocationSequence(const String &name)
const String & getName(void) const
Get the name of this sequence.
Class representing the invocation of queue groups in a RenderQueue.
virtual uint8 getRenderQueueGroupID(void) const
Get the render queue group id.
virtual void invoke(RenderQueueGroup *group, SceneManager *targetSceneManager)
Invoke this class on a concrete queue group.
String mInvocationName
Invocation identifier - used in listeners.
static String RENDER_QUEUE_INVOCATION_SHADOWS
Invocation identifier for shadows.
virtual const String & getInvocationName(void) const
Get the invocation name (may be blank if not set by creator)
virtual bool getSuppressRenderStateChanges(void) const
Gets whether shadows are suppressed when invoking this queue.
RenderQueueInvocation(uint8 renderQueueGroupID, const String &invocationName=StringUtil::BLANK)
Constructor.
virtual bool getSuppressShadows(void) const
Gets whether shadows are suppressed when invoking this queue.
virtual void setSuppressRenderStateChanges(bool suppress)
Sets whether render state changes are suppressed when invoking this queue.
bool mSuppressShadows
Suppress shadows processing in this invocation?
virtual void setSolidsOrganisation(QueuedRenderableCollection::OrganisationMode org)
Set the organisation mode being used for solids in this queue group invocation.
virtual QueuedRenderableCollection::OrganisationMode getSolidsOrganisation(void) const
Get the organisation mode being used for solids in this queue group invocation.
QueuedRenderableCollection::OrganisationMode mSolidsOrganisation
Solids ordering mode.
uint8 mRenderQueueGroupID
Target queue group.
virtual void setSuppressShadows(bool suppress)
Sets whether shadows are suppressed when invoking this queue.
bool mSuppressRenderStateChanges
Suppress OGRE's render state management?
Manages the organisation and rendering of a 'scene' i.e.
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreString.h:196
Concrete IteratorWrapper for nonconst access to the underlying container.
vector< RenderQueueInvocation * >::type RenderQueueInvocationList
List of RenderQueueInvocations.
VectorIterator< RenderQueueInvocationList > RenderQueueInvocationIterator
unsigned char uint8
Definition: OgrePlatform.h:361
_StringBase String

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