Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

OgreRenderQueue.h

Go to the documentation of this file.
00001 /*
00002 -----------------------------------------------------------------------------
00003 This source file is part of OGRE
00004     (Object-oriented Graphics Rendering Engine)
00005 For the latest info, see http://www.ogre3d.org/
00006 
00007 Copyright © 2000-2002 The OGRE Team
00008 Also see acknowledgements in Readme.html
00009 
00010 This program is free software; you can redistribute it and/or modify it under
00011 the terms of the GNU Lesser General Public License as published by the Free Software
00012 Foundation; either version 2 of the License, or (at your option) any later
00013 version.
00014 
00015 This program is distributed in the hope that it will be useful, but WITHOUT
00016 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
00017 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
00018 
00019 You should have received a copy of the GNU Lesser General Public License along with
00020 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
00021 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
00022 http://www.gnu.org/copyleft/lesser.txt.
00023 -----------------------------------------------------------------------------
00024 */
00025 #ifndef __RenderQueue_H__
00026 #define __RenderQueue_H__
00027 
00028 #include "OgrePrerequisites.h"
00029 #include "OgreIteratorWrappers.h"
00030 
00031 namespace Ogre {
00032 
00036     enum RenderQueueGroupID
00037     {
00039         RENDER_QUEUE_BACKGROUND = 0,
00041         RENDER_QUEUE_SKIES_EARLY = 5,
00042         RENDER_QUEUE_1 = 10,
00043         RENDER_QUEUE_2 = 20,
00044         RENDER_QUEUE_3 = 30,
00045         RENDER_QUEUE_4 = 40,
00047         RENDER_QUEUE_MAIN = 50,
00048         RENDER_QUEUE_6 = 60,
00049         RENDER_QUEUE_7 = 70,
00050         RENDER_QUEUE_8 = 80,
00051         RENDER_QUEUE_9 = 90,
00053         RENDER_QUEUE_SKIES_LATE = 95,
00055         RENDER_QUEUE_OVERLAY = 100
00056     };
00057 
00058     #define RENDERABLE_DEFAULT_PRIORITY  100
00059 
00071     class _OgreExport RenderQueue
00072     {
00073     public:
00074         typedef std::map< RenderQueueGroupID, RenderQueueGroup* > RenderQueueGroupMap;
00076         typedef MapIterator<RenderQueueGroupMap> QueueGroupIterator;
00077     protected:
00078         RenderQueueGroupMap mGroups;
00080         RenderQueueGroupID mDefaultQueueGroup;
00082         ushort mDefaultRenderablePriority;
00083 
00084         bool mSplitPassesByLightingType;
00085         bool mSplitNoShadowPasses;
00086     public:
00087         RenderQueue();
00088         virtual ~RenderQueue();
00089 
00092         void clear(void);
00093 
00099         RenderQueueGroup* getQueueGroup(RenderQueueGroupID qid);
00100 
00123         void addRenderable(Renderable* pRend, RenderQueueGroupID groupID, ushort priority);
00124 
00142         void addRenderable(Renderable* pRend, RenderQueueGroupID groupId);
00143 
00156         void addRenderable(Renderable* pRend);
00157         
00161         RenderQueueGroupID getDefaultQueueGroup(void) const;
00162 
00167         void setDefaultRenderablePriority(ushort priority);
00168 
00172         ushort getDefaultRenderablePriority(void) const;
00173 
00177         void setDefaultQueueGroup(RenderQueueGroupID grp);
00178         
00180         QueueGroupIterator _getQueueGroupIterator(void);
00184         void setSplitPassesByLightingType(bool split);
00189         void setSplitNoShadowPasses(bool split);
00190     };
00191 
00192 
00193 }
00194 
00195 
00196 #endif

Copyright © 2002-2003 by The OGRE Team
Last modified Sun Nov 28 19:48:42 2004