Angle.hpp

Go to the documentation of this file.

//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2024 Laurent Gomila (laurent@sfml-dev.org)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
 
#pragma once
 
 
namespace sf
{
class Angle
{
public:
    constexpr Angle() = default;

    [[nodiscard]] constexpr float asDegrees() const;

    [[nodiscard]] constexpr float asRadians() const;

    [[nodiscard]] constexpr Angle wrapSigned() const;

    [[nodiscard]] constexpr Angle wrapUnsigned() const;

    // Static member data
    // NOLINTNEXTLINE(readability-identifier-naming)
    static const Angle Zero; 
 
private:
    friend constexpr Angle degrees(float angle);
    friend constexpr Angle radians(float angle);

    constexpr explicit Angle(float radians);

    // Member data
    float m_radians{}; 
};

[[nodiscard]] constexpr Angle degrees(float angle);

[[nodiscard]] constexpr Angle radians(float angle);

[[nodiscard]] constexpr bool operator==(Angle left, Angle right);

[[nodiscard]] constexpr bool operator!=(Angle left, Angle right);

[[nodiscard]] constexpr bool operator<(Angle left, Angle right);

[[nodiscard]] constexpr bool operator>(Angle left, Angle right);

[[nodiscard]] constexpr bool operator<=(Angle left, Angle right);

[[nodiscard]] constexpr bool operator>=(Angle left, Angle right);

[[nodiscard]] constexpr Angle operator-(Angle right);

[[nodiscard]] constexpr Angle operator+(Angle left, Angle right);

constexpr Angle& operator+=(Angle& left, Angle right);

[[nodiscard]] constexpr Angle operator-(Angle left, Angle right);

constexpr Angle& operator-=(Angle& left, Angle right);

[[nodiscard]] constexpr Angle operator*(Angle left, float right);

[[nodiscard]] constexpr Angle operator*(float left, Angle right);

constexpr Angle& operator*=(Angle& left, float right);

[[nodiscard]] constexpr Angle operator/(Angle left, float right);

constexpr Angle& operator/=(Angle& left, float right);

[[nodiscard]] constexpr float operator/(Angle left, Angle right);

[[nodiscard]] constexpr Angle operator%(Angle left, Angle right);

constexpr Angle& operator%=(Angle& left, Angle right);
 
namespace Literals
{

[[nodiscard]] constexpr Angle operator""_deg(long double angle);

[[nodiscard]] constexpr Angle operator""_deg(unsigned long long int angle);

[[nodiscard]] constexpr Angle operator""_rad(long double angle);

[[nodiscard]] constexpr Angle operator""_rad(unsigned long long int angle);
 
} // namespace Literals
} // namespace sf
 
#include <SFML/System/Angle.inl>