OgreRenderQueue.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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef __RenderQueue_H__
#define __RenderQueue_H__

#include "OgrePrerequisites.h"
#include "OgreIteratorWrappers.h"

namespace Ogre {

    enum RenderQueueGroupID
    {
        RENDER_QUEUE_BACKGROUND = 0,
        RENDER_QUEUE_SKIES_EARLY = 5,
        RENDER_QUEUE_1 = 10,
        RENDER_QUEUE_2 = 20,
        RENDER_QUEUE_WORLD_GEOMETRY_1 = 25,
        RENDER_QUEUE_3 = 30,
        RENDER_QUEUE_4 = 40,
        RENDER_QUEUE_MAIN = 50,
        RENDER_QUEUE_6 = 60,
        RENDER_QUEUE_7 = 70,
        RENDER_QUEUE_WORLD_GEOMETRY_2 = 75,
        RENDER_QUEUE_8 = 80,
        RENDER_QUEUE_9 = 90,
        RENDER_QUEUE_SKIES_LATE = 95,
        RENDER_QUEUE_OVERLAY = 100
    };

    #define OGRE_RENDERABLE_DEFAULT_PRIORITY  100

    class _OgreExport RenderQueue
    {
    public:
        typedef std::map< uint8, RenderQueueGroup* > RenderQueueGroupMap;
        typedef MapIterator<RenderQueueGroupMap> QueueGroupIterator;
        class _OgreExport RenderableListener
        {
        public:
            RenderableListener() {}
            virtual ~RenderableListener() {}

            virtual bool renderableQueued(Renderable* rend, uint8 groupID, 
                ushort priority, Technique** ppTech) = 0;
        };
    protected:
        RenderQueueGroupMap mGroups;
        uint8 mDefaultQueueGroup;
        ushort mDefaultRenderablePriority;

        bool mSplitPassesByLightingType;
        bool mSplitNoShadowPasses;
        bool mShadowCastersCannotBeReceivers;

        RenderableListener* mRenderableListener;
    public:
        RenderQueue();
        virtual ~RenderQueue();

        void clear(bool destroyPassMaps = false);

        RenderQueueGroup* getQueueGroup(uint8 qid);

        void addRenderable(Renderable* pRend, uint8 groupID, ushort priority);

        void addRenderable(Renderable* pRend, uint8 groupId);

        void addRenderable(Renderable* pRend);
        
        uint8 getDefaultQueueGroup(void) const;

        void setDefaultRenderablePriority(ushort priority);

        ushort getDefaultRenderablePriority(void) const;

        void setDefaultQueueGroup(uint8 grp);
        
        QueueGroupIterator _getQueueGroupIterator(void);
        void setSplitPassesByLightingType(bool split);
        void setSplitNoShadowPasses(bool split);
        void setShadowCastersCannotBeReceivers(bool ind);

        void setRenderableListener(RenderableListener* listener)
        { mRenderableListener = listener; }

        RenderableListener* getRenderableListener(void) const
        { return mRenderableListener; }

    };


}


#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:47 2006