position.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
 
#define _USE_MATH_DEFINES
#include <cmath>
#include <math.h>
 
#include <stdexcept>
#include <type_traits>
#include <utility>
 
#include "utility/math/vector.hpp"
 
namespace utility::graphic
{
 
    template<typename Type>
    concept CanBePositionComponent = math::CanBeVectorComponent<Type>;
 
    template<CanBePositionComponent PositionComponentType> class Position:
        public math::Vector<PositionComponentType, 3>
    {
        public:
        Position(void)
            : math::Vector<PositionComponentType, 3>(
                  PositionComponentType { 0 })
        {
        }
 
        explicit Position(PositionComponentType value)
            : math::Vector<PositionComponentType, 3>({ value, value, value })
        {
        }
 
        explicit Position(
            const utility::math::Vector<PositionComponentType, 3> &vector)
            : utility::math::Vector<PositionComponentType, 3>(vector)
        {
        }
 
        Position(PositionComponentType x, PositionComponentType y,
                 PositionComponentType z)
            : math::Vector<PositionComponentType, 3>({ x, y, z })
        {
        }
 
        Position(std::initializer_list<PositionComponentType> values)
            : math::Vector<PositionComponentType, 3>(
                  { PositionComponentType { 0 }, PositionComponentType { 0 },
                    PositionComponentType { 0 } })
        {
            if (values.size() != 3) {
                throw std::invalid_argument(
                    "Position requires exactly three components");
            }
            const auto it = values.begin();
            this->x       = *it;
            this->y       = *(it + 1);
            this->z       = *(it + 2);
        }
 
        Position(const std::initializer_list<PositionComponentType> &value)
            : math::Vector<PositionComponentType, 3>(value)
        {
        }
 
        Position(const Position &other) = default;
 
        Position(Position &&other) noexcept = default;
 
        Position &operator=(const Position &other) = default;
 
        Position &operator=(Position &&other) noexcept = default;
 
        ~Position(void) = default;
 
        Position &setX(const PositionComponentType value) noexcept
        {
            this->x = value;
            return *this;
        }
 
        PositionComponentType getX(void) const noexcept
        {
            return this->x;
        }
 
        Position &setY(const PositionComponentType value) noexcept
        {
            this->y = value;
            return *this;
        }
 
        PositionComponentType getY(void) const noexcept
        {
            return this->y;
        }
 
        Position &setZ(const PositionComponentType value) noexcept
        {
            this->z = value;
            return *this;
        }
 
        PositionComponentType getZ(void) const noexcept
        {
            return this->z;
        }
 
        Position &translate(const Position &offset) noexcept
        {
            *this += offset;
            return *this;
        }
 
        Position translated(const Position &offset) const noexcept
        {
            Position result(*this);
            result += offset;
            return result;
        }
 
        PositionComponentType distanceSquaredTo(const Position &other) const
        {
            const PositionComponentType dx = this->x - other.x;
            const PositionComponentType dy = this->y - other.y;
            const PositionComponentType dz = this->z - other.z;
            return dx * dx + dy * dy + dz * dz;
        }
 
        PositionComponentType distanceTo(const Position &other) const
        {
            return std::sqrt(distanceSquaredTo(other));
        }
 
        bool isOrigin(PositionComponentType epsilon = PositionComponentType {
                          1e-6 }) const noexcept
        {
            return std::abs(this->x) <= epsilon && std::abs(this->y) <= epsilon
                && std::abs(this->z) <= epsilon;
        }
 
        Position midpoint(const Position &other) const noexcept
        {
            return Position((this->x + other.x) / PositionComponentType { 2 },
                            (this->y + other.y) / PositionComponentType { 2 },
                            (this->z + other.z) / PositionComponentType { 2 });
        }
 
        bool operator==(const Position &other) const noexcept
        {
            if (this->x != other.x) {
                return false;
            }
            if (this->y != other.y) {
                return false;
            }
            if (this->z != other.z) {
                return false;
            }
            return true;
        }
 
        bool operator!=(const Position &other) const noexcept
        {
            return !(*this == other);
        }
 
        bool operator<(const Position &other) const noexcept
        {
            if (this->x != other.x) {
                return this->x < other.x;
            }
            if (this->y != other.y) {
                return this->y < other.y;
            }
            if (this->z != other.z) {
                return this->z < other.z;
            }
            return false;
        }
    };
 
    using PositionF = Position<float>;
 
    using PositionD = Position<double>;
 
    std::ostream &operator<<(std::ostream &stream, const PositionF &position);
 
    std::ostream &operator<<(std::ostream &stream, const PositionD &position);
 
}    // namespace utility::graphic