Struct angulus::Angle

#[repr(transparent)]
pub struct Angle<F> { /* private fields */ }

Represents the canonical value of an angle.

The value is stored in the range (-π, π].

The parameter F is the floating-point type used to store the value.

Implementations

impl<F: Float> Angle<F>

pub const ZERO: Self = _

The angle of value zero.

pub const EPSILON: Self = _

Machine epsilon value for Angle.

impl<F: Float> Angle<F>

pub const RAD_PI: Self = _

The angle of π radians.

pub const RAD_FRAC_PI_2: Self = _

The angle of π/2 radians.

pub const RAD_FRAC_PI_3: Self = _

The angle of π/3 radians.

pub const RAD_FRAC_PI_4: Self = _

The angle of π/4 radians.

pub const RAD_FRAC_PI_6: Self = _

The angle of π/6 radians.

pub const RAD_FRAC_PI_8: Self = _

The angle of π/8 radians.

impl<F: Float> Angle<F>

pub const DEG_180: Self = Self::RAD_PI

The angle of 180°.

pub const DEG_90: Self = Self::RAD_FRAC_PI_2

The angle of 90°.

pub const DEG_60: Self = Self::RAD_FRAC_PI_3

The angle of 60°.

pub const DEG_45: Self = Self::RAD_FRAC_PI_4

The angle of 45°.

pub const DEG_30: Self = Self::RAD_FRAC_PI_6

The angle of 30°.

pub const DEG_22_5: Self = Self::RAD_FRAC_PI_8

The angle of 22.5°.

impl<F: Float> Angle<F>

pub const HALF: Self = Self::RAD_PI

The angle of a half of a circle (1/2 turns).

pub const QUARTER: Self = Self::RAD_FRAC_PI_2

The angle of a quarter of a circle (1/4 turns).

pub const SIXTH: Self = Self::RAD_FRAC_PI_3

The angle of a sixth of a circle (1/6 turns).

pub const EIGHTH: Self = Self::RAD_FRAC_PI_4

The angle of a eighth of a circle (1/8 turns).

pub const TWELFTH: Self = Self::RAD_FRAC_PI_6

The angle of a twelfth of a circle (1/12 turns).

pub const SIXTEENTH: Self = Self::RAD_FRAC_PI_8

The angle of a sixteenth of a circle (1/16 turns).

impl<F: Float> Angle<F>

pub const GRAD_200: Self = Self::RAD_PI

The angle of 200g.

pub const GRAD_100: Self = Self::RAD_FRAC_PI_2

The angle of 100g.

pub const GRAD_66_6: Self = Self::RAD_FRAC_PI_3

The angle of 66.6g.

pub const GRAD_50: Self = Self::RAD_FRAC_PI_4

The angle of 50g.

pub const GRAD_33_3: Self = Self::RAD_FRAC_PI_6

The angle of 33.3g.

pub const GRAD_25: Self = Self::RAD_FRAC_PI_8

The angle of 25g.

impl<F> Angle<F>

pub const fn from_radians_unchecked(radians: F) -> Self

Creates a new angle from a value in radians assuming it is already in the the range (-π, π].

impl<F: Float> Angle<F>

pub fn from_radians(radians: F) -> Self

Creates a new angle from a value in radians.

pub fn from_degrees(degrees: F) -> Self

Creates a new angle from a value in degrees.

pub fn from_turns(turns: F) -> Self

Creates a new angle from a value in turns.

pub fn from_gradians(gradians: F) -> Self

Creates a new angle from a value in gradians.

impl<F: Copy> Angle<F>

pub const fn to_radians(self) -> F

The value of the angle in radians.

impl<F: Float> Angle<F>

pub fn to_degrees(self) -> F

The value of the angle in degrees.

pub fn to_turns(self) -> F

The value of the angle in turns.

pub fn to_gradians(self) -> F

The value of the angle in gradians.

impl<F: Copy> Angle<F>

pub const fn to_unbounded(self) -> AngleUnbounded<F>

Converts this angle into an unbounded angle.

impl<F: Float> Angle<F>

pub fn sin(self) -> F

Computes the sine.

pub fn cos(self) -> F

Computes the cosine.

pub fn tan(self) -> F

Computes the tangent.

pub fn sin_cos(self) -> (F, F)

Simultaneously computes the sine and cosine. Returns (sin(x), cos(x)).

Trait Implementations

impl<F: Float> Add<Angle<F>> for Angle<F>

type Output = Angle<F>

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl<F: Clone> Clone for Angle<F>

fn clone(&self) -> Angle<F>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<F: Debug> Debug for Angle<F>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F: Float> Default for Angle<F>

fn default() -> Self

Returns the “default value” for a type.

impl<F: Float> Div<F> for Angle<F>

type Output = Angle<F>

The resulting type after applying the / operator.

fn div(self, rhs: F) -> Self::Output

Performs the / operation.

impl<F: Copy> From<Angle<F>> for AngleUnbounded<F>

fn from(angle: Angle<F>) -> Self

Converts to this type from the input type.

impl<F: Float> From<AngleUnbounded<F>> for Angle<F>

fn from(angle: AngleUnbounded<F>) -> Self

Converts to this type from the input type.

impl<F: Hash> Hash for Angle<F>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Mul<Angle<f32>> for f32

type Output = Angle<f32>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<f32>) -> Self::Output

Performs the * operation.

impl Mul<Angle<f64>> for f64

type Output = Angle<f64>

The resulting type after applying the * operator.

fn mul(self, rhs: Angle<f64>) -> Self::Output

Performs the * operation.

impl<F: Float> Mul<F> for Angle<F>

type Output = Angle<F>

The resulting type after applying the * operator.

fn mul(self, rhs: F) -> Self::Output

Performs the * operation.

impl<F: Float> Neg for Angle<F>

type Output = Angle<F>

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl<F: PartialEq> PartialEq<Angle<F>> for Angle<F>

fn eq(&self, other: &Angle<F>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<F: Float> Sub<Angle<F>> for Angle<F>

type Output = Angle<F>

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl<F: Copy> Copy for Angle<F>

impl<F: Eq> Eq for Angle<F>

impl<F> StructuralEq for Angle<F>

impl<F> StructuralPartialEq for Angle<F>