OgreCompositorInstance.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-2014 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 __CompositorInstance_H__
#define __CompositorInstance_H__

#include "OgrePrerequisites.h"
#include "OgreMaterialManager.h"
#include "OgreTexture.h"
#include "OgreRenderQueue.h"
#include "OgreCompositionTechnique.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {
    const size_t RENDER_QUEUE_COUNT = RENDER_QUEUE_MAX+1;       
            
    class _OgreExport CompositorInstance : public CompositorInstAlloc
    {
    public:
        CompositorInstance(CompositionTechnique *technique, CompositorChain *chain);
        virtual ~CompositorInstance();
        class _OgreExport Listener
        {
        public:
            virtual ~Listener();

            virtual void notifyMaterialSetup(uint32 pass_id, MaterialPtr &mat);

            virtual void notifyMaterialRender(uint32 pass_id, MaterialPtr &mat);

            virtual void notifyResourcesCreated(bool forResizeOnly);

        };
        class _OgreExport RenderSystemOperation : public CompositorInstAlloc
        {
        public:
            virtual ~RenderSystemOperation();
            virtual void execute(SceneManager *sm, RenderSystem *rs) = 0;
        };
        typedef map<int, MaterialPtr>::type QuadMaterialMap;
        typedef std::pair<int, RenderSystemOperation*> RenderSystemOpPair;
        typedef vector<RenderSystemOpPair>::type RenderSystemOpPairs;
        class TargetOperation
        {
        public:
            TargetOperation()
            { 
            }
            TargetOperation(RenderTarget *inTarget):
                target(inTarget), currentQueueGroupID(0), visibilityMask(0xFFFFFFFF),
                lodBias(1.0f),
                onlyInitial(false), hasBeenRendered(false), findVisibleObjects(false), 
                materialScheme(MaterialManager::DEFAULT_SCHEME_NAME), shadowsEnabled(true)
            { 
            }
            RenderTarget *target;

            int currentQueueGroupID;

            RenderSystemOpPairs renderSystemOperations;

            uint32 visibilityMask;
            
            float lodBias;
            
            typedef std::bitset<RENDER_QUEUE_COUNT> RenderQueueBitSet;

            RenderQueueBitSet renderQueues;
            
            bool onlyInitial;
            bool hasBeenRendered;
            bool findVisibleObjects;
            String materialScheme;
            bool shadowsEnabled;
        };
        typedef vector<TargetOperation>::type CompiledState;
        
        void setEnabled(bool value);
        
        bool getEnabled() const { return mEnabled; }

        void setAlive(bool value);

        bool getAlive() const { return mAlive; }

        const String& getTextureInstanceName(const String& name, size_t mrtIndex);

        TexturePtr getTextureInstance(const String& name, size_t mrtIndex);

        RenderTarget* getRenderTarget(const String& name);

       
        virtual void _compileTargetOperations(CompiledState &compiledState);
        
        virtual void _compileOutputOperation(TargetOperation &finalState);
        
        Compositor *getCompositor();
        
        CompositionTechnique *getTechnique();

        void setTechnique(CompositionTechnique* tech, bool reuseTextures = true);

        void setScheme(const String& schemeName, bool reuseTextures = true);

        const String& getScheme() const { return mTechnique ? mTechnique->getSchemeName() : StringUtil::BLANK; }

        void notifyResized();

        CompositorChain *getChain();

        void addListener(Listener *l);

        void removeListener(Listener *l);

        void _fireNotifyMaterialSetup(uint32 pass_id, MaterialPtr &mat);

        void _fireNotifyMaterialRender(uint32 pass_id, MaterialPtr &mat);

        void _fireNotifyResourcesCreated(bool forResizeOnly);
    private:
        Compositor *mCompositor;
        CompositionTechnique *mTechnique;
        CompositorChain *mChain;
        bool mEnabled;
        bool mAlive;
        typedef map<String,TexturePtr>::type LocalTextureMap;
        LocalTextureMap mLocalTextures;
        typedef map<String,MultiRenderTarget*>::type LocalMRTMap;
        LocalMRTMap mLocalMRTs;
        typedef map<CompositionTechnique::TextureDefinition*, TexturePtr>::type ReserveTextureMap;
        ReserveTextureMap mReserveTextures;

        typedef vector<Listener*>::type Listeners;
        Listeners mListeners;
        
        CompositorInstance *mPreviousInstance;
        
        virtual void collectPasses(TargetOperation &finalState, CompositionTargetPass *target);
        
        MaterialPtr createLocalMaterial(const String& srcName);
        
        void createResources(bool forResizeOnly);
        
        void freeResources(bool forResizeOnly, bool clearReserveTextures);

        RenderTarget *getTargetForTex(const String &name);
        
        const String &getSourceForTex(const String &name, size_t mrtIndex = 0);

        void queueRenderSystemOp(TargetOperation &finalState, RenderSystemOperation *op);

        String getMRTTexLocalName(const String& baseName, size_t attachment);

        void deriveTextureRenderTargetOptions(const String& texname, 
            bool *hwGammaWrite, uint *fsaa, String* fsaaHint);

        void notifyCameraChanged(Camera* camera);

        friend class CompositorChain;
    };
} // namespace Ogre

#include "OgreHeaderSuffix.h"

#endif // __CompositorInstance_H__