ResInsight/VisualizationModules/LibRender/cvfRenderState_FF.h

//##################################################################################################
//
//   Custom Visualization Core library
//   Copyright (C) 2011-2012 Ceetron AS
//    
//   This library is free software: you can redistribute it and/or modify 
//   it under the terms of the GNU General Public License as published by 
//   the Free Software Foundation, either version 3 of the License, or 
//   (at your option) any later version. 
//    
//   This library 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 General Public License at <<http://www.gnu.org/licenses/gpl.html>> 
//   for more details. 
//
//##################################################################################################

#pragma once

#include "cvfRenderState.h"
#include "cvfColor4.h"

namespace cvf {

class Texture2D_FF;


//==================================================================================================
//
// Encapsulates  OpenGL's glLightModel() and glEnable()/glDisable() with GL_LIGHTING
//
//==================================================================================================
class Lighting_FF : public RenderState
{
public:
    Lighting_FF(bool enableLighting = true);

    void            enable(bool enableLighting);
    bool            isEnabled() const;

    void            enableTwoSided(bool enableTwoSided);
    void            enableLocalViewer(bool enableLocalViewer);
    void            setAmbientIntensity(const Color3f& ambientIntensity);

    bool            isTwoSidedEnabled() const;
    bool            isLocalViewerEnabled() const;
    Color3f         ambientIntensity() const;

    virtual void    applyOpenGL(OpenGLContext* oglContext) const;
    virtual bool    isFixedFunction() const;

private:
    bool    m_enableLighting;   // Master enable/disable switch for fixed function OpenGL lighting
    bool	m_twoSided;	        // Two sided lighting
    bool	m_localViewer;		// Determines how specular reflection angles are computed
    Color4f m_ambientIntensity; // The global ambient light intensity
};



//==================================================================================================
//
// Encapsulates OpenGL glMaterial() state
//
//==================================================================================================
class Material_FF : public RenderState
{
public:
    enum MaterialIdent
    {
        // Simple materials with just ambient and diffuse set. All other parameters are left at defaults
        PURE_WHITE,	        ///< White material
        PURE_BLACK,	        ///< Black material
        PURE_RED,		    ///< Red material
        PURE_GREEN,	        ///< Green material
        PURE_BLUE,	        ///< Blue material
        PURE_YELLOW,	    ///< Yellow material
        PURE_MAGENTA,	    ///< Magenta material
        PURE_CYAN,	        ///< Cyan material

        // Parameters for common materials, based on table presented in SIGGRAPH 99, Lighting and Shading Techniques for Interactive Applications.
        // Sets specular and shininess in addition to ambient and diffuse, and may also include transparency (alpha value)
        BRASS,			    ///< Brass			
        BRONZE,			    ///< Bronze			
        POLISHED_BRONZE,    ///< Polished Bronze	
        CHROME,			    ///< Chrome			
        COPPER,			    ///< Copper			
        POLISHED_COPPER,	///< Polished Copper	
        GOLD,				///< Gold			
        POLISHED_GOLD,	    ///< Polished Gold	
        PEWTER,			    ///< Pewter			
        SILVER,			    ///< Silver			
        POLISHED_SILVER,	///< Polished Silver	
        EMERALD,			///< Emerald			
        JADE,				///< Jade			
        OBSIDIAN,			///< Obsidian		
        PEARL,			    ///< Pearl			
        RUBY,				///< Ruby			
        TURQUOISE,		    ///< Turquoise		
        BLACK_PLASTIC, 	    ///< Black Plastic	
        CYAN_PLASTIC, 	    ///< Cyan Plastic 
        GREEN_PLASTIC, 	    ///< Green Plastic
        RED_PLASTIC, 		///< Red Plastic 
        WHITE_PLASTIC, 	    ///< White Plastic 
        YELLOW_PLASTIC,	    ///< Yellow Plastic 
        BLACK_RUBBER, 	    ///< Black Rubber 
        CYAN_RUBBER, 		///< Cyan Rubber 
        GREEN_RUBBER, 	    ///< Green Rubber 
        RED_RUBBER, 		///< Red Rubber
        WHITE_RUBBER, 	    ///< White Rubber
        YELLOW_RUBBER 	    ///< Yellow Rubber
    };

public:
    Material_FF();
    explicit Material_FF(const Color3f& ambientAndDiffuseColor);
    explicit Material_FF(MaterialIdent materialIdent);

    void            setAmbientAndDiffuse(const Color3f& color);
    void            setDiffuse(const Color3f& color);
    void            setSpecular(const Color3f& color);
    void            setAlpha(float alpha);
    void            setShininess(float shininess);

    Color3f         frontAmbient() const;
    Color3f         frontDiffuse() const;
    Color3f         frontSpecular() const;
    Color3f         frontEmission() const;
    float           frontAlpha() const;
    float           frontShininess() const;

    void            enableColorMaterial(bool enableColorMaterial);
    bool            isColorMaterialEnabled() const;

    virtual void    applyOpenGL(OpenGLContext* oglContext) const;
    virtual bool    isFixedFunction() const;

private:
    Color3f m_ambient;
    Color3f m_diffuse;
    Color3f m_specular;
    Color3f m_emission;
    float   m_alpha;                // Alpha, 1.0 is no transparency, 0.0 completely transparent
    float   m_shininess;            // Range 0.0 to 128.0
    bool    m_enableColorMaterial;
};


//==================================================================================================
//
// Controls normalization of normals in fixed function
//
//==================================================================================================
class Normalize_FF : public RenderState
{
public:
    Normalize_FF(bool enableNormalization = true);

    void            enable(bool enableNormalization);
    bool            isEnabled() const;

    virtual void    applyOpenGL(OpenGLContext* oglContext) const;

private:
    bool        m_enable;
};


//==================================================================================================
//
// 
//
//==================================================================================================
class TextureMapping_FF : public RenderState
{
public:
    enum TextureFunction
    {
        MODULATE,
        DECAL
    };

public:
    TextureMapping_FF(Texture2D_FF* texture = NULL);
    ~TextureMapping_FF();

    void            setTexture(Texture2D_FF* texture);
    Texture2D_FF*   texture();
    void            setTextureFunction(TextureFunction texFunc);
    TextureFunction textureFunction() const;
    void            setEnvironmentMapping(bool environmentMapping);
    bool            environmentMapping() const;

    void            setupTexture(OpenGLContext* oglContext);
    virtual void    applyOpenGL(OpenGLContext* oglContext) const;
    virtual bool    isFixedFunction() const;

private:
    ref<Texture2D_FF>   m_texture;     
    TextureFunction     m_textureFunction;
    bool                m_environmentMapping;
};




}  // namespace cvf