Struct embedded_graphics::geometry::Angle

pub struct Angle(_);

Angle.

Angle is used to define the value of an angle.

Examples

Create an Angle from a value

use embedded_graphics::geometry::{Angle, AngleUnit};
use core::f32::consts::PI;

// Create an angle using the `from_degrees` constructor method
let angle_a = Angle::from_degrees(10.0);
let angle_b = Angle::from_radians(PI);

// Angles can also be created using the [AngleUnit] trait
let angle_c = 30.0.deg();
let angle_d = PI.rad();

Implementations

impl Angle

pub fn from_degrees(angle: f32) -> Self

Creates an angle defined in degrees.

pub fn from_radians(angle: f32) -> Self

Creates an angle defined in radians.

pub fn zero() -> Self

Creates a zero degree angle.

pub fn abs(self) -> Self

Compute the absolute value of the angle.

pub fn normalize(self) -> Self

Normalize the angle to less than one full rotation (ie. in the range 0..360).

pub fn to_degrees(self) -> f32

Return numerical value of the angle in degree

pub fn to_radians(self) -> f32

Return numerical value of the angle in radian

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

fn add_assign(&mut self, other: 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 Debug for Angle

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

Formats the value using the given formatter.

impl Format for Angle

fn format(&self, f: Formatter<'_>)

Writes the defmt representation of self to fmt.

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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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

type Output = Angle

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign<Angle> for Angle

fn sub_assign(&mut self, other: Angle)

Performs the -= operation.

impl Copy for Angle

impl StructuralPartialEq for Angle