Enum Direction 

pub enum Direction {
    North,
    NorthEast,
    NorthWest,
    East,
    South,
    SouthEast,
    SouthWest,
    West,
}

A direction in the 2D plane.

Variants

North

NorthEast

NorthWest

East

South

SouthEast

SouthWest

West

Implementations

impl Direction

pub const CARDINAL: [Direction; 4]

pub const DIAGONAL: [Direction; 4]

pub const ALL: [Direction; 8]

pub fn iter_cardinal() -> impl Iterator<Item = Direction>

Iterate N, E, S, W directions.

pub fn iter_diagonal() -> impl Iterator<Item = Direction>

Iterate NE, NW, SE, SW directions.

pub fn iter() -> impl Iterator<Item = Direction>

Iterate all directions.

pub fn unit(&self) -> IVec2

Returns the unit vector for this direction.

pub fn move_ipoint(&self, point: IVec2, by: i32) -> IVec2

Move a point in this direction by the given amount.

pub fn move_upoint(&self, point: UVec2, by: u32) -> UVec2

Move a point in this direction by the given amount. Limits the lower bounds to zero.

pub fn is_cardinal(&self) -> bool

Returns true if this direction is cardinal (N, E, S, W).

pub fn is_diagonal(&self) -> bool

Returns true if this direction is diagonal (NE, NW, SE, SW).

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl PartialEq for Direction

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

impl Eq for Direction

impl StructuralPartialEq for Direction