Struct radiant_utils::maths::Angle

pub struct Angle<T = f32>(pub T);

An Angle between -PI and PI.

Methods

impl<T> Angle<T> where
    T: Float, 

pub fn to_radians(&self) -> T

Returns the angle's value in radians.

pub fn to_degrees(&self) -> T

Returns the angle's value in degrees.

pub fn to_vec2(&self) -> Vec2<T>

Returns a vector pointing in the direction of the angle.

pub fn from_radians(radians: T) -> Self

Creates an angle from a radians value.

pub fn from_degrees(degrees: T) -> Self

Creates an angle from a degrees value.

pub fn normalize(&self) -> Self

Returns a normalized version of the angle.

pub fn diff(&self, other: Self) -> Self

Returns smallest directional angle between self and target.

Important traits for &'a mut W

impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn align_with(&mut self, target: Self) -> &mut Self

Mutates self so that subtracting the target will yield the smallest directional angle between self and target.

Trait Implementations

impl<T: Copy> Copy for Angle<T>

impl<T: Clone> Clone for Angle<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: PartialEq> PartialEq for Angle<T>

fn eq(&self, __arg_0: &Angle<T>) -> bool

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

fn ne(&self, __arg_0: &Angle<T>) -> bool

This method tests for !=.

impl<T: PartialOrd> PartialOrd for Angle<T>

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

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

fn lt(&self, __arg_0: &Angle<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, __arg_0: &Angle<T>) -> bool

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

fn gt(&self, __arg_0: &Angle<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, __arg_0: &Angle<T>) -> bool

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

impl<T> From<T> for Angle<T> where
    T: Float, 

fn from(other: T) -> Angle<T>

Performs the conversion.

impl From<Angle<f64>> for f64

fn from(other: Angle<f64>) -> f64

Performs the conversion.

impl From<Angle<f32>> for f32

fn from(other: Angle<f32>) -> f32

Performs the conversion.

impl<'a> From<&'a Angle<f64>> for f64

fn from(other: &'a Angle<f64>) -> f64

Performs the conversion.

impl<'a> From<&'a Angle<f32>> for f32

fn from(other: &'a Angle<f32>) -> f32

Performs the conversion.

impl<T> Default for Angle<T> where
    T: Float, 

fn default() -> Self

Returns the "default value" for a type.

impl<T> ToPrimitive for Angle<T> where
    T: Float, 

fn to_f64(&self) -> Option<f64>

Converts the value of self to an f64.

fn to_f32(&self) -> Option<f32>

Converts the value of self to an f32.

fn to_i64(&self) -> Option<i64>

Converts the value of self to an i64.

fn to_u64(&self) -> Option<u64>

Converts the value of self to an u64.

fn to_isize(&self) -> Option<isize>

Converts the value of self to an isize.

fn to_i8(&self) -> Option<i8>

Converts the value of self to an i8.

fn to_i16(&self) -> Option<i16>

Converts the value of self to an i16.

fn to_i32(&self) -> Option<i32>

Converts the value of self to an i32.

fn to_usize(&self) -> Option<usize>

Converts the value of self to a usize.

fn to_u8(&self) -> Option<u8>

Converts the value of self to an u8.

fn to_u16(&self) -> Option<u16>

Converts the value of self to an u16.

fn to_u32(&self) -> Option<u32>

Converts the value of self to an u32.

impl<T> FromPrimitive for Angle<T> where
    T: Float, 

fn from_f64(n: f64) -> Option<Angle<T>>

Convert a f64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_f32(n: f32) -> Option<Angle<T>>

Convert a f32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i64(n: i64) -> Option<Angle<T>>

Convert an i64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u64(n: u64) -> Option<Angle<T>>

Convert an u64 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_isize(n: isize) -> Option<Self>

Convert an isize to return an optional value of this type. If the value cannot be represented by this value, the None is returned.

fn from_i8(n: i8) -> Option<Self>

Convert an i8 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i16(n: i16) -> Option<Self>

Convert an i16 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_i32(n: i32) -> Option<Self>

Convert an i32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_usize(n: usize) -> Option<Self>

Convert a usize to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u8(n: u8) -> Option<Self>

Convert an u8 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u16(n: u16) -> Option<Self>

Convert an u16 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

fn from_u32(n: u32) -> Option<Self>

Convert an u32 to return an optional value of this type. If the type cannot be represented by this value, the None is returned.

impl<T> Neg for Angle<T> where
    T: Float, 

type Output = Angle<T>

The resulting type after applying the - operator.

fn neg(self) -> Angle<T>

Performs the unary - operation.

impl<T> Add for Angle<T> where
    T: Float, 

type Output = Angle<T>

The resulting type after applying the + operator.

fn add(self, other: Angle<T>) -> Angle<T>

Performs the + operation.

impl<T> AddAssign for Angle<T> where
    T: Float, 

fn add_assign(&mut self, other: Angle<T>)

Performs the += operation.

impl<T> Sub for Angle<T> where
    T: Float, 

type Output = Angle<T>

The resulting type after applying the - operator.

fn sub(self, other: Angle<T>) -> Angle<T>

Performs the - operation.

impl<T> SubAssign for Angle<T> where
    T: Float, 

fn sub_assign(&mut self, other: Angle<T>)

Performs the -= operation.

impl<T> Mul<Angle<T>> for Angle<T> where
    T: Float, 

type Output = Angle<T>

The resulting type after applying the * operator.

fn mul(self, other: Angle<T>) -> Angle<T>

Performs the * operation.

impl<T> MulAssign for Angle<T> where
    T: Float, 

fn mul_assign(&mut self, other: Angle<T>)

Performs the *= operation.

impl<T> Mul<T> for Angle<T> where
    T: Float, 

type Output = Angle<T>

The resulting type after applying the * operator.

fn mul(self, other: T) -> Angle<T>

Performs the * operation.

impl<T> Div<Angle<T>> for Angle<T> where
    T: Float, 

type Output = Angle<T>

The resulting type after applying the / operator.

fn div(self, other: Angle<T>) -> Angle<T>

Performs the / operation.

impl<T> DivAssign for Angle<T> where
    T: Float, 

fn div_assign(&mut self, other: Angle<T>)

Performs the /= operation.

impl<T> Div<T> for Angle<T> where
    T: Float, 

type Output = Angle<T>

The resulting type after applying the / operator.

fn div(self, other: T) -> Angle<T>

Performs the / operation.

impl AsUniform for Angle<f32>

fn as_uniform(&self) -> Uniform

impl AsUniform for Angle<f64>

fn as_uniform(&self) -> Uniform

impl<T> Debug for Angle<T> where
    T: Debug + Float, 

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

Formats the value using the given formatter.