OgreCompositor.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-2013 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 __Compositor_H__
#define __Compositor_H__

#include "OgrePrerequisites.h"
#include "OgreIteratorWrappers.h"
#include "OgreResource.h"
#include "OgreTexture.h"

namespace Ogre {
    class _OgreExport Compositor: public Resource
    {
    public:
        Compositor(ResourceManager* creator, const String& name, ResourceHandle handle,
            const String& group, bool isManual = false, ManualResourceLoader* loader = 0);
        ~Compositor();
        
        typedef vector<CompositionTechnique *>::type Techniques;
        typedef VectorIterator<Techniques> TechniqueIterator;
        
        CompositionTechnique *createTechnique();
        
        void removeTechnique(size_t idx);
        
        CompositionTechnique *getTechnique(size_t idx);
        
        size_t getNumTechniques();
        
        void removeAllTechniques();
        
        TechniqueIterator getTechniqueIterator(void);
        
        CompositionTechnique *getSupportedTechnique(size_t idx);
        
        size_t getNumSupportedTechniques();
        
        TechniqueIterator getSupportedTechniqueIterator(void);

        CompositionTechnique *getSupportedTechnique(const String& schemeName = StringUtil::BLANK);

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

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

        RenderTarget* getRenderTarget(const String& name);

    protected:
        void loadImpl(void);

        void unloadImpl(void);
        size_t calculateSize(void) const;
        
        void compile();
    private:
        Techniques mTechniques;
        Techniques mSupportedTechniques;
        
        bool mCompilationRequired;

        void createGlobalTextures();
        
        void freeGlobalTextures();

        //TODO GSOC : These typedefs are duplicated from CompositorInstance. Solve?
        typedef map<String,TexturePtr>::type GlobalTextureMap;
        GlobalTextureMap mGlobalTextures;
        typedef map<String,MultiRenderTarget*>::type GlobalMRTMap;
        GlobalMRTMap mGlobalMRTs;
    };

    class _OgreExport CompositorPtr : public SharedPtr<Compositor> 
    {
    public:
        CompositorPtr() : SharedPtr<Compositor>() {}
        explicit CompositorPtr(Compositor* rep) : SharedPtr<Compositor>(rep) {}
        CompositorPtr(const CompositorPtr& r) : SharedPtr<Compositor>(r) {} 
        CompositorPtr(const ResourcePtr& r) : SharedPtr<Compositor>()
        {
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<Compositor*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
        }

        CompositorPtr& operator=(const ResourcePtr& r)
        {
            if (pRep == static_cast<Compositor*>(r.getPointer()))
                return *this;
            release();
            // lock & copy other mutex pointer
            OGRE_MUTEX_CONDITIONAL(r.OGRE_AUTO_MUTEX_NAME)
            {
                OGRE_LOCK_MUTEX(*r.OGRE_AUTO_MUTEX_NAME)
                OGRE_COPY_AUTO_SHARED_MUTEX(r.OGRE_AUTO_MUTEX_NAME)
                pRep = static_cast<Compositor*>(r.getPointer());
                pUseCount = r.useCountPointer();
                if (pUseCount)
                {
                    ++(*pUseCount);
                }
            }
            else
            {
                // RHS must be a null pointer
                assert(r.isNull() && "RHS must be null if it has no mutex!");
                setNull();
            }
            return *this;
        }
    };
}

#endif