OgreTechnique.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 __Technique_H__
#define __Technique_H__

#include "OgrePrerequisites.h"
#include "OgreIteratorWrappers.h"
#include "OgreBlendMode.h"
#include "OgreCommon.h"
#include "OgrePass.h"
#include "OgreIteratorWrappers.h"
#include "OgreRenderSystemCapabilities.h"
#include "OgreUserObjectBindings.h"

namespace Ogre {
    class _OgreExport Technique : public TechniqueAlloc
    {
    protected:
        // illumination pass state type
        enum IlluminationPassesState
        {
            IPS_COMPILE_DISABLED = -1,
            IPS_NOT_COMPILED = 0,
            IPS_COMPILED = 1
        };

        typedef vector<Pass*>::type Passes;
        Passes mPasses;
        IlluminationPassList mIlluminationPasses;
        Material* mParent; // raw pointer since we don't want child to stop parent's destruction
        bool mIsSupported;
        IlluminationPassesState mIlluminationPassesCompilationPhase;
        unsigned short mLodIndex;
        unsigned short mSchemeIndex;
        String mName; // optional name for the technique

        void clearIlluminationPasses(void);
        bool checkManuallyOrganisedIlluminationPasses();


        MaterialPtr mShadowCasterMaterial;
        String mShadowCasterMaterialName;
        MaterialPtr mShadowReceiverMaterial;
        String mShadowReceiverMaterialName; 

        // User objects binding.
        UserObjectBindings  mUserObjectBindings;

    public:
        enum IncludeOrExclude
        {
            INCLUDE = 0,
            EXCLUDE = 1
        };
        struct GPUVendorRule
        {
            GPUVendor vendor;
            IncludeOrExclude includeOrExclude;
            GPUVendorRule()
                : vendor(GPU_UNKNOWN), includeOrExclude(EXCLUDE) {}
            GPUVendorRule(GPUVendor v, IncludeOrExclude ie)
                : vendor(v), includeOrExclude(ie) {}
        };
        struct GPUDeviceNameRule
        {
            String devicePattern;
            IncludeOrExclude includeOrExclude;
            bool caseSensitive;
            GPUDeviceNameRule()
                : includeOrExclude(EXCLUDE), caseSensitive(false) {}
            GPUDeviceNameRule(const String& pattern, IncludeOrExclude ie, bool caseSen)
                : devicePattern(pattern), includeOrExclude(ie), caseSensitive(caseSen) {}
        };
        typedef vector<GPUVendorRule>::type GPUVendorRuleList;
        typedef vector<GPUDeviceNameRule>::type GPUDeviceNameRuleList;
    protected:
        GPUVendorRuleList mGPUVendorRules;
        GPUDeviceNameRuleList mGPUDeviceNameRules;
    public:
        Technique(Material* parent);
        Technique(Material* parent, const Technique& oth);
        ~Technique();
        bool isSupported(void) const;
        String _compile(bool autoManageTextureUnits);
        bool checkGPURules(StringUtil::StrStreamType& errors);
        bool checkHardwareSupport(bool autoManageTextureUnits, StringUtil::StrStreamType& compileErrors);
        void _compileIlluminationPasses(void);


        Pass* createPass(void);
        Pass* getPass(unsigned short index);
        Pass* getPass(const String& name);
        unsigned short getNumPasses(void) const;
        void removePass(unsigned short index);
        void removeAllPasses(void);
        bool movePass(const unsigned short sourceIndex, const unsigned short destinationIndex);
        typedef VectorIterator<Passes> PassIterator;
        const PassIterator getPassIterator(void);
        typedef VectorIterator<IlluminationPassList> IlluminationPassIterator;
        const IlluminationPassIterator getIlluminationPassIterator(void);
        Material* getParent(void) const { return mParent; }

        Technique& operator=(const Technique& rhs);

        const String& getResourceGroup(void) const;

        bool isTransparent(void) const;

        bool isTransparentSortingEnabled(void) const;

        bool isTransparentSortingForced(void) const;

        void _prepare(void);
        void _unprepare(void);
        void _load(void);
        void _unload(void);

        // Is this loaded?
        bool isLoaded(void) const;

        void _notifyNeedsRecompile(void);

        Ogre::MaterialPtr getShadowCasterMaterial() const;
        void setShadowCasterMaterial(Ogre::MaterialPtr val);
        void setShadowCasterMaterial(const Ogre::String &name);
        Ogre::MaterialPtr getShadowReceiverMaterial() const;
        void setShadowReceiverMaterial(Ogre::MaterialPtr val);
        void setShadowReceiverMaterial(const Ogre::String &name);

        // -------------------------------------------------------------------------------
        // The following methods are to make migration from previous versions simpler
        // and to make code easier to write when dealing with simple materials
        // They set the properties which have been moved to Pass for all Techniques and all Passes

        void setPointSize(Real ps);

        void setAmbient(Real red, Real green, Real blue);

        void setAmbient(const ColourValue& ambient);

        void setDiffuse(Real red, Real green, Real blue, Real alpha);

        void setDiffuse(const ColourValue& diffuse);

        void setSpecular(Real red, Real green, Real blue, Real alpha);

        void setSpecular(const ColourValue& specular);

        void setShininess(Real val);

        void setSelfIllumination(Real red, Real green, Real blue);

        void setSelfIllumination(const ColourValue& selfIllum);

        void setDepthCheckEnabled(bool enabled);

        void setDepthWriteEnabled(bool enabled);

        void setDepthFunction( CompareFunction func );

        void setColourWriteEnabled(bool enabled);

        void setCullingMode( CullingMode mode );

        void setManualCullingMode( ManualCullingMode mode );

        void setLightingEnabled(bool enabled);

        void setShadingMode( ShadeOptions mode );

        void setFog(
            bool overrideScene,
            FogMode mode = FOG_NONE,
            const ColourValue& colour = ColourValue::White,
            Real expDensity = 0.001, Real linearStart = 0.0, Real linearEnd = 1.0 );

        void setDepthBias(float constantBias, float slopeScaleBias);

        void setTextureFiltering(TextureFilterOptions filterType);
        void setTextureAnisotropy(unsigned int maxAniso);

        void setSceneBlending( const SceneBlendType sbt );

        void setSeparateSceneBlending( const SceneBlendType sbt, const SceneBlendType sbta );

        void setSceneBlending( const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor);

        void setSeparateSceneBlending( const SceneBlendFactor sourceFactor, const SceneBlendFactor destFactor, const SceneBlendFactor sourceFactorAlpha, const SceneBlendFactor destFactorAlpha);

        void setLodIndex(unsigned short index);
        unsigned short getLodIndex(void) const { return mLodIndex; }

        void setSchemeName(const String& schemeName);
        const String& getSchemeName(void) const;
        
        unsigned short _getSchemeIndex(void) const;
            
        bool isDepthWriteEnabled(void) const;

        bool isDepthCheckEnabled(void) const;

        bool hasColourWriteDisabled(void) const;

        void setName(const String& name);
        const String& getName(void) const { return mName; }

        bool applyTextureAliases(const AliasTextureNamePairList& aliasList, const bool apply = true) const;


        void addGPUVendorRule(GPUVendor vendor, IncludeOrExclude includeOrExclude);
        void addGPUVendorRule(const GPUVendorRule& rule);
        void removeGPUVendorRule(GPUVendor vendor);
        typedef ConstVectorIterator<GPUVendorRuleList> GPUVendorRuleIterator;
        GPUVendorRuleIterator getGPUVendorRuleIterator() const;

        void addGPUDeviceNameRule(const String& devicePattern, IncludeOrExclude includeOrExclude, bool caseSensitive = false);
        void addGPUDeviceNameRule(const GPUDeviceNameRule& rule);
        void removeGPUDeviceNameRule(const String& devicePattern);
        typedef ConstVectorIterator<GPUDeviceNameRuleList> GPUDeviceNameRuleIterator;
        GPUDeviceNameRuleIterator getGPUDeviceNameRuleIterator() const;

        UserObjectBindings& getUserObjectBindings() { return mUserObjectBindings; }

        const UserObjectBindings& getUserObjectBindings() const { return mUserObjectBindings; }

    };

}
#endif