Struct figures::Angle

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

An measurement of distance between two rays sharing a common endpoint, in degrees.

Angle::degrees(1) is equivalent to 1/360th of a full rotation. This type is commonly used to represent the amount of rotation to perform.

Internally, this type ensures that the angle represented using a Fraction is always within the range of 0..=360° (degrees). This ensures that comparing two angles is efficient and deterministic.

use figures::Angle;

assert_eq!(Angle::degrees(-90).into_degrees::<f32>(), 270.);
assert_eq!(Angle::degrees(-90), Angle::degrees(270));

Because this type uses a Fraction internally, it will perform integer math on integer types. The order of operations may impact the amount of precision the final result contains.

Working with Radians

Because π is an irrational number, this type internally uses degrees for representation. Angles represented in radians can be converted using Angle::radians/Angle::radians_f.

Implementations

impl Angle

pub const fn degrees(degrees: i16) -> Self

Returns an angle for degrees, where 360 degrees is equal to one full rotation.

The value will be normalized to the range of 0..360.

pub fn degrees_fraction(degrees: Fraction) -> Self

Returns an angle for radians, where 2π is equal to one full rotation.

The value will be normalized to the range of 0..2π.

pub fn degrees_f(degrees: f32) -> Self

Returns an angle for degrees, where 360 degrees is equal to one full rotation.

The value will be normalized to the range of 0..360.

pub fn radians(radians: Fraction) -> Self

Returns an angle for radians, where 2π is equal to one full rotation.

The value will be normalized to the range of 0..2π.

pub fn radians_f(radians: f32) -> Self

Returns an angle for radians, where 2π is equal to one full rotation.

The value will be normalized to the range of 0..2π.

pub fn into_raidans<Representation>(self) -> Representation

where Representation: From<Fraction>,

Returns this angle as represented in radians, where 2π is equal to one full rotation.

pub fn into_raidans_f(self) -> f32

Returns this angle as represented in radians, where 2π is equal to one full rotation.

pub fn into_degrees<Representation>(self) -> Representation

where Representation: From<Fraction>,

Returns this angle as represented in degrees, where 360 degrees is equal to one full rotation.

pub fn sin(&self) -> Fraction

Calculates the sine of this angle.

pub fn cos(&self) -> Fraction

Calculates the cosine of this angle.

pub fn tan(&self) -> Fraction

Calculates the tangent of this angle.

Trait Implementations

impl Add<f32> for Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<i16> for Angle

type Output = Angle

The resulting type after applying the + operator.

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

Performs the + operation.

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

fn add_assign(&mut self, rhs: f32)

Performs the += operation.

impl AddAssign<i16> for Angle

fn add_assign(&mut self, rhs: i16)

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 copy 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 Display for Angle

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

Formats the value using the given formatter.

impl Div<f32> for Angle

type Output = Angle

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div<i16> for Angle

type Output = Angle

The resulting type after applying the / operator.

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

Performs the / operation.

impl Div for Angle

type Output = Angle

The resulting type after applying the / operator.

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

Performs the / operation.

impl DivAssign<f32> for Angle

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl DivAssign<i16> for Angle

fn div_assign(&mut self, rhs: i16)

Performs the /= operation.

impl DivAssign for Angle

fn div_assign(&mut self, rhs: Self)

Performs the /= operation.

impl From<Fraction> for Angle

fn from(value: Fraction) -> Self

Converts to this type from the input type.

impl From<f32> for Angle

fn from(value: f32) -> Self

Converts to this type from the input type.

impl From<i16> for Angle

fn from(value: i16) -> Self

Converts to this type from the input type.

impl Mul<Duration> for Angle

type Output = Angle

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<f32> for Angle

type Output = Angle

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul<i16> for Angle

type Output = Angle

The resulting type after applying the * operator.

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

Performs the * operation.

impl Mul for Angle

type Output = Angle

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<f32> for Angle

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl MulAssign<i16> for Angle

fn mul_assign(&mut self, rhs: i16)

Performs the *= operation.

impl MulAssign for Angle

fn mul_assign(&mut self, rhs: 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 Ord for Angle

fn cmp(&self, other: &Angle) -> 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 PartialEq for Angle

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

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

const MAX: Self = _

The maximum value for this type.

const MIN: Self = Self::ZERO

The minimum value for this type.

impl Sub<f32> for Angle

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl Sub<i16> for Angle

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

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

fn sub_assign(&mut self, rhs: f32)

Performs the -= operation.

impl SubAssign<i16> for Angle

fn sub_assign(&mut self, rhs: i16)

Performs the -= operation.

impl SubAssign for Angle

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Zero for Angle

const ZERO: Self = _

The zero value for this type.

fn is_zero(&self) -> bool

Returns true if self represents 0.

impl Copy for Angle

impl Eq for Angle

impl StructuralPartialEq for Angle