Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class 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 (c) 2000-2005 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_WORLD_GEOMETRY_1 = 25,
00045         RENDER_QUEUE_3 = 30,
00046         RENDER_QUEUE_4 = 40,
00048         RENDER_QUEUE_MAIN = 50,
00049         RENDER_QUEUE_6 = 60,
00050         RENDER_QUEUE_7 = 70,
00051         RENDER_QUEUE_WORLD_GEOMETRY_2 = 75,
00052         RENDER_QUEUE_8 = 80,
00053         RENDER_QUEUE_9 = 90,
00055         RENDER_QUEUE_SKIES_LATE = 95,
00057         RENDER_QUEUE_OVERLAY = 100
00058     };
00059 
00060     #define OGRE_RENDERABLE_DEFAULT_PRIORITY  100
00061 
00073     class _OgreExport RenderQueue
00074     {
00075     public:
00076         typedef std::map< RenderQueueGroupID, RenderQueueGroup* > RenderQueueGroupMap;
00078         typedef MapIterator<RenderQueueGroupMap> QueueGroupIterator;
00079     protected:
00080         RenderQueueGroupMap mGroups;
00082         RenderQueueGroupID mDefaultQueueGroup;
00084         ushort mDefaultRenderablePriority;
00085 
00086         bool mSplitPassesByLightingType;
00087         bool mSplitNoShadowPasses;
00088     public:
00089         RenderQueue();
00090         virtual ~RenderQueue();
00091 
00094         void clear(void);
00095 
00101         RenderQueueGroup* getQueueGroup(RenderQueueGroupID qid);
00102 
00125         void addRenderable(Renderable* pRend, RenderQueueGroupID groupID, ushort priority);
00126 
00144         void addRenderable(Renderable* pRend, RenderQueueGroupID groupId);
00145 
00158         void addRenderable(Renderable* pRend);
00159         
00163         RenderQueueGroupID getDefaultQueueGroup(void) const;
00164 
00169         void setDefaultRenderablePriority(ushort priority);
00170 
00174         ushort getDefaultRenderablePriority(void) const;
00175 
00179         void setDefaultQueueGroup(RenderQueueGroupID grp);
00180         
00182         QueueGroupIterator _getQueueGroupIterator(void);
00186         void setSplitPassesByLightingType(bool split);
00191         void setSplitNoShadowPasses(bool split);
00192     };
00193 
00194 
00195 }
00196 
00197 
00198 #endif

Copyright © 2000-2005 by The OGRE Team
Last modified Sun Apr 10 23:21:21 2005