Struct gramit::angle::Angle

#[repr(transparent)]
pub struct Angle { /* fields omitted */ }

An angle struct independent of representation as either degrees or radians.

Methods

impl Angle

pub fn zero() -> Angle

Construct an Angle of zero.

pub fn full_circle() -> Angle

Construct an Angle of 360 degrees (2*PI radians).

pub fn half_circle() -> Angle

Construct an Angle of 180 degrees (PI radians).

pub fn from_radians(radians: f32) -> Angle

Construct an Angle from a value given in radians.

pub fn from_degrees(degrees: f32) -> Angle

Constuct an Angle from a value given in degrees.

pub fn radians(self) -> f32

Get the value of this Angle in radians.

pub fn degrees(self) -> f32

Get the value of this Angle in degrees.

pub fn sin(self) -> f32

Get the sine of this Angle.

pub fn cos(self) -> f32

Get the cosine of this Angle.

pub fn tan(self) -> f32

Get the tangent of this Angle.

pub fn asin(x: f32) -> Option<Angle>

Compute the arc sine of the given value.

For values in the range [-1, 1], produces an Angle in the range [-pi/2, pi/2] (radians). For other values, produces None.

pub fn acos(x: f32) -> Option<Angle>

Compute the arc cosine of the given value.

For values in the range [-1, 1], produces an Angle in the range [0, pi] (radians). For other values, produces None.

pub fn atan(x: f32) -> Angle

Compute the arc tangent of the given value.

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

Compute the four-quadrant arc tangent of y and x.

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

Simultaneously compute the sine and cosine of this Angle. Returns (sin(x), cos(x)).

Trait Implementations

impl ApproxEq<Angle> for Angle

fn approx_eq(self, rhs: Angle) -> bool

Compare two values for approximate equality, using a default difference treshold.

fn within_threshold(self, rhs: Angle, threshold: Angle) -> bool

Compare two values for approximate equality, using a user-defined difference threshold.

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

impl Default for Angle

fn default() -> Angle

Construct a zero Angle.

impl PartialEq<Angle> 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: &Angle) -> bool

This method tests for !=.

impl PartialOrd<Angle> 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: &Angle) -> bool

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

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

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

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

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

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

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

impl Debug 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) -> Angle

Performs the / operation.

impl Sub<Angle> for Angle

type Output = Angle

The resulting type after applying the - operator.

fn sub(self, rhs: Angle) -> Angle

Performs the - operation.

impl Add<Angle> for Angle

type Output = Angle

The resulting type after applying the + operator.

fn add(self, rhs: Angle) -> Angle

Performs the + operation.

impl Mul<f32> for Angle

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, rhs: f32) -> Angle

Performs the * operation.

impl Mul<Angle> for f32

type Output = Angle

The resulting type after applying the * operator.

fn mul(self, rhs: Angle) -> Angle

Performs the * operation.

impl AddAssign<Angle> for Angle

fn add_assign(&mut self, rhs: Angle)

Performs the += operation.

impl SubAssign<Angle> for Angle

fn sub_assign(&mut self, rhs: Angle)

Performs the -= operation.

impl MulAssign<f32> for Angle

fn mul_assign(&mut self, rhs: f32)

Performs the *= operation.

impl DivAssign<f32> for Angle

fn div_assign(&mut self, rhs: f32)

Performs the /= operation.

impl StructuralPartialEq for Angle