Struct geom::Angle

pub struct Angle(f64);

An angle, stored in radians.

Implementations

impl Angle

pub const ZERO: Angle

pub fn new_rads(rads: f64) -> Angle

Create an angle in radians.

pub fn degrees(degs: f64) -> Angle

Create an angle in degrees.

pub fn opposite(self) -> Angle

Invert the direction of this angle.

pub(crate) fn invert_y(self) -> Angle

pub fn rotate_degs(self, degrees: f64) -> Angle

Rotates this angle by some degrees.

pub fn normalized_radians(self) -> f64

Returns [0, 2pi)

pub fn normalized_degrees(self) -> f64

Returns [0, 360)

pub fn simple_shortest_rotation_towards(self, other: Angle) -> f64

Returns [-180, 180]

pub fn shortest_rotation_towards(self, other: Angle) -> Angle

Logically this returns [-180, 180], but keep in mind when we print this angle, it'll normalize to be [0, 360].

pub fn approx_eq(self, other: Angle, within_degrees: f64) -> bool

True if this angle is within some degrees of another, accounting for rotation

pub fn reorient(self) -> Angle

I don't know how to describe what this does. Use for rotating labels in map-space and making sure the text is never upside-down.

Trait Implementations

impl Add<Angle> for Angle

type Output = Angle

The resulting type after applying the + operator.

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

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

impl Debug for Angle

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Angle

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

Formats the value using the given formatter.

impl Div<f64> for Angle

type Output = Angle

The resulting type after applying the / operator.

fn div(self, scalar: f64) -> Angle

Performs the / operation.

impl Neg for Angle

type Output = Angle

The resulting type after applying the - operator.

fn neg(self) -> Angle

Performs the unary - operation.

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

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Angle

impl Sum<Angle> for Angle

fn sum<I>(iter: I) -> Angle where
    I: Iterator<Item = Angle>, 

Method which takes an iterator and generates Self from the elements by "summing up" the items.