Struct Angle

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

An Angle between -PI and PI.

Tuple Fields

0: T

Implementations

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>

👎Deprecated since 0.2.2: use Vec2::from() instead

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.

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> 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: Clone> Clone for Angle<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Angle<T>

where T: Debug + Float,

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

Formats the value using the given formatter.

impl<T> Default for Angle<T>

where T: Float,

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<T> From<Angle<T>> for Vec2<T>

where T: Float,

fn from(angle: Angle<T>) -> Vec2<T>

Converts to this type from the input type.

impl From<Angle<f64>> for f64

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

Converts to this type from the input type.

impl From<Angle> for f32

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

Converts to this type from the input type.

impl<T> From<T> for Angle<T>

where T: Float,

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

Converts to this type from the input type.

impl<T> From<Vec2<T>> for Angle<T>

where T: Float,

fn from(vec: Vec2<T>) -> Angle<T>

Converts to this type from the input type.

impl<T> FromPrimitive for Angle<T>

where T: Float,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn from_i128(n: i128) -> Option<Self>

Converts an i128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

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

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

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

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

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

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

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

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

fn from_u128(n: u128) -> Option<Self>

Converts an u128 to return an optional value of this type. If the value cannot be represented by this type, then None is returned.

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> Mul 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> 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: PartialEq> PartialEq for Angle<T>

fn eq(&self, other: &Angle<T>) -> 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<T: PartialOrd> PartialOrd for Angle<T>

fn partial_cmp(&self, other: &Angle<T>) -> 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<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> ToPrimitive for Angle<T>

where T: Float,

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

Converts the value of self to an f64. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f64.

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

Converts the value of self to an f32. Overflows may map to positive or negative inifinity, otherwise None is returned if the value cannot be represented by an f32.

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

Converts the value of self to an i64. If the value cannot be represented by an i64, then None is returned.

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

Converts the value of self to a u64. If the value cannot be represented by a u64, then None is returned.

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

Converts the value of self to an isize. If the value cannot be represented by an isize, then None is returned.

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

Converts the value of self to an i8. If the value cannot be represented by an i8, then None is returned.

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

Converts the value of self to an i16. If the value cannot be represented by an i16, then None is returned.

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

Converts the value of self to an i32. If the value cannot be represented by an i32, then None is returned.

fn to_i128(&self) -> Option<i128>

Converts the value of self to an i128. If the value cannot be represented by an i128 (i64 under the default implementation), then None is returned.

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

Converts the value of self to a usize. If the value cannot be represented by a usize, then None is returned.

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

Converts the value of self to a u8. If the value cannot be represented by a u8, then None is returned.

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

Converts the value of self to a u16. If the value cannot be represented by a u16, then None is returned.

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

Converts the value of self to a u32. If the value cannot be represented by a u32, then None is returned.

fn to_u128(&self) -> Option<u128>

Converts the value of self to a u128. If the value cannot be represented by a u128 (u64 under the default implementation), then None is returned.

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

impl<T> StructuralPartialEq for Angle<T>