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://ogre.sourceforge.net/
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_1 = 10,
00042         RENDER_QUEUE_2 = 20,
00043         RENDER_QUEUE_3 = 30,
00044         RENDER_QUEUE_4 = 40,
00046         RENDER_QUEUE_MAIN = 50,
00047         RENDER_QUEUE_6 = 60,
00048         RENDER_QUEUE_7 = 70,
00049         RENDER_QUEUE_8 = 80,
00051         RENDER_QUEUE_9 = 90,
00053         RENDER_QUEUE_OVERLAY = 100
00054     };
00055 
00056     #define RENDERABLE_DEFAULT_PRIORITY  100
00057 
00069     class _OgreExport RenderQueue
00070     {
00071     public:
00072         typedef std::map< RenderQueueGroupID, RenderQueueGroup* > RenderQueueGroupMap;
00074         typedef MapIterator<RenderQueueGroupMap> QueueGroupIterator;
00075     protected:
00076         RenderQueueGroupMap mGroups;
00077         // The current default queue group
00078         RenderQueueGroupID mDefaultQueueGroup;
00079     public:
00080         RenderQueue();
00081         virtual ~RenderQueue();
00082 
00085         void clear(void);
00086 
00109         void addRenderable(Renderable* pRend, RenderQueueGroupID groupID, ushort priority);
00110 
00128         void addRenderable(Renderable* pRend, ushort priority = RENDERABLE_DEFAULT_PRIORITY);
00129 
00133         RenderQueueGroupID getDefaultQueueGroup(void);
00134 
00138         void setDefaultQueueGroup(RenderQueueGroupID grp);
00139 
00141         QueueGroupIterator _getQueueGroupIterator(void);
00142     };
00143 
00144 
00145 }
00146 
00147 
00148 #endif

Copyright © 2002 by The OGRE Team