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-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef __Technique_H__
#define __Technique_H__

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

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

        typedef std::vector<Pass*> 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);
    public:
        Technique(Material* parent);
        Technique(Material* parent, const Technique& oth);
        ~Technique();
        bool isSupported(void) const;
        void _compile(bool autoManageTextureUnits);
        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;

        void _load(void);
        void _unload(void);

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

        void _notifyNeedsRecompile(void);


        // -------------------------------------------------------------------------------
        // 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(ushort bias);

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

        void setSceneBlending( const SceneBlendType sbt );

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

        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;


    };


}
#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:50 2006