scale.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 <concepts>
#include <numbers>
#include <ostream>
 
#include "utility/math/vector.hpp"
 
namespace utility::graphic
{
 
    template<typename Type>
    concept CanBeScaleComponent = math::CanBeVectorComponent<Type>;
 
    template<CanBeScaleComponent ScaleComponentType> class Scale:
        public math::Vector<ScaleComponentType, 3>
    {
        public:
        Scale(void)
            : math::Vector<ScaleComponentType, 3>(
                  { ScaleComponentType { 1.0f }, ScaleComponentType { 1.0f },
                    ScaleComponentType { 1.0f } })
        {
        }
 
        explicit Scale(ScaleComponentType value)
            : math::Vector<ScaleComponentType, 3>({ value, value, value })
        {
        }
 
        explicit Scale(
            const utility::math::Vector<ScaleComponentType, 3> &vector)
            : utility::math::Vector<ScaleComponentType, 3>(vector)
        {
        }
 
        Scale(ScaleComponentType x, ScaleComponentType y, ScaleComponentType z)
            : math::Vector<ScaleComponentType, 3>({ x, y, z })
        {
        }
 
        Scale(std::initializer_list<ScaleComponentType> values)
            : math::Vector<ScaleComponentType, 3>(
                  { ScaleComponentType { 1.0f }, ScaleComponentType { 1.0f },
                    ScaleComponentType { 1.0f } })
        {
            if (values.size() != 3) {
                throw std::invalid_argument(
                    "Scale requires exactly three components");
            }
            const auto it = values.begin();
            this->x       = *it;
            this->y       = *(it + 1);
            this->z       = *(it + 2);
        }
 
        Scale(const std::initializer_list<ScaleComponentType> &value)
            : math::Vector<ScaleComponentType, 3>(value)
        {
        }
 
        Scale(const Scale &other) = default;
 
        Scale(Scale &&other) noexcept = default;
 
        Scale &operator=(const Scale &other) = default;
 
        Scale &operator=(Scale &&other) noexcept = default;
 
        ~Scale(void) = default;
 
        Scale &setX(const ScaleComponentType value) noexcept
        {
            this->x = value;
            return *this;
        }
 
        ScaleComponentType getX(void) const noexcept
        {
            return this->x;
        }
 
        Scale &setY(const ScaleComponentType value) noexcept
        {
            this->y = value;
            return *this;
        }
 
        ScaleComponentType getY(void) const noexcept
        {
            return this->y;
        }
 
        Scale &setZ(const ScaleComponentType value) noexcept
        {
            this->z = value;
            return *this;
        }
 
        ScaleComponentType getZ(void) const noexcept
        {
            return this->z;
        }
 
        Scale &scaleBy(const Scale &factor) noexcept
        {
            this->x *= factor.x;
            this->y *= factor.y;
            this->z *= factor.z;
            return *this;
        }
 
        Scale scaled(const Scale &factor) const noexcept
        {
            Scale result(*this);
            result.scaleBy(factor);
            return result;
        }
 
        Scale &setUniform(ScaleComponentType value) noexcept
        {
            this->x = value;
            this->y = value;
            this->z = value;
            return *this;
        }
 
        bool isUniform(ScaleComponentType epsilon = ScaleComponentType {
                           1e-6 }) const noexcept
        {
            return std::abs(this->x - this->y) <= epsilon
                && std::abs(this->y - this->z) <= epsilon;
        }
 
        bool hasNegativeComponent(void) const noexcept
        {
            return this->x < ScaleComponentType {}
            || this->y < ScaleComponentType {}
            || this->z < ScaleComponentType {};
        }
 
        bool operator==(const Scale &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 Scale &other) const noexcept
        {
            return !(*this == other);
        }
 
        bool operator<(const Scale &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 ScaleF = Scale<float>;
 
    using ScaleD = Scale<double>;
 
    std::ostream &operator<<(std::ostream &stream, const ScaleF &scale);
 
    std::ostream &operator<<(std::ostream &stream, const ScaleD &scale);
}    // namespace utility::graphic