OgreRenderQueueInvocation.h
Go to the documentation of this file.
/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/
Copyright (c) 2000-2013 Torus Knot Software Ltd
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __RenderQueueInvocation_H__
#define __RenderQueueInvocation_H__
#include "OgrePrerequisites.h"
#include "OgreRenderQueueSortingGrouping.h"
#include "OgreIteratorWrappers.h"
namespace Ogre {
class _OgreExport RenderQueueInvocation : public RenderQueueAlloc
{
protected:
uint8 mRenderQueueGroupID;
String mInvocationName;
QueuedRenderableCollection::OrganisationMode mSolidsOrganisation;
bool mSuppressShadows;
bool mSuppressRenderStateChanges;
public:
RenderQueueInvocation(uint8 renderQueueGroupID,
const String& invocationName = StringUtil::BLANK);
virtual ~RenderQueueInvocation();
virtual uint8 getRenderQueueGroupID(void) const { return mRenderQueueGroupID; }
virtual const String& getInvocationName(void) const { return mInvocationName; }
virtual void setSolidsOrganisation(
QueuedRenderableCollection::OrganisationMode org)
{ mSolidsOrganisation = org; }
virtual QueuedRenderableCollection::OrganisationMode
getSolidsOrganisation(void) const { return mSolidsOrganisation; }
virtual void setSuppressShadows(bool suppress)
{ mSuppressShadows = suppress; }
virtual bool getSuppressShadows(void) const { return mSuppressShadows; }
virtual void setSuppressRenderStateChanges(bool suppress)
{ mSuppressRenderStateChanges = suppress; }
virtual bool getSuppressRenderStateChanges(void) const { return mSuppressRenderStateChanges; }
virtual void invoke(RenderQueueGroup* group, SceneManager* targetSceneManager);
static String RENDER_QUEUE_INVOCATION_SHADOWS;
};
typedef vector<RenderQueueInvocation*>::type RenderQueueInvocationList;
typedef VectorIterator<RenderQueueInvocationList> RenderQueueInvocationIterator;
class _OgreExport RenderQueueInvocationSequence : public RenderQueueAlloc
{
protected:
String mName;
RenderQueueInvocationList mInvocations;
public:
RenderQueueInvocationSequence(const String& name);
virtual ~RenderQueueInvocationSequence();
const String& getName(void) const { return mName; }
RenderQueueInvocation* add(uint8 renderQueueGroupID,
const String& invocationName);
void add(RenderQueueInvocation* i);
size_t size(void) const { return mInvocations.size(); }
void clear(void);
RenderQueueInvocation* get(size_t index);
void remove(size_t index);
RenderQueueInvocationIterator iterator(void);
};
}
#endif
Ogre::RenderQueueInvocation::getRenderQueueGroupID
virtual uint8 getRenderQueueGroupID(void) const
Get the render queue group id.
Definition: OgreRenderQueueInvocation.h:90
Ogre::RenderQueueInvocationSequence::size
size_t size(void) const
Get the number of invocations in this sequence.
Definition: OgreRenderQueueInvocation.h:203
Ogre::VectorIterator
Concrete IteratorWrapper for nonconst access to the underlying container.
Definition: OgreIteratorWrapper.h:186
Ogre::RenderQueueInvocationSequence::mName
String mName
Definition: OgreRenderQueueInvocation.h:176
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::RenderQueueInvocation
Class representing the invocation of queue groups in a RenderQueue.
Definition: OgreRenderQueueInvocation.h:66
Ogre::RenderQueueInvocation::setSolidsOrganisation
virtual void setSolidsOrganisation(QueuedRenderableCollection::OrganisationMode org)
Set the organisation mode being used for solids in this queue group invocation.
Definition: OgreRenderQueueInvocation.h:98
Ogre::RenderQueueInvocation::setSuppressRenderStateChanges
virtual void setSuppressRenderStateChanges(bool suppress)
Sets whether render state changes are suppressed when invoking this queue.
Definition: OgreRenderQueueInvocation.h:140
Ogre::RenderQueueInvocation::getInvocationName
virtual const String & getInvocationName(void) const
Get the invocation name (may be blank if not set by creator)
Definition: OgreRenderQueueInvocation.h:93
OgreRenderQueueSortingGrouping.h
Ogre::RenderQueueInvocation::getSuppressShadows
virtual bool getSuppressShadows(void) const
Gets whether shadows are suppressed when invoking this queue.
Definition: OgreRenderQueueInvocation.h:118
Ogre::RenderQueueInvocationSequence
Class to hold a linear sequence of RenderQueueInvocation objects.
Definition: OgreRenderQueueInvocation.h:173
OgrePrerequisites.h
Ogre::RenderQueueGroup
A grouping level underneath RenderQueue which groups renderables to be issued at coarsely the same ti...
Definition: OgreRenderQueueSortingGrouping.h:465
Ogre::uint8
unsigned char uint8
Definition: OgrePlatform.h:361
Ogre::String
_StringBase String
Definition: OgrePrerequisites.h:439
Ogre::RenderQueueInvocation::getSuppressRenderStateChanges
virtual bool getSuppressRenderStateChanges(void) const
Gets whether shadows are suppressed when invoking this queue.
Definition: OgreRenderQueueInvocation.h:145
Ogre::RenderQueueInvocation::mSuppressRenderStateChanges
bool mSuppressRenderStateChanges
Suppress OGRE&#39;s render state management?
Definition: OgreRenderQueueInvocation.h:78
Ogre::RenderQueueInvocation::setSuppressShadows
virtual void setSuppressShadows(bool suppress)
Sets whether shadows are suppressed when invoking this queue.
Definition: OgreRenderQueueInvocation.h:113
Ogre::RenderQueueInvocationSequence::getName
const String & getName(void) const
Get the name of this sequence.
Definition: OgreRenderQueueInvocation.h:183
Ogre::RenderQueueInvocationIterator
VectorIterator< RenderQueueInvocationList > RenderQueueInvocationIterator
Definition: OgreRenderQueueInvocation.h:161
Ogre::RenderQueueInvocation::mInvocationName
String mInvocationName
Invocation identifier - used in listeners.
Definition: OgreRenderQueueInvocation.h:72
OgreIteratorWrappers.h
Ogre::RenderQueueInvocation::getSolidsOrganisation
virtual QueuedRenderableCollection::OrganisationMode getSolidsOrganisation(void) const
Get the organisation mode being used for solids in this queue group invocation.
Definition: OgreRenderQueueInvocation.h:106
Ogre
Definition: OgreAndroidLogListener.h:34
Ogre::vector
Definition: OgrePrerequisites.h:491
Ogre::RenderQueueInvocation::mRenderQueueGroupID
uint8 mRenderQueueGroupID
Target queue group.
Definition: OgreRenderQueueInvocation.h:70
Ogre::RenderQueueInvocationSequence::mInvocations
RenderQueueInvocationList mInvocations
Definition: OgreRenderQueueInvocation.h:177
Ogre::RenderQueueInvocation::mSolidsOrganisation
QueuedRenderableCollection::OrganisationMode mSolidsOrganisation
Solids ordering mode.
Definition: OgreRenderQueueInvocation.h:74
Ogre::RenderQueueInvocationList
vector< RenderQueueInvocation * >::type RenderQueueInvocationList
List of RenderQueueInvocations.
Definition: OgreRenderQueueInvocation.h:160
Ogre::SceneManager
Manages the organisation and rendering of a &#39;scene&#39; i.e.
Definition: OgreSceneManager.h:143
Ogre::StringUtil::BLANK
static const String BLANK
Constant blank string, useful for returning by ref where local does not exist.
Definition: OgreString.h:196
Ogre::QueuedRenderableCollection::OrganisationMode
OrganisationMode
Organisation modes required for this collection.
Definition: OgreRenderQueueSortingGrouping.h:124
Ogre::RenderQueueInvocation::RENDER_QUEUE_INVOCATION_SHADOWS
static String RENDER_QUEUE_INVOCATION_SHADOWS
Invocation identifier for shadows.
Definition: OgreRenderQueueInvocation.h:155
Ogre::AllocatedObject
Superclass for all objects that wish to use custom memory allocators when their new / delete operator...
Definition: OgreMemoryAllocatedObject.h:58
Ogre::RenderQueueInvocation::mSuppressShadows
bool mSuppressShadows
Suppress shadows processing in this invocation?
Definition: OgreRenderQueueInvocation.h:76

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