Struct Angle

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

Angular position.

Implementations

impl Angle

pub const ZERO: Self

Angle representing zero rotation.

pub const QUARTER_TURN: Self

Angle representing a quarter turn around a full circle.

pub const HALF_TURN: Self

Angle representing a half turn around a full circle.

pub const FULL_TURN: Self

Angle representing a full turn around a circle.

pub const MIN: Self

Smallest value that can be represented by the Angle type.

Equivalent to f64::MIN radians.

pub const MAX: Self

Largest value that can be represented by the Angle type.

Equivalent to f64::MAX radians.

pub const EPSILON: Self

Machine epsilon value for Angle.

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

Creates a new Angle from a value in radians.

pub const fn from_gradians(gradians: f64) -> Self

Creates a new Angle from a value in gradians.

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

Creates a new Angle from a value in degrees.

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

Creates a new Angle from a value in turns (revolutions).

pub fn asin(y: f64) -> Self

Computes the arcsine of a number. Return value is in the range [-pi/2, pi/2] or NaN if the angle is outside the range [-1, 1].

pub fn acos(x: f64) -> Self

Computes the arccosine of a number. Return value is in the range [0, pi] or NaN if the number is outside the range [-1, 1].

pub fn atan(tan: f64) -> Self

Computes the arctangent of an angle. Return value is in radians in the range [-pi/2, pi/2];

pub fn atan2(y: f64, x: f64) -> Self

Computes the four quadrant arctangent angle of y and x.

pub const fn as_degrees(&self) -> f64

Returns this angle’s value in degrees.

pub fn as_turns(&self) -> f64

Returns this angle’s value in turns (revolution).

pub const fn as_radians(&self) -> f64

Returns this angle’s value in radians.

pub const fn as_gradians(&self) -> f64

Returns this angle’s value in gradians.

pub fn wrapped(&self) -> Self

Normalizes an angle to the bounds [-pi, pi].

pub fn wrapped_positive(&self) -> Self

Normalizes an angle to the bounds [0, 2pi].

pub const fn abs(self) -> Self

Computes the absolute value of self.

pub const fn signum(self) -> f64

Returns a number that represents the sign of self.

• 1.0 if the number is positive, +0.0 or INFINITY
• -1.0 if the number is negative, -0.0 or NEG_INFINITY
• NaN if the number is NaN

pub const fn copysign(self, sign: Self) -> Self

Returns an angle composed of the magnitude of self and the sign of sign.

Equal to self if the sign of self and sign are the same, otherwise equal to -self. If self is a NaN, then a NaN with the same payload as self and the sign bit of sign is returned.

If sign is a NaN, then this operation will still carry over its sign into the result. Note that IEEE 754 doesn’t assign any meaning to the sign bit in case of a NaN, and as Rust doesn’t guarantee that the bit pattern of NaNs are conserved over arithmetic operations, the result of copysign with sign being a NaN might produce an unexpected or non-portable result. See the specification of NaN bit patterns for more info.

pub fn mul_add(self, a: Self, b: Self) -> Self

Fused multiply-add. Computes (self * a) + b with only one rounding error, yielding a more accurate result than an unfused multiply-add.

Using mul_add may be more performant than an unfused multiply-add if the target architecture has a dedicated fma CPU instruction. However, this is not always true, and will be heavily dependant on designing algorithms with specific target hardware in mind.

pub fn div_euclid(self, rhs: Self) -> Self

Calculates Euclidean division.

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

The positive difference of two numbers.

• If self <= other: 0.0
• Else: self - other

pub fn sin(self) -> f64

Computes the sine of an angle.

pub fn cos(self) -> f64

Computes the cosine of an angle.

pub fn tan(self) -> f64

Computes the tangent of an angle.

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

Simultaneously computes the sine and cosine of the number, x. Returns (sin(x), cos(x)).

Trait Implementations

impl Add for Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign for Angle

fn add_assign(&mut self, rhs: 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 Div<f64> for Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, rhs: f64) -> Self::Output

Performs the / operation.

impl DivAssign<f64> for Angle

fn div_assign(&mut self, rhs: f64)

Performs the /= operation.

impl From<Position> for Angle

fn from(value: Position) -> Self

Converts to this type from the input type.

impl Mul<f64> for Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, rhs: f64) -> Self::Output

Performs the * operation.

impl MulAssign<f64> for Angle

fn mul_assign(&mut self, rhs: f64)

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

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Angle

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Angle

impl StructuralPartialEq for Angle