OgreTerrainPSSMMaterialGenerator.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.
-----------------------------------------------------------------------------
*/
 
#pragma once
 
#include <Terrain/OgreTerrainPrerequisites.h>
#include <Terrain/OgreTerrainMaterialGenerator.h>
#include <OgreGpuProgramParams.h>
 
namespace Ogre {
class PSSMShadowCameraSetup;
 
 
 
class TerrainPSSMMaterialGenerator : public TerrainMaterialGenerator
{
public:
    TerrainPSSMMaterialGenerator();
    ~TerrainPSSMMaterialGenerator();
 
    class SM2Profile : public TerrainMaterialGenerator::Profile
    {
    public:
        SM2Profile(TerrainMaterialGenerator* parent, const String& name, const String& desc);
        ~SM2Profile();
        MaterialPtr generate(const Terrain* terrain);
        MaterialPtr generateForCompositeMap(const Terrain* terrain);
        uint8 getMaxLayers(const Terrain* terrain) const;
        void updateParams(const MaterialPtr& mat, const Terrain* terrain);
        void updateParamsForCompositeMap(const MaterialPtr& mat, const Terrain* terrain);
        void requestOptions(Terrain* terrain);
        bool isVertexCompressionSupported() const;
 
        bool isLayerNormalMappingEnabled() const { return mLayerNormalMappingEnabled; }
        void setLayerNormalMappingEnabled(bool enabled);
 
        bool isLayerParallaxMappingEnabled() const { return mLayerParallaxMappingEnabled; }
        void setLayerParallaxMappingEnabled(bool enabled);
 
        bool isLayerSpecularMappingEnabled() const { return mLayerSpecularMappingEnabled; }
        void setLayerSpecularMappingEnabled(bool enabled);
 
        bool isGlobalColourMapEnabled() const { return mGlobalColourMapEnabled; }
        void setGlobalColourMapEnabled(bool enabled);
 
        bool isLightmapEnabled() const { return mLightmapEnabled; }
        void setLightmapEnabled(bool enabled);
 
        bool isCompositeMapEnabled() const { return mCompositeMapEnabled; }
        void setCompositeMapEnabled(bool enabled);
 
        bool getReceiveDynamicShadowsEnabled() const { return mReceiveDynamicShadows; }
        void setReceiveDynamicShadowsEnabled(bool enabled);
 
        void setReceiveDynamicShadowsPSSM(PSSMShadowCameraSetup* pssmSettings);
 
        PSSMShadowCameraSetup* getReceiveDynamicShadowsPSSM() const { return mPSSM; }
        void setReceiveDynamicShadowsDepth(bool enabled);
 
        bool getReceiveDynamicShadowsDepth() const { return mDepthShadows; }
        void setReceiveDynamicShadowsLowLod(bool enabled);
 
        bool getReceiveDynamicShadowsLowLod() const { return mLowLodShadows; }
 
        bool _isSM3Available() const { return mSM3Available; }
        bool _isSM4Available() const { return mSM4Available; }
 
    protected:
 
        enum TechniqueType
        {
            HIGH_LOD,
            LOW_LOD,
            RENDER_COMPOSITE_MAP
        };
 
        void addTechnique(const MaterialPtr& mat, const Terrain* terrain, TechniqueType tt);
 
        class ShaderHelper : public TerrainAlloc
        {
        public:
            ShaderHelper()
            {
            }
 
            virtual ~ShaderHelper()
            {
            }
 
            virtual HighLevelGpuProgramPtr generateVertexProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            virtual HighLevelGpuProgramPtr generateFragmentProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            virtual void updateParams(const SM2Profile* prof, const MaterialPtr& mat, const Terrain* terrain, bool compositeMap);
        protected:
            virtual String getVertexProgramName(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            virtual String getFragmentProgramName(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            virtual HighLevelGpuProgramPtr createVertexProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt) = 0;
            virtual HighLevelGpuProgramPtr createFragmentProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt) = 0;
            virtual void generateVertexProgramSource(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            virtual void generateFragmentProgramSource(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            virtual void generateVpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) = 0;
            virtual void generateFpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) = 0;
            virtual void generateVpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream) = 0;
            virtual void generateFpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream) = 0;
            virtual void generateVpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) = 0;
            virtual void generateFpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) = 0;
            virtual void defaultVpParams(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, const HighLevelGpuProgramPtr& prog);
            virtual void defaultFpParams(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, const HighLevelGpuProgramPtr& prog);
            virtual void updateVpParams(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, const GpuProgramParametersSharedPtr& params);
            virtual void updateFpParams(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, const GpuProgramParametersSharedPtr& params);
            static String getChannel(uint idx);
 
            size_t mShadowSamplerStartHi;
            size_t mShadowSamplerStartLo;
        };
 
        class ShaderHelperCg : public ShaderHelper
        {
        protected:
            HighLevelGpuProgramPtr createVertexProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            HighLevelGpuProgramPtr createFragmentProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            void generateVpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            void generateFpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            void generateVpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream);
            void generateFpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream);
            void generateVpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            void generateFpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            uint generateVpDynamicShadowsParams(uint texCoordStart, const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            void generateVpDynamicShadows(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            void generateFpDynamicShadowsHelpers(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            void generateFpDynamicShadowsParams(uint* texCoord, uint* sampler, const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
            void generateFpDynamicShadows(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream);
        };
 
        class ShaderHelperHLSL : public ShaderHelperCg
        {
        protected:
            HighLevelGpuProgramPtr createVertexProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            HighLevelGpuProgramPtr createFragmentProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
        };
 
        class ShaderHelperGLSL : public ShaderHelper
        {
        protected:
            HighLevelGpuProgramPtr createVertexProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            HighLevelGpuProgramPtr createFragmentProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
 
            void generateVpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
 
            void generateFpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
 
            void generateVpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream) {}
 
            void generateFpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream) {}
 
            void generateVpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
 
            void generateFpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
        };
 
        class ShaderHelperGLSLES : public ShaderHelper
        {
        protected:
            HighLevelGpuProgramPtr createVertexProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
            HighLevelGpuProgramPtr createFragmentProgram(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt);
 
            void generateVpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
 
            void generateFpHeader(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
 
            void generateVpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream) {}
 
            void generateFpLayer(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, uint layer, Ogre::StringStream& outStream) {}
 
            void generateVpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
 
            void generateFpFooter(const SM2Profile* prof, const Terrain* terrain, TechniqueType tt, Ogre::StringStream& outStream) {}
        };
 
        ShaderHelper* mShaderGen;
        bool mLayerNormalMappingEnabled;
        bool mLayerParallaxMappingEnabled;
        bool mLayerSpecularMappingEnabled;
        bool mGlobalColourMapEnabled;
        bool mLightmapEnabled;
        bool mCompositeMapEnabled;
        bool mReceiveDynamicShadows;
        PSSMShadowCameraSetup* mPSSM;
        bool mDepthShadows;
        bool mLowLodShadows;
        bool mSM3Available;
        bool mSM4Available;
 
        bool isShadowingEnabled(TechniqueType tt, const Terrain* terrain) const;
    };
};
 
}