Direct3D10/include/OgreFixedFuncState.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-2011 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 __FixedFuncState_H__
#define __FixedFuncState_H__

#include "OgrePrerequisites.h"
#include "OgreGpuProgram.h"
#include "OgreColourValue.h"
#include "OgreBlendMode.h"
#include "OgreCommon.h"
#include "OgreLight.h"
#include "OgreTextureUnitState.h"
#include "OgreRenderSystem.h"

namespace Ogre {


    class TextureLayerState
    {
    protected:
        TextureType mTextureType;
        TexCoordCalcMethod mTexCoordCalcMethod;
        LayerBlendModeEx mLayerBlendOperationEx;
        uint8 mCoordIndex;
    public:
        TextureLayerState();
        ~TextureLayerState();
        TextureType getTextureType() const;
        void setTextureType(TextureType val);
        TexCoordCalcMethod getTexCoordCalcMethod() const;
        void setTexCoordCalcMethod(TexCoordCalcMethod val);
        LayerBlendModeEx getLayerBlendModeEx() const;
        void setLayerBlendModeEx(LayerBlendModeEx val);
        uint8 getCoordIndex() const;
        void setCoordIndex(uint8 val);
    };

    typedef vector<TextureLayerState>::type TextureLayerStateList;

    class VertexBufferElement
    {
    protected:
        VertexElementSemantic mVertexElementSemantic;
        VertexElementType mVertexElementType;
        unsigned short mVertexElementIndex;
    public:
        VertexElementSemantic getVertexElementSemantic() const;
        void setVertexElementSemantic(VertexElementSemantic val);
        VertexElementType getVertexElementType() const;
        void setVertexElementType(VertexElementType val);
        unsigned short getVertexElementIndex() const;
        void setVertexElementIndex(unsigned short val);
    };

    typedef vector<VertexBufferElement>::type VertexBufferElementList;

    class VertexBufferDeclaration
    {
    protected:
        VertexBufferElementList mVertexBufferElementList;
    public:
        VertexBufferDeclaration();
        ~VertexBufferDeclaration();
        const VertexBufferElementList & getVertexBufferElementList() const;
        void setVertexBufferElementList(const VertexBufferElementList & val);

        const bool operator<(const VertexBufferDeclaration & other) const;

        bool hasColor() const;
        uint8 getTexcoordCount() const;
        unsigned short numberOfTexcoord() const;
        unsigned short countVertexElementSemantic( VertexElementSemantic semantic ) const;

    };

    class GeneralFixedFuncState // this is a class of the "global parameters" so I can use memcmp on them
    {
    protected:
        bool mNormaliseNormals;
        //-------------------------------------------------------------------------
        // Alpha reject settings
        CompareFunction mAlphaRejectFunc;
        //-------------------------------------------------------------------------
        // Fog
        FogMode mFogMode;
        //-------------------------------------------------------------------------
        bool mLightingEnabled;

#define LIGHT_TYPES_COUNT Light::LT_SPOTLIGHT + 1 // better to update the LightTypes enum
        // a counter for each of the light types
        uint8 mLightFromTypeCount[LIGHT_TYPES_COUNT];
        ShadeOptions mShadeOptions;
    public:
        GeneralFixedFuncState();
        ~GeneralFixedFuncState();

        void setLightingEnabled(bool enabled);

        bool getLightingEnabled(void) const;

        void setShadingMode( ShadeOptions mode );

        ShadeOptions getShadingMode(void) const;

        void setFogMode( FogMode mode );

        FogMode getFogMode(void) const;

        void setAlphaRejectFunction(CompareFunction func);

        CompareFunction getAlphaRejectFunction(void) const;


        void setNormaliseNormals(bool normalise);

        bool getNormaliseNormals(void) const;

        const uint8 getLightTypeCount(const Light::LightTypes type) const;
        void setLightTypeCount(const Light::LightTypes type, const uint8 val);
        const uint8 getTotalNumberOfLights() const;
        void resetLightTypeCounts();
        void addOnetoLightTypeCount(const Light::LightTypes type);

    };

    class FixedFuncState
    {
    public:
    protected:
        GeneralFixedFuncState mGeneralFixedFuncState;
        //-------------------------------------------------------------------------
        TextureLayerStateList mTextureLayerStateList;
        //-------------------------------------------------------------------------
    public:
        FixedFuncState();
        ~FixedFuncState();

        const TextureLayerStateList & getTextureLayerStateList() const;
        void setTextureLayerStateList(const TextureLayerStateList & val);
        GeneralFixedFuncState & getGeneralFixedFuncState();

        const bool operator<(const FixedFuncState & other) const;

    };

}

#endif