Enum Cardinal

pub enum Cardinal {
    East,
    North,
    West,
    South,
}

An enumerator for the simple cardinal directions.

Variants

East

East, or (1, 0)

North

North, or (0, 1)

West

West, or (-1, 0)

South

South, or (0, -1)

Implementations

impl Cardinal

pub fn rotate(self, amount: i32) -> Self

Rotates a cardinal.

pub fn iter_values() -> impl Iterator<Item = Self>

Gives an iterator over the four cardinals

pub fn to_ivec2(self) -> (i32, i32)

Converts to a simple tuple int form. This assumes that north is up.

pub fn to_angle(self) -> f32

Returns an angle representing the Cardinal

pub fn from_angle(angle: f32) -> Cardinal

This returns a cardinal as a best guess for floats. If you give an exactly divisible by 90 degrees, it’ll work just the way you expect.

pub fn is_horizontal(self) -> bool

Is either West or East

pub fn is_vertical(self) -> bool

Is either North or South

Trait Implementations

impl Clone for Cardinal

fn clone(&self) -> Cardinal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cardinal

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

Formats the value using the given formatter.

impl Display for Cardinal

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

Formats the value using the given formatter.

impl<T> Index<Cardinal> for CardinalValues<T>

type Output = T

The returned type after indexing.

fn index(&self, index: Cardinal) -> &Self::Output

Performs the indexing (container[index]) operation.

impl Ord for Cardinal

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

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

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

impl Eq for Cardinal

impl StructuralPartialEq for Cardinal