camera.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_CAMERA_HPP
#define ANTKEEPER_SCENE_CAMERA_HPP
 
#include <engine/scene/object.hpp>
#include <engine/geom/primitives/view-frustum.hpp>
#include <engine/geom/primitives/ray.hpp>
#include <engine/math/vector.hpp>
#include <engine/render/compositor.hpp>
#include <engine/math/numbers.hpp>
 
namespace scene {
 
class camera: public object<camera>
{
public:
    using view_frustum_type = geom::view_frustum<float>;
    
    [[nodiscard]] geom::ray<float, 3> pick(const math::fvec2& ndc) const;
 
    [[nodiscard]] math::fvec3 project(const math::fvec3& object, const math::fvec4& viewport) const;
 
    [[nodiscard]] math::fvec3 unproject(const math::fvec3& window, const math::fvec4& viewport) const;
 
    void set_perspective(float vertical_fov, float aspect_ratio, float near, float far = std::numeric_limits<float>::infinity());
    
    void set_vertical_fov(float vertical_fov);
    
    void set_aspect_ratio(float aspect_ratio);
    
    void set_orthographic(float clip_left, float clip_right, float clip_bottom, float clip_top, float clip_near, float clip_far);
 
    void set_exposure_value(float ev100);
    
    inline void set_compositor(render::compositor* compositor) noexcept
    {
        m_compositor = compositor;
    }
    
    inline void set_composite_index(int index) noexcept
    {
        m_composite_index = index;
    }
    
    [[nodiscard]] inline constexpr const render::compositor* get_compositor() const noexcept
    {
        return m_compositor;
    }
    [[nodiscard]] inline constexpr render::compositor* get_compositor() noexcept
    {
        return m_compositor;
    }
    
    [[nodiscard]] inline constexpr int get_composite_index() const noexcept
    {
        return m_composite_index;
    }
    
    [[nodiscard]] inline constexpr const aabb_type& get_bounds() const noexcept override
    {
        return m_bounds;
    }
    
    [[nodiscard]] inline constexpr bool is_orthographic() const noexcept
    {
        return m_orthographic;
    }
 
    [[nodiscard]] inline constexpr float get_clip_left() const noexcept
    {
        return m_clip_left;
    }
    
    [[nodiscard]] inline constexpr float get_clip_right() const noexcept
    {
        return m_clip_right;
    }
    
    [[nodiscard]] inline constexpr float get_clip_bottom() const noexcept
    {
        return m_clip_bottom;
    }
    
    [[nodiscard]] inline constexpr float get_clip_top() const noexcept
    {
        return m_clip_top;
    }
    
    [[nodiscard]] inline constexpr float get_clip_near() const noexcept
    {
        return m_clip_near;
    }
    
    [[nodiscard]] inline constexpr float get_clip_far() const noexcept
    {
        return m_clip_far;
    }
    
    [[nodiscard]] inline constexpr float get_vertical_fov() const noexcept
    {
        return m_vertical_fov;
    }
    
    [[nodiscard]] inline constexpr float get_aspect_ratio() const noexcept
    {
        return m_aspect_ratio;
    }
    
    [[nodiscard]] inline constexpr float get_exposure_value() const noexcept
    {
        return m_exposure_value;
    }
    
    [[nodiscard]] inline constexpr float get_exposure_normalization() const noexcept
    {
        return m_exposure_normalization;
    }
    
    [[nodiscard]] inline constexpr const math::fmat4& get_view() const noexcept
    {
        return m_view;
    }
    
    [[nodiscard]] inline constexpr const math::fmat4& get_inv_view() const noexcept
    {
        return m_inv_view;
    }
    
    [[nodiscard]] inline constexpr const math::fmat4& get_projection() const noexcept
    {
        return m_projection;
    }
    
    [[nodiscard]] inline constexpr const math::fmat4& get_inv_projection() const noexcept
    {
        return m_inv_projection;
    }
    
    [[nodiscard]] inline constexpr const math::fmat4& get_view_projection() const noexcept
    {
        return m_view_projection;
    }
    
    [[nodiscard]] inline constexpr const math::fmat4& get_inv_view_projection() const noexcept
    {
        return m_inv_view_projection;
    }
    
    [[nodiscard]] inline constexpr const math::fvec3& get_forward() const noexcept
    {
        return m_forward;
    }
    
    [[nodiscard]] inline constexpr const math::fvec3& get_up() const noexcept
    {
        return m_up;
    }
    
    [[nodiscard]] inline constexpr const view_frustum_type& get_view_frustum() const noexcept
    {
        return m_view_frustum;
    }
 
private:
    void transformed() override;
    void update_frustum();
    
    render::compositor* m_compositor{nullptr};
    int m_composite_index{0};
    
    bool m_orthographic{true};
    
    float m_clip_left{-1.0f};
    float m_clip_right{1.0f};
    float m_clip_bottom{-1.0f};
    float m_clip_top{1.0f};
    float m_clip_near{-1.0f};
    float m_clip_far{1.0f};
    float m_vertical_fov{math::half_pi<float>};
    float m_aspect_ratio{1.0f};
    float m_exposure_value{0.0f};
    float m_exposure_normalization{1.0f};
    
    math::fvec3 m_forward{0.0f, 0.0f, -1.0f};
    math::fvec3 m_up{0.0f, 1.0f, 0.0f};
    
    math::fmat4 m_view{math::fmat4::identity()};
    math::fmat4 m_inv_view{math::fmat4::identity()};
    math::fmat4 m_projection{math::fmat4::identity()};
    math::fmat4 m_inv_projection{math::fmat4::identity()};
    math::fmat4 m_view_projection{math::fmat4::identity()};
    math::fmat4 m_inv_view_projection{math::fmat4::identity()};
    
    view_frustum_type m_view_frustum;
    aabb_type m_bounds{{}, {}};
};
 
} // namespace scene
 
#endif // ANTKEEPER_SCENE_CAMERA_HPP