FireSTARR
Loading...
Searching...
No Matches
fs::Radians Struct Reference
Inheritance diagram for fs::Radians:
Collaboration diagram for fs::Radians:

Public Member Functions

constexpr Radians (const Degrees &degrees) noexcept
 
constexpr Radians (const AspectSize aspect) noexcept
 
constexpr Degrees asDegrees () const
 
constexpr Radians fix () const
 Ensure that value lies between 0 and 2 * PI.
 
constexpr Radians to_heading () const
 Convert Bearing to Heading (opposite angle)
 
constexpr StrictType ()=default
 
constexpr StrictType (const ValueType value) noexcept
 
constexpr StrictType (T &&rhs) noexcept=default
 
constexpr StrictType (const T &rhs) noexcept=default
 
- Public Member Functions inherited from fs::StrictType< Radians, units::CompassRadians >
constexpr StrictType (const MathSize value) noexcept
 
constexpr StrictType (T &&rhs) noexcept=default
 
constexpr StrictType (const T &rhs) noexcept=default
 
T & operator= (T &&rhs) noexcept=default
 
T & operator= (const T &rhs) noexcept=default
 
constexpr auto operator== (const T &rhs) const
 
constexpr auto operator<=> (const T &rhs) const
 
constexpr Radians operator+ (const T &rhs) const noexcept
 
constexpr Radians operator- (const T &rhs) const noexcept
 
constexpr Radians operator* (const MathSize &rhs) const noexcept
 
constexpr Radians operator/ (const MathSize &rhs) const noexcept
 
constexpr T & operator+= (const T &rhs) noexcept
 
constexpr T & operator-= (const T &rhs) noexcept
 
constexpr T & operator*= (const T &rhs) noexcept
 
constexpr T & operator/= (const T &rhs) noexcept
 
 operator string () noexcept
 

Static Public Member Functions

static consteval Radians Pi ()
 
static consteval Radians PiX2 ()
 
static consteval Radians D_360 ()
 
static consteval Radians D_270 ()
 
static consteval Radians D_180 ()
 
static consteval Radians D_090 ()
 
static constexpr Radians fix (const Radians &radians)
 
static constexpr Radians from_degrees (const MathSize degrees)
 
static constexpr Radians from_aspect (const MathSize aspect)
 
- Static Public Member Functions inherited from fs::StrictType< Radians, units::CompassRadians >
static consteval Radians Zero ()
 
static consteval Radians Invalid ()
 

Additional Inherited Members

- Public Types inherited from fs::StrictType< Radians, units::CompassRadians >
using T
 
using concrete_type
 
using value_type
 
- Public Attributes inherited from fs::StrictType< Radians, units::CompassRadians >
MathSize value
 
- Static Public Attributes inherited from fs::StrictType< Radians, units::CompassRadians >
static constexpr auto units
 
static constexpr auto invalid_value
 

Member Function Documentation

◆ fix()

Radians fs::Radians::fix ( ) const
inlinenodiscardconstexpr

Ensure that value lies between 0 and 2 * PI.

Parameters
thetavalue to ensure is within bounds
Returns
value within range of (0, 2 * PI]
Here is the call graph for this function:
Here is the caller graph for this function:

◆ to_heading()

Radians fs::Radians::to_heading ( ) const
inlinenodiscardconstexpr

Convert Bearing to Heading (opposite angle)

Parameters
azimuthBearing
Returns
Heading

The documentation for this struct was generated from the following file: