Angle.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants
Licensee a limited, non-exclusive, non-transferable, royalty-free license
(without the right to sublicense) to use the API solely for the purpose of
Licensee's internal development efforts to develop applications for which
the API was provided.
 
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.
 
Library: Base
File: Angle
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include <NDEVR/BaseValues.h>
#include <NDEVR/BufferBase.h>
#include <cmath>
 
namespace NDEVR
{
    enum EulerPosition : uint01
    {
          ROLL  
        , PITCH 
        , YAW   
    };

    enum AngleType
    {
          RADIANS       
        , DEGREES       
        , INTERNAL_ANGLE    
        , PERCENT       
    };

    template<class t_float_type>
    static constexpr t_float_type PI()
    {
        return cast<t_float_type>(3.14159265358979323846264338327950288419716939937510);
    }

    template<class t_type = fltp08>
    class Angle
    {
    public:

        constexpr Angle()
            : m_index_angle(0)
        {}

        constexpr Angle(const Angle& angle)
            : m_index_angle(angle.m_index_angle)
        {}

        template<class t_other_type>
        explicit constexpr Angle(const Angle<t_other_type>& angle)
            : m_index_angle(cast<t_type>(angle.template internal<false>()))
        {}

        constexpr explicit Angle(AngleType type, fltp04 value)
            : m_index_angle(ConvertToInternal(type, value))
        {}

        constexpr explicit Angle(AngleType type, fltp08 value)
            : m_index_angle(ConvertToInternal(type, value))
        {}

        constexpr explicit Angle(t_type value)
            : m_index_angle(value)
        {}

        template<AngleType t_angle_type>
        [[nodiscard]] constexpr fltp08 as() const
        {
            switch (t_angle_type)
            {
            case INTERNAL_ANGLE:
                if (IsInvalid(m_index_angle))
                    return Constant<fltp08>::Invalid;
                else
                    return cast<fltp08>(internal<false>());
            case DEGREES:
                return as<INTERNAL_ANGLE>() * INV_INDEX_PI * 180.0;
            case RADIANS:
                return as<INTERNAL_ANGLE>() * INV_INDEX_PI * PI<fltp08>();
            case PERCENT:
                return as<INTERNAL_ANGLE>() * INV_INDEX_PI * 0.5;
            }
            return Constant<fltp08>::Invalid;
        }

        [[nodiscard]] constexpr fltp08 as(AngleType type) const
        {
            switch (type)
            {
            case DEGREES: return as<DEGREES>();
            case RADIANS: return as<RADIANS>();
            case PERCENT: return as<PERCENT>();
            case INTERNAL_ANGLE: return as<INTERNAL_ANGLE>();
            }
            return Constant<fltp08>::Invalid;
        }
    public:
        template<bool t_normalized>
        [[nodiscard]] constexpr t_type internal() const
        {
            if constexpr(t_normalized)
            {
                return Angle<t_type>::template NormalizeInternal<t_type>(m_index_angle);
            }
            else
            {
                return m_index_angle;
            }
        }

        template<class t_new_type>
        constexpr Angle<t_new_type> toTypeAngle() const
        {
            Angle<t_new_type> angle(cast<t_new_type>(m_index_angle));
            return angle;
        }

        [[nodiscard]] constexpr Angle normalized() const
        {
            return Angle(internal<true>());
        }

        [[nodiscard]] constexpr Angle normalizedOffset() const
        {
            Angle value = normalized();
            if (value > Angle(DEGREES, 180.0))
                value -= Angle(DEGREES, 360.0);
            return value;
        }

        constexpr Angle& operator=(const Angle& angle)
        {
            m_index_angle = angle.m_index_angle;
            return (*this);
        }

        constexpr bool operator==(const Angle& angle) const
        {
            return internal<false>() == angle.internal<false>();
        }

        constexpr bool operator!=(const Angle& angle) const
        {
            return internal<false>() != angle.internal<false>();
        }

        Angle operator-() const
        {
            return Angle(-m_index_angle);
        }
    public:

        template<class t_value_type>
        static Angle acos(t_value_type value)
        {
            return Angle(RADIANS, ::acos(value));
        }

        template<class t_value_type>
        static Angle asin(t_value_type value)
        {
            return Angle(RADIANS, ::asin(value));
        }
        
        template<class t_value_type>
        static Angle atan(t_value_type value)
        {
            return Angle(RADIANS, ::atan(value));
        }

        template<class t_value_type>
        static Angle atan2(t_value_type x, t_value_type y)
        {
            return Angle(RADIANS, ::atan2(x, y));
        }
    public:
        static constexpr sint04 INDEX_PI = 32768;   
        static constexpr fltp08 INV_INDEX_PI = { 1.0 / Angle<t_type>::INDEX_PI };   
    private:
        template<class t_normal_type>
        static constexpr typename std::enable_if<!ObjectInfo<t_normal_type>::Float, t_normal_type>::type NormalizeInternal(t_normal_type value)
        {
            const t_normal_type angle = (value >= 0 ? value : -value) % (2 * INDEX_PI);
            if (value >= 0)
                return angle;
            else
                return (2 * INDEX_PI) - angle;
        }

        template<class t_normal_type>
        static constexpr typename std::enable_if<ObjectInfo<t_normal_type>::Float, t_normal_type>::type NormalizeInternal(t_normal_type value)
        {
            const t_normal_type angle = cast<t_normal_type>(fmod(std::abs(value), (2 * INDEX_PI)));
            if (value >= 0)
                return angle;
            else
                return 2 * cast<t_normal_type>(INDEX_PI) - angle;
        }
        template<class t_value_type>
        static constexpr t_type ConvertToInternal(AngleType type, t_value_type value)
        {
            switch (type)
            {
            case INTERNAL_ANGLE: return cast<t_type>(value);
            case RADIANS: return cast<t_type>((value / PI<fltp08>()) * INDEX_PI);
            case DEGREES: return cast<t_type>((value / cast<t_value_type>(180)) * INDEX_PI);
            case PERCENT: return cast<t_type>(value * cast<t_value_type>(2) * INDEX_PI);
            default: return cast<t_type>(0); // Default to 0 for unsupported types
            }
        }
 
    private:
        t_type m_index_angle;
    };
    template<> constexpr const Angle<sint04> Constant<Angle<sint04>>::Invalid = Angle<sint04>(Constant<sint04>::Invalid);
    template<> constexpr const Angle<sint04> Constant<Angle<sint04>>::Max = Angle<sint04>(Constant<sint04>::Max);
    template<> constexpr const Angle<sint04> Constant<Angle<sint04>>::Min = Angle<sint04>(Constant<sint04>::Min);
 
    template<> constexpr const Angle<fltp08> Constant<Angle<fltp08>>::Invalid = Angle<fltp08>(Constant<fltp08>::Invalid);
    template<> constexpr const Angle<fltp08> Constant<Angle<fltp08>>::Max = Angle<fltp08>(Constant<fltp08>::Max);
    template<> constexpr const Angle<fltp08> Constant<Angle<fltp08>>::Min = Angle<fltp08>(Constant<fltp08>::Min);
    
    template<> constexpr const Angle<fltp04> Constant<Angle<fltp04>>::Invalid = Angle<fltp04>(Constant<fltp04>::Invalid);
    template<> constexpr const Angle<fltp04> Constant<Angle<fltp04>>::Max = Angle<fltp04>(Constant<fltp04>::Max);
    template<> constexpr const Angle<fltp04> Constant<Angle<fltp04>>::Min = Angle<fltp04>(Constant<fltp04>::Min);

    template<class t_type>
    Angle<t_type> asqrt(const Angle<t_type>& value)
    {
        return Angle<t_type>(::sqrt(value.template internal<false>()));
    }

    template<class t_type>
    static constexpr bool IsInvalid(const Angle<t_type>& value)
    {
        return IsInvalid(value.template internal<false>());
    }

    template<class t_type>
    static constexpr bool IsValid(const Angle<t_type>& value)
    {
        return IsValid(value.template internal<false>());
    }

    template<class t_to, class t_from>
    constexpr t_to cast(const Angle<t_from>& value)
    {
        return t_to(INTERNAL_ANGLE, cast<fltp08>(value.template internal<false>()));
    }

    template<>
    struct ObjectInfo<Angle<sint04>, false, false>
    {
        static const uint01 Dimensions = 0; 
        static const bool Vector = false;   
        static const bool Primitive = true; 
        static const bool Pointer = false;  
        static const bool Unsigned = false; 
        static const bool Float = true;     
        static const bool Integer = false;  
        static const bool Number = true;    
        static const bool String = false;   
        static const bool Color = false;    
        static const bool Buffer = false;   
        static const bool Boolean = false;  
        static constexpr ObjectInfo<Angle<sint04>, false, false> VectorSub() { return ObjectInfo<Angle<sint04>, false, false>(); }
    };

    template<>
    struct ObjectInfo<Angle<fltp08>, false, false>
    {
        static const uint01 Dimensions = 0; 
        static const bool Vector = false;   
        static const bool Primitive = true; 
        static const bool Pointer = false;  
        static const bool Unsigned = false; 
        static const bool Float = true;     
        static const bool Integer = false;  
        static const bool Number = true;    
        static const bool String = false;   
        static const bool Color = false;    
        static const bool Buffer = false;   
        static const bool Boolean = false;  
        static constexpr ObjectInfo<Angle<fltp08>, false, false> VectorSub() { return ObjectInfo<Angle<fltp08>, false, false>(); }
    };

    template<>
    struct ObjectInfo<Angle<fltp04>, false, false>
    {
        static const uint01 Dimensions = 0; 
        static const bool Vector = false;   
        static const bool Primitive = true; 
        static const bool Pointer = false;  
        static const bool Unsigned = false; 
        static const bool Float = true;     
        static const bool Integer = false;  
        static const bool Number = true;    
        static const bool String = false;   
        static const bool Color = false;    
        static const bool Buffer = false;   
        static const bool Boolean = false;  
        static constexpr ObjectInfo<Angle<fltp04>, false, false> VectorSub() { return ObjectInfo<Angle<fltp04>, false, false>(); }
    };
};