Struct Angle 

pub struct Angle { /* private fields */ }

Radian representation of an angle.

Layout

The Angle struct is a wrapper around a single f32 value representing the angle in radians:

struct Angle {
    float radians;
};

Implementations

impl Angle

pub const fn from_radians(radians: f32) -> Self

Returns a new Angle using the given radians.

pub const fn from_degrees(degrees: f32) -> Self

Returns a new Angle using the given degrees.

pub const fn from_turns(turns: f32) -> Self

Returns a new Angle using the given turns.

pub const fn from_percentage(percentage: f32) -> Self

Returns a new Angle using the given percentage of a full circle.

pub const fn as_radians(self) -> f32

Returns the angle in radians.

pub const fn as_degrees(self) -> f32

Returns the angle in degrees.

pub const fn as_turns(self) -> f32

Returns the angle in turns.

pub const fn as_percentage(self) -> f32

Returns the angle as a percentage of a full circle.

pub const fn normalize(self) -> Self

The normalized angle within the range [0, 2π).

pub const fn abs(self) -> Self

The absolute angle, i.e. the angle with a positive sine.

Trait Implementations

impl<'a> Add<&'a Angle> for Angle

type Output = Angle

The resulting type after applying the + operator.

fn add(self, other: &'a Angle) -> Self::Output

Performs the + operation.

impl<'a> Add<Angle> for &'a Angle

type Output = Angle

The resulting type after applying the + operator.

fn add(self, other: Angle) -> Self::Output

Performs the + operation.

impl Add for &Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add for Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a> AddAssign<&'a Angle> for Angle

fn add_assign(&mut self, other: &'a Angle)

Performs the += operation.

impl AddAssign for Angle

fn add_assign(&mut self, other: Self)

Performs the += operation.

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<'a> Div<&'a Angle> for Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, other: &'a Angle) -> Self::Output

Performs the / operation.

impl<'a> Div<Angle> for &'a Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, other: Angle) -> Self::Output

Performs the / operation.

impl Div for &Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl Div for Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self::Output

Performs the / operation.

impl<'a> DivAssign<&'a Angle> for Angle

fn div_assign(&mut self, other: &'a Angle)

Performs the /= operation.

impl DivAssign for Angle

fn div_assign(&mut self, other: Self)

Performs the /= operation.

impl<'a> Mul<&'a Angle> for Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, other: &'a Angle) -> Self::Output

Performs the * operation.

impl<'a> Mul<Angle> for &'a Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, other: Angle) -> Self::Output

Performs the * operation.

impl Mul for &Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl Mul for Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self::Output

Performs the * operation.

impl<'a> MulAssign<&'a Angle> for Angle

fn mul_assign(&mut self, other: &'a Angle)

Performs the *= operation.

impl MulAssign for Angle

fn mul_assign(&mut self, other: Self)

Performs the *= operation.

impl Neg for &Angle

type Output = Angle

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Neg for Angle

type Output = Angle

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

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 PartialOrd for Angle

fn partial_cmp(&self, other: &Angle) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> Rem<&'a Angle> for Angle

type Output = Angle

The resulting type after applying the % operator.

fn rem(self, other: &'a Angle) -> Self::Output

Performs the % operation.

impl<'a> Rem<Angle> for &'a Angle

type Output = Angle

The resulting type after applying the % operator.

fn rem(self, other: Angle) -> Self::Output

Performs the % operation.

impl Rem for &Angle

type Output = Angle

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self::Output

Performs the % operation.

impl Rem for Angle

type Output = Angle

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self::Output

Performs the % operation.

impl<'a> RemAssign<&'a Angle> for Angle

fn rem_assign(&mut self, other: &'a Angle)

Performs the %= operation.

impl RemAssign for Angle

fn rem_assign(&mut self, other: Self)

Performs the %= operation.

impl<'a> Sub<&'a Angle> for Angle

type Output = Angle

The resulting type after applying the - operator.

fn sub(self, other: &'a Angle) -> Self::Output

Performs the - operation.

impl<'a> Sub<Angle> for &'a Angle

type Output = Angle

The resulting type after applying the - operator.

fn sub(self, other: Angle) -> Self::Output

Performs the - operation.

impl Sub for &Angle

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub for Angle

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a> SubAssign<&'a Angle> for Angle

fn sub_assign(&mut self, other: &'a Angle)

Performs the -= operation.

impl SubAssign for Angle

fn sub_assign(&mut self, other: Self)

Performs the -= operation.

impl Copy for Angle

impl StructuralPartialEq for Angle