Enum AngleDirection

#[repr(i8)]
pub enum AngleDirection {
    Positive = 1,
    Negative = -1,
    Undefined = 0,
}

The direction of rotation of an angle.

In mathematics and most graphics programming contexts, the default direction for angle measurements is counterclockwise from a defined zero point (usually the positive x-axis). This convention applies to both 2D and 3D coordinate systems where:

• A positive angle represents a counterclockwise rotation.
• A negative angle represents a clockwise rotation.

It aligns with the right-hand rule used in mathematics, physics, and engineering.

Variants

Positive = 1

By convention, positive angles represent a counterclockwise rotation.

Also known as the Right-Handed Rule.

This is the default direction of rotation.

Negative = -1

By convention, negative angles represent a clockwise rotation.

Also known as the Left-Hand Rule.

Undefined = 0

An undefined direction can occur when a full-turn angle is normalized to an unsigned 0, such as when working with primitive signed integers.

Implementations

impl AngleDirection

pub const CounterClockwise: AngleDirection = AngleDirection::Positive

Alias of positive angle direction.

pub const CCW: AngleDirection = AngleDirection::Positive

pub const RightHandRule: AngleDirection = AngleDirection::Positive

pub const RHR: AngleDirection = AngleDirection::Positive

pub const Clockwise: AngleDirection = AngleDirection::Negative

Alias of negative angle direction.

pub const CW: AngleDirection = AngleDirection::Negative

pub const LeftHandRule: AngleDirection = AngleDirection::Positive

pub const LHR: AngleDirection = AngleDirection::Positive

Trait Implementations

impl Clone for AngleDirection

fn clone(&self) -> AngleDirection

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AngleDirection

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

Formats the value using the given formatter.

impl Default for AngleDirection

fn default() -> AngleDirection

Returns the “default value” for a type.

impl Hash for AngleDirection

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AngleDirection

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

Restrict a value to a certain interval.

impl PartialEq for AngleDirection

fn eq(&self, other: &AngleDirection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

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

impl PartialOrd for AngleDirection

fn partial_cmp(&self, other: &AngleDirection) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for AngleDirection

impl Eq for AngleDirection

impl StructuralPartialEq for AngleDirection