Trait Angle

Source

pub trait Angle:
    Clone
    + FromAngle<Self>
    + PartialEq
    + PartialOrd
    + Zero {
    type Scalar: Float;

Show 19 methods    // Required methods
    fn new(value: Self::Scalar) -> Self;
    fn period() -> Self::Scalar;
    fn scalar(&self) -> Self::Scalar;
    fn set_scalar(&mut self, value: Self::Scalar);
    fn normalize(self) -> Self;
    fn is_normalized(&self) -> bool;
    fn sin(self) -> Self::Scalar;
    fn cos(self) -> Self::Scalar;
    fn tan(self) -> Self::Scalar;
    fn sin_cos(self) -> (Self::Scalar, Self::Scalar);
    fn asin(value: Self::Scalar) -> Self;
    fn acos(value: Self::Scalar) -> Self;
    fn atan(value: Self::Scalar) -> Self;
    fn atan2(x: Self::Scalar, y: Self::Scalar) -> Self;
    fn full_turn() -> Self;
    fn half_turn() -> Self;
    fn quarter_turn() -> Self;
    fn invert(self) -> Self;
    fn reflect_x(self) -> Self;
}

Expand description

Base functionality for all angle types.

Required Associated Types§

Source

type Scalar: Float

Internal type storing the angle value.

Required Methods§

Source

fn new(value: Self::Scalar) -> Self

Construct a new angle.

Equivalent to constructing the tuple struct directly, eg. Deg(value), but usable in a generic context.

Source

fn period() -> Self::Scalar

The length of a full rotation.

Source

fn scalar(&self) -> Self::Scalar

Return the scalar (unitless) value.

Equivalent to self.0 or to doing let Deg(val) = self

Source

fn set_scalar(&mut self, value: Self::Scalar)

Set the internal scalar value of the angle.

Source

fn normalize(self) -> Self

Normalize the angle, wrapping it back into the standard domain.

After normalization, an angle will be in the range [0, self.period()).

For performance reasons, normalization does not happen automatically during most operations. Thus, when passing an angle to a method that expects it to be within the standard domain, first normalize the angle.

Source