directional-light.hpp

Go to the documentation of this file.

/*
 * Copyright (C) 2023  Christopher J. Howard
 *
 * This file is part of Antkeeper source code.
 *
 * Antkeeper source code 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.
 *
 * Antkeeper source code 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 General Public License
 * along with Antkeeper source code.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef ANTKEEPER_SCENE_DIRECTIONAL_LIGHT_HPP
#define ANTKEEPER_SCENE_DIRECTIONAL_LIGHT_HPP
 
#include <engine/scene/light.hpp>
#include <engine/gl/texture.hpp>
#include <engine/math/vector.hpp>
#include <memory>
#include <span>
 
namespace scene {
 
class directional_light: public light
{
public:
    directional_light();
    
    [[nodiscard]] inline light_type get_light_type() const noexcept override
    {
        return light_type::directional;
    }
    
    
    void set_direction(const math::fvec3& direction);
    
    inline void set_color(const math::fvec3& color) noexcept
    {
        m_color = color;
        color_updated();
    }
    
    inline void set_illuminance(float illuminance) noexcept
    {
        m_illuminance = illuminance;
        illuminance_updated();
    }
    
    [[nodiscard]] inline constexpr const math::fvec3& get_direction() const noexcept
    {
        return m_direction;
    }
    
    [[nodiscard]] inline constexpr const math::fvec3& get_color() const noexcept
    {
        return m_color;
    }
    
    [[nodiscard]] inline constexpr float get_illuminance() const noexcept
    {
        return m_illuminance;
    }
    
    [[nodiscard]] inline constexpr const math::fvec3& get_colored_illuminance() const noexcept
    {
        return m_colored_illuminance;
    }
    
    
    
    void set_shadow_caster(bool caster) noexcept;
    
    void set_shadow_framebuffer(std::shared_ptr<gl::framebuffer> framebuffer) noexcept;
    
    void set_shadow_bias(float bias) noexcept;
    
    void set_shadow_cascade_count(unsigned int count) noexcept;
    
    void set_shadow_max_distance(float distance) noexcept;
    
    void set_shadow_fade_range(float range) noexcept;
    
    void set_shadow_cascade_distribution(float weight) noexcept;
    
    [[nodiscard]] inline constexpr bool is_shadow_caster() const noexcept
    {
        return m_shadow_caster;
    }
    
    [[nodiscard]] inline constexpr const std::shared_ptr<gl::framebuffer>& get_shadow_framebuffer() const noexcept
    {
        return m_shadow_framebuffer;
    }
    
    [[nodiscard]] inline constexpr const std::shared_ptr<gl::texture_2d>& get_shadow_texture() const noexcept
    {
        return m_shadow_texture;
    }
    
    [[nodiscard]] inline constexpr float get_shadow_bias() const noexcept
    {
        return m_shadow_bias;
    }
    
    [[nodiscard]] inline constexpr unsigned int get_shadow_cascade_count() const noexcept
    {
        return m_shadow_cascade_count;
    }
    
    [[nodiscard]] inline constexpr float get_shadow_max_distance() const noexcept
    {
        return m_shadow_max_distance;
    }
    
    [[nodiscard]] inline constexpr float get_shadow_fade_range() const noexcept
    {
        return m_shadow_fade_range;
    }
    
    [[nodiscard]] inline constexpr float get_shadow_cascade_distribution() const noexcept
    {
        return m_shadow_cascade_distribution;
    }
    
    [[nodiscard]] inline constexpr const math::fvec4& get_shadow_cascade_distances() const noexcept
    {
        return m_shadow_cascade_distances;
    }
    [[nodiscard]] inline constexpr math::fvec4& get_shadow_cascade_distances() noexcept
    {
        return m_shadow_cascade_distances;
    }
    
    [[nodiscard]] inline constexpr std::span<const math::fmat4> get_shadow_scale_bias_matrices() const noexcept
    {
        return m_shadow_scale_bias_matrices;
    }
    
    [[nodiscard]] inline constexpr std::span<const math::fmat4> get_shadow_cascade_matrices() const noexcept
    {
        return m_shadow_cascade_matrices;
    }
    [[nodiscard]] inline constexpr std::span<math::fmat4> get_shadow_cascade_matrices() noexcept
    {
        return m_shadow_cascade_matrices;
    }
    
 
private:
    void transformed() override;
    void color_updated();
    void illuminance_updated();
    void update_shadow_scale_bias_matrices();
    void update_shadow_cascade_distances();
    
    math::fvec3 m_direction{0.0f, 0.0f, -1.0f};
    math::fvec3 m_color{1.0f, 1.0f, 1.0f};
    float m_illuminance{};
    math::fvec3 m_colored_illuminance{};
    
    bool m_shadow_caster{false};
    std::shared_ptr<gl::framebuffer> m_shadow_framebuffer;
    std::shared_ptr<gl::texture_2d> m_shadow_texture;
    float m_shadow_bias{0.005f};
    unsigned int m_shadow_cascade_count{4};
    float m_shadow_max_distance{100.0f};
    float m_shadow_fade_range{0.0f};
    float m_shadow_cascade_distribution{0.8f};
    math::fvec4 m_shadow_cascade_distances;
    math::fmat4 m_shadow_cascade_matrices[4];
    math::fmat4 m_shadow_scale_bias_matrices[4];
};
 
} // namespace scene
 
#endif // ANTKEEPER_SCENE_DIRECTIONAL_LIGHT_HPP