OgreCompositionTargetPass.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 __CompositionTargetPass_H__
#define __CompositionTargetPass_H__

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

namespace Ogre {
    class _OgreExport CompositionTargetPass : public CompositorInstAlloc
    {
    public:
        CompositionTargetPass(CompositionTechnique *parent);
        ~CompositionTargetPass();
        
        enum InputMode
        {
            IM_NONE,        // No input
            IM_PREVIOUS     // Output of previous Composition in chain
        };
        typedef vector<CompositionPass *>::type Passes;
        typedef VectorIterator<Passes> PassIterator;
        
        void setInputMode(InputMode mode);
        InputMode getInputMode() const;
        
        void setOutputName(const String &out);
        const String &getOutputName() const;
        
        void setOnlyInitial(bool value);
        bool getOnlyInitial();
        
        void setVisibilityMask(uint32 mask);
        uint32 getVisibilityMask();

        void setMaterialScheme(const String& schemeName);
        const String& getMaterialScheme(void) const;
        
        void setShadowsEnabled(bool enabled);
        bool getShadowsEnabled(void) const;
        void setLodBias(float bias);
        float getLodBias();
        
        CompositionPass *createPass();
        void removePass(size_t idx);
        CompositionPass *getPass(size_t idx);
        size_t getNumPasses();
        
        void removeAllPasses();
    
        PassIterator getPassIterator(void);
        
        CompositionTechnique *getParent();

        bool _isSupported(void);

    private:
        CompositionTechnique *mParent;
        InputMode mInputMode;
        String mOutputName;
        Passes mPasses;
        bool mOnlyInitial;
        uint32 mVisibilityMask;
        float mLodBias;
        String mMaterialScheme;
        bool mShadowsEnabled;
    };

}

#endif