Enum sark_grids::directions::Dir8

pub enum Dir8 {
    Up,
    Down,
    Left,
    Right,
    UpLeft,
    UpRight,
    DownLeft,
    DownRight,
}

8 directions on a 2d grid.

Variants

Up

Down

Left

Right

UpLeft

UpRight

DownLeft

DownRight

Implementations

impl Dir8

pub fn from_point(p: impl GridPoint) -> Option<Dir8>

Retrieve the direction from the given point, or none if it’s (0,0).

pub fn from_index(i: usize) -> Option<Dir8>

Retrieve a direction from an index.

pub fn to_index(&self) -> usize

Convert a direction to it’s corresponding index.

Trait Implementations

impl Clone for Dir8

fn clone(&self) -> Dir8

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dir8

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

Formats the value using the given formatter.

impl From<Dir8> for IVec2

fn from(d: Dir8) -> Self

Converts to this type from the input type.

impl PartialEq for Dir8

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

impl Eq for Dir8

impl StructuralPartialEq for Dir8