field_of_view.hpp

/*
 Copyright (c) 2026 ETIB Corporation
 
 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.
 */
 
#pragma once
 
#include <cmath>
#include <numbers>
#include <stdexcept>
#include <string>
#include <type_traits>
#include <ostream>
 
namespace utility::graphic
{
 
    template<typename Type>
    concept CanBeFieldOfViewComponent = std::is_floating_point_v<Type>;
 
    template<CanBeFieldOfViewComponent Type> class FieldOfView
    {
        private:
        Type _up;       
        Type _down;     
        Type _left;     
        Type _right;    
 
        public:
        FieldOfView(void)
            : FieldOfView(Type { 0 }, Type { 0 }, Type { 0 }, Type { 0 })
        {
        }
 
        FieldOfView(Type up, Type down, Type left, Type right)
            : _up(up)
            , _down(down)
            , _left(left)
            , _right(right)
        {
        }
 
        FieldOfView(const FieldOfView &other) = default;
 
        FieldOfView(FieldOfView &&other) noexcept = default;
 
        FieldOfView &operator=(const FieldOfView &other) = default;
 
        FieldOfView &operator=(FieldOfView &&other) noexcept = default;
 
        ~FieldOfView(void) = default;
 
        FieldOfView &setUp(const Type up)
        {
            _up = up;
            return *this;
        }
 
        Type getUp(void) const noexcept
        {
            return _up;
        }
 
        FieldOfView &setDown(const Type down)
        {
            _down = down;
            return *this;
        }
 
        Type getDown(void) const noexcept
        {
            return _down;
        }
 
        FieldOfView &setLeft(const Type left)
        {
            _left = left;
            return *this;
        }
 
        Type getLeft(void) const noexcept
        {
            return _left;
        }
 
        FieldOfView &setRight(const Type right)
        {
            _right = right;
            return *this;
        }
 
        Type getRight(void) const noexcept
        {
            return _right;
        }
 
        bool isSymmetric(Type epsilon = Type { 1e-6 }) const noexcept
        {
            return std::abs(_up - _down) <= epsilon
                && std::abs(_left - _right) <= epsilon;
        }
    };
 
    using FieldOfViewF = FieldOfView<float>;
 
    using FieldOfViewD = FieldOfView<double>;
 
    std::ostream &operator<<(std::ostream &stream, const FieldOfViewF &fov);
 
    std::ostream &operator<<(std::ostream &stream, const FieldOfViewD &fov);
 
}    // namespace utility::graphic