Struct geng::prelude::Angle

pub struct Angle<T = f32>
where
    T: Float,
{ /* private fields */ }

This struct represents an angle in 2d space,

Implementations

impl<T> Angle<T>

where T: Float,

pub const ZERO: Angle<T> = _

0 angle is pointing to positive x axis

pub fn map<U>(&self, f: impl Fn(T) -> U) -> Angle<U>

where U: Float,

Map inner value to a different type

pub fn acos(cos: T) -> Angle<T>

Computes the arccosine of a number as an angle.

Return value is in radians in the range [0, pi] or NaN if the number is outside the range [-1, 1].

pub fn asin(sin: T) -> Angle<T>

Computes the arcsine of a number as an angle.

Return value is in radians in the range [-pi/2, pi/2] or NaN if the number is outside the range [-1, 1].

pub fn atan(tan: T) -> Angle<T>

Computes the arctangent of a number as an angle.

Return value is in radians in the range [-pi/2, pi/2];

pub fn atan2(y: T, x: T) -> Angle<T>

Computes the four quadrant arctangent of self (y) and other (x) as an angle.

• x = 0, y = 0: 0
• x >= 0: arctan(y/x) -> [-pi/2, pi/2]
• y >= 0: arctan(y/x) + pi -> (pi/2, pi]
• y < 0: arctan(y/x) - pi -> (-pi, -pi/2)

pub fn sin(&self) -> T

Compute the sine

pub fn cos(&self) -> T

Compute the cosine

pub fn sin_cos(&self) -> (T, T)

Simultaneously computes the sine and cosine of the angle. Returns (sin(self), cos(self)).

pub fn tan(self) -> T

Computes the tangent of the angle.

pub fn from_radians(radians: T) -> Angle<T>

Create angle from value in radians

pub fn from_degrees(degrees: T) -> Angle<T>

Create angle from value in degrees

pub fn as_radians(&self) -> T

See angle value as radians

pub fn as_degrees(&self) -> T

See angle value as degrees

pub fn normalized_2pi(&self) -> Angle<T>

Normalize the angle to be in range 0..2*pi.

pub fn abs(&self) -> Angle<T>

Calculate absolute value

pub fn normalized_pi(&self) -> Angle<T>

Normalize the angle to be in range -pi..pi.

pub fn angle_from(&self, from: Angle<T>) -> Angle<T>

Calculates the angle between from and self in range -pi..pi.

pub fn angle_to(&self, target: Angle<T>) -> Angle<T>

Calculates the angle between self and target in range -pi..pi.

pub fn unit_vec(&self) -> vec2<T>

Returns a direction vector of unit length.

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, rhs: Angle<T>) -> <Angle<T> as Add>::Output

Performs the + operation.

impl<T> AddAssign for Angle<T>

where T: Float,

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

Performs the += operation.

impl<T> Clone for Angle<T>

where T: Clone + Float,

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> Debug for Angle<T>

where T: Debug + Float,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for Angle<T>

where T: Float + Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<Angle<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Distribution<Angle<T>> for Standard

where T: Float,

fn sample<R>(&self, rng: &mut R) -> Angle<T>

where R: Rng + ?Sized,

Generate a random value of T, using rng as the source of randomness.

fn sample_iter<R>(self, rng: R) -> DistIter<Self, R, T>

where R: Rng, Self: Sized,

Create an iterator that generates random values of T, using rng as the source of randomness.

fn map<F, S>(self, func: F) -> DistMap<Self, F, T, S>

where F: Fn(T) -> S, Self: Sized,

Create a distribution of values of ‘S’ by mapping the output of Self through the closure F

impl<T> Div<T> for Angle<T>

where T: Float,

type Output = Angle<T>

The resulting type after applying the / operator.

fn div(self, rhs: T) -> <Angle<T> as Div<T>>::Output

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, rhs: T) -> <Angle<T> as Mul<T>>::Output

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> as Neg>::Output

Performs the unary - operation.

impl<T> Ord for Angle<T>

where T: Ord + Float,

fn cmp(&self, other: &Angle<T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl<T> PartialEq for Angle<T>

where T: PartialEq + Float,

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

where T: PartialOrd + Float,

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

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

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

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

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

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

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

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

impl<T> Serialize for Angle<T>

where T: Float + Serialize,

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Sub for Angle<T>

where T: Float,

type Output = Angle<T>

The resulting type after applying the - operator.

fn sub(self, rhs: Angle<T>) -> <Angle<T> as Sub>::Output

Performs the - operation.

impl<T> SubAssign for Angle<T>

where T: Float,

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

Performs the -= operation.

impl<T> Copy for Angle<T>

where T: Copy + Float,

impl<T> Eq for Angle<T>

where T: Eq + Float,

impl<T> StructuralEq for Angle<T>

where T: Float,

impl<T> StructuralPartialEq for Angle<T>

where T: Float,