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 (c) 2000-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/
#ifndef __RenderQueueInvocation_H__
#define __RenderQueueInvocation_H__

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

namespace Ogre {

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

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