Struct Angle 

pub struct Angle(/* private fields */);

A scalar angular quantity.

Prevents confusion between degrees and radians by requiring the use of one of the named constructors to create an Angle, as well as one of the named getter methods to obtain the angle as a raw f32 value.

Implementations

impl Angle

pub const ZERO: Self

A zero degree angle.

pub const RIGHT: Self

A 90 degree angle.

pub const STRAIGHT: Self

A 180 degree angle.

pub const FULL: Self

A 360 degree angle.

pub const fn to_rads(self) -> f32

Returns the value of self in radians.

Examples

use std::f32;
use retrofire_core::math::degs;

assert_eq!(degs(90.0).to_rads(), f32::consts::FRAC_PI_2);

pub fn to_degs(self) -> f32

Returns the value of self in degrees.

Examples

use retrofire_core::math::turns;

assert_eq!(turns(2.0).to_degs(), 720.0);

pub fn to_turns(self) -> f32

Returns the value of self in turns.

Examples

use retrofire_core::math::degs;

assert_eq!(degs(180.0).to_turns(), 0.5);

pub fn min(self, other: Self) -> Self

Returns the minimum of self and other.

pub fn max(self, other: Self) -> Self

Returns the maximum of self and other.

pub fn clamp(self, min: Self, max: Self) -> Self

Returns self clamped to the range min..=max.

Examples

use retrofire_core::math::degs;

let (min, max) = (degs(0.0), degs(45.0));

assert_eq!(degs(100.0).clamp(min, max), max);
assert_eq!(degs(30.0).clamp(min, max), degs(30.0));
assert_eq!(degs(-10.0).clamp(min, max), min);

impl Angle

pub fn sin(self) -> f32

Returns the sine of self.

Examples

use retrofire_core::assert_approx_eq;
use retrofire_core::math::degs;

assert_approx_eq!(degs(30.0).sin(), 0.5)

pub fn cos(self) -> f32

Returns the cosine of self.

Examples

use retrofire_core::assert_approx_eq;
use retrofire_core::math::degs;

assert_approx_eq!(degs(60.0).cos(), 0.5)

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

Simultaneously computes the sine and cosine of self.

Examples

use retrofire_core::assert_approx_eq;
use retrofire_core::math::degs;

let (sin, cos) = degs(90.0).sin_cos();
assert_approx_eq!(sin, 1.0);
assert_approx_eq!(cos, 0.0);

pub fn tan(self) -> f32

Returns the tangent of self.

Examples

use retrofire_core::math::degs;
assert_eq!(degs(45.0).tan(), 1.0)

pub fn wrap(self, min: Self, max: Self) -> Self

Returns self “wrapped around” to the range min..max.

Examples

use retrofire_core::assert_approx_eq;
use retrofire_core::math::{degs, turns};

// 400 (mod 360) = 40
assert_approx_eq!(degs(400.0).wrap(turns(0.0), turns(1.0)), degs(40.0))

Trait Implementations

impl Add for Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

impl Affine for Angle

const DIM: usize = 1usize

The dimension of Self.

type Space = ()

The space that Self is the element type of.

type Diff = Angle

The (signed) difference of two values of Self. Diff must have the same dimension as Self.

fn add(&self, other: &Self) -> Self

Adds diff to self component-wise.

fn sub(&self, other: &Self) -> Self

Subtracts other from self, returning the (signed) difference.

fn combine<S: Copy, const N: usize>( weights: &[S; N], points: &[Self; N], ) -> Self

where Self: Clone, Self::Diff: Linear<Scalar = S>,

Returns an affine combination of points.

impl ApproxEq for Angle

fn approx_eq_eps(&self, other: &Self, eps: &Self) -> bool

Returns whether self and other are approximately equal, using the relative epsilon rel_eps.

fn relative_epsilon() -> Self

Returns the default relative epsilon of type E.

fn approx_eq(&self, other: &Other) -> bool

Returns whether self and other are approximately equal. Uses the epsilon returned by Self::relative_epsilon.

impl Clone for Angle

fn clone(&self) -> Angle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Angle

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

Formats the value using the given formatter.

impl Default for Angle

fn default() -> Angle

Returns the “default value” for a type.

impl Display for Angle

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

Formats the value using the given formatter.

impl Div<f32> for Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, rhs: f32) -> Self

Performs the / operation.

impl Linear for Angle

type Scalar = f32

The scalar type associated with Self.

fn zero() -> Self

Returns the additive identity of Self.

fn mul(&self, scalar: f32) -> Self

Multiplies all components of self by scalar.

fn neg(&self) -> Self

Returns the additive inverse of self.

impl Mul<f32> for Angle

type Output = Angle

The resulting type after applying the * operator.

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

Performs the * operation.

impl Neg for Angle

type Output = Angle

The resulting type after applying the - operator.

fn neg(self) -> Self

Performs the unary - operation.

impl PartialEq for Angle

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Rem for Angle

type Output = Angle

The resulting type after applying the % operator.

fn rem(self, rhs: Self) -> Self

Performs the % operation.

impl Sub for Angle

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl ZDiv for Angle

fn z_div(self, _z: f32) -> Self

impl Copy for Angle

impl StructuralPartialEq for Angle