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 © 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 __RenderQueueInvocation_H__
#define __RenderQueueInvocation_H__

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

namespace Ogre {

    class _OgreExport RenderQueueInvocation
    {
    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 std::vector<RenderQueueInvocation*> RenderQueueInvocationList;
    typedef VectorIterator<RenderQueueInvocationList> RenderQueueInvocationIterator;

    class _OgreExport RenderQueueInvocationSequence
    {
    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

---

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