tfPhong.h

/*******************************************************************************
 * This file is part of Tissue Forge.
 * Copyright (c) 2022-2024 T.J. Sego
 * 
 * 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 3 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 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, see <http://www.gnu.org/licenses/>.
 * 
 ******************************************************************************/
 
/*
Derived from Magnum with the following notice:
 
 Copyright © 2010, 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018, 2019,
 2020, 2021 Vladimír Vondruš <mosra@centrum.cz>
 
 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 _SOURCE_SHADERS_TFPHONG_H_
#define _SOURCE_SHADERS_TFPHONG_H_
 
#include "Magnum/GL/AbstractShaderProgram.h"
#include "Magnum/Shaders/Generic.h"
#include "Magnum/Shaders/visibility.h"
 
 
using namespace Magnum;
 
 
namespace TissueForge::shaders {
 
 
    class Phong: public GL::AbstractShaderProgram {
    public:
        typedef Magnum::Shaders::Generic3D::Position Position;
        
        typedef Magnum::Shaders::Generic3D::Normal Normal;
        
        typedef Magnum::Shaders::Generic3D::Tangent Tangent;
        
        typedef typename Magnum::Shaders::Generic3D::Tangent4 Tangent4;
        
        typedef typename Magnum::Shaders::Generic3D::Bitangent Bitangent;
        
        typedef Magnum::Shaders::Generic3D::TextureCoordinates TextureCoordinates;
        
        typedef Magnum::Shaders::Generic3D::Color3 Color3;
        
        typedef Magnum::Shaders::Generic3D::Color4 Color4;
        
    #ifndef MAGNUM_TARGET_GLES2
        typedef Magnum::Shaders::Generic3D::ObjectId ObjectId;
    #endif
        
        typedef Magnum::Shaders::Generic3D::TransformationMatrix TransformationMatrix;
        
        typedef Magnum::Shaders::Generic3D::NormalMatrix NormalMatrix;
        
        typedef typename Magnum::Shaders::Generic3D::TextureOffset TextureOffset;
        
        enum: UnsignedInt {
            ColorOutput = Magnum::Shaders::Generic3D::ColorOutput,
            
    #ifndef MAGNUM_TARGET_GLES2
            ObjectIdOutput = Magnum::Shaders::Generic3D::ObjectIdOutput
    #endif
        };
        
        enum class Flag: UnsignedShort {
            AmbientTexture = 1 << 0,
            
            DiffuseTexture = 1 << 1,
            
            SpecularTexture = 1 << 2,
            
            NormalTexture = 1 << 4,
            
            AlphaMask = 1 << 3,
            
            VertexColor = 1 << 5,
            
            Bitangent = 1 << 11,
            
            TextureTransformation = 1 << 6,
            
    #ifndef MAGNUM_TARGET_GLES2
            ObjectId = 1 << 7,
            
            InstancedObjectId = (1 << 8)|ObjectId,
    #endif
            
            InstancedTransformation = 1 << 9,
            
            InstancedTextureOffset = (1 << 10)|TextureTransformation
        };
        
        typedef Containers::EnumSet<Flag> Flags;
        
        explicit Phong(Flags flags = {}, unsigned lightCount = 1, unsigned clipPlaneCount = 0);
        
        explicit Phong(NoCreateT) noexcept: GL::AbstractShaderProgram{NoCreate} {}
        
        Phong(const Phong&) = delete;
        
        Phong(Phong&&) noexcept = default;
        
        Phong& operator=(const Phong&) = delete;
        
        Phong& operator=(Phong&&) noexcept = default;
        
        Flags flags() const { return _flags; }
        
        UnsignedInt lightCount() const { return _lightCount; }
        
        Phong& setAmbientColor(const Magnum::Color4& color);
        
        Phong& bindAmbientTexture(GL::Texture2D& texture);
        
        Phong& setDiffuseColor(const Magnum::Color4& color);
        
        Phong& bindDiffuseTexture(GL::Texture2D& texture);
        
        Phong& setNormalTextureScale(Float scale);
        
        Phong& bindNormalTexture(GL::Texture2D& texture);
        
        Phong& setSpecularColor(const Magnum::Color4& color);
        
        Phong& bindSpecularTexture(GL::Texture2D& texture);
        
        Phong& bindTextures(GL::Texture2D* ambient, GL::Texture2D* diffuse, GL::Texture2D* specular, GL::Texture2D* normal
    #ifdef MAGNUM_BUILD_DEPRECATED
                            = nullptr
    #endif
        );
        
        Phong& setShininess(Float shininess);
        
        Phong& setAlphaMask(Float mask);
        
    #ifndef MAGNUM_TARGET_GLES2
        Phong& setObjectId(UnsignedInt id);
    #endif
        
        Phong& setTransformationMatrix(const Matrix4& matrix);
        
        Phong& setNormalMatrix(const Matrix3x3& matrix);
        
        Phong& setProjectionMatrix(const Matrix4& matrix);
        
        Phong& setTextureMatrix(const Matrix3& matrix);
        
        Phong& setLightPositions(Containers::ArrayView<const Vector4> positions);
        
        Phong& setLightPositions(std::initializer_list<Vector4> positions);
        
    #ifdef MAGNUM_BUILD_DEPRECATED
    
        CORRADE_DEPRECATED("use setLightPositions(Containers::ArrayView<const Vector4>) instead") Phong& setLightPositions(Containers::ArrayView<const Vector3> positions);
        
        CORRADE_DEPRECATED("use setLightPositions(std::initializer_list<Vector4>) instead") Phong& setLightPositions(std::initializer_list<Vector3> positions);
    #endif
        
        Phong& setLightPosition(UnsignedInt id, const Vector4& position);
        
        
        Phong& setclipPlaneEquation(UnsignedInt id, const Vector4& position);
        
    #ifdef MAGNUM_BUILD_DEPRECATED
 
        CORRADE_DEPRECATED("use setLightPosition(UnsignedInt, const Vector4&) instead") Phong& setLightPosition(UnsignedInt id, const Vector3& position);
        
        CORRADE_DEPRECATED("use setLightPositions(std::initializer_list<Vector4>) instead") Phong& setLightPosition(const Vector3& position);
    #endif
        
        Phong& setLightColors(Containers::ArrayView<const Magnum::Color3> colors);
        
        Phong& setLightColors(std::initializer_list<Magnum::Color3> colors);
        
    #ifdef MAGNUM_BUILD_DEPRECATED
 
        CORRADE_DEPRECATED("use setLightColors(Containers::ArrayView<const Magnum::Color3>) instead") Phong& setLightColors(Containers::ArrayView<const Magnum::Color4> colors);
        
        CORRADE_DEPRECATED("use setLightColors(std::initializer_list<Magnum::Color3>) instead") Phong& setLightColors(std::initializer_list<Magnum::Color4> colors);
    #endif
        
        Phong& setLightColor(UnsignedInt id, const Magnum::Color3& color);
        
    #ifdef MAGNUM_BUILD_DEPRECATED
 
        CORRADE_DEPRECATED("use setLightColor(UnsignedInt, const Magnum::Color3&) instead") Phong& setLightColor(UnsignedInt id, const Magnum::Color4& color);
        
        CORRADE_DEPRECATED("use setLightColor(std::initializer_list<Color3>) instead") Phong& setLightColor(const Magnum::Color4& color);
    #endif
        
        Phong& setLightSpecularColors(Containers::ArrayView<const Magnum::Color3> colors);
        
        Phong& setLightSpecularColors(std::initializer_list<Magnum::Color3> colors);
        
        Phong& setLightSpecularColor(UnsignedInt id, const Magnum::Color3& color);
        
        Phong& setLightRanges(Containers::ArrayView<const Float> ranges);
        
        Phong& setLightRanges(std::initializer_list<Float> ranges);
        
        Phong& setLightRange(UnsignedInt id, Float range);
        
        unsigned clipPlaneCount() const {
            return _clipPlaneCount;
        }
        
    private:
        /* Prevent accidentally calling irrelevant functions */
    #ifndef MAGNUM_TARGET_GLES
        using GL::AbstractShaderProgram::drawTransformFeedback;
    #endif
    #if !defined(MAGNUM_TARGET_GLES2) && !defined(MAGNUM_TARGET_WEBGL)
        using GL::AbstractShaderProgram::dispatchCompute;
    #endif
        
        Flags _flags;
        UnsignedInt _lightCount{};
        Int _transformationMatrixUniform{0},
        _projectionMatrixUniform{1},
        _normalMatrixUniform{2},
        _textureMatrixUniform{3},
        _ambientColorUniform{4},
        _diffuseColorUniform{5},
        _specularColorUniform{6},
        _shininessUniform{7},
        _normalTextureScaleUniform{8},
        _alphaMaskUniform{9};
    #ifndef MAGNUM_TARGET_GLES2
        Int _objectIdUniform{10};
    #endif
        Int _lightPositionsUniform{11},
        _lightColorsUniform, /* 11 + lightCount, set in the constructor */
        _lightSpecularColorsUniform, /* 11 + 2*lightCount */
        _lightRangesUniform; /* 11 + 3*lightCount */
        
        
        UnsignedInt _clipPlaneCount{1};
        
        Int _clipPlanesUniform; /*_lightRangesUniform + 1, or  11 + 4*lightCount, set in the constructor */
    };
 
    MAGNUM_SHADERS_EXPORT Debug& operator<<(Debug& debug, Phong::Flag value);
    MAGNUM_SHADERS_EXPORT Debug& operator<<(Debug& debug, Phong::Flags value);
    CORRADE_ENUMSET_OPERATORS(Phong::Flags)
 
}
 
#endif // _SOURCE_SHADERS_TFPHONG_H_