Struct cogs_gamedev::grids::coords::Coord

pub struct Coord {
    pub x: usize,
    pub y: usize,
}

Unsigned-int coordinates

Fields

x: usize

y: usize

Implementations

impl Coord

pub fn new(x: usize, y: usize) -> Self

Make a new coord.

pub fn to_2d_idx(self, width: usize) -> usize

Get this as an index into an array representing a 2d array.

(AKA, y * width + x.)

pub fn to_icoord(self) -> ICoord

Convert this into an ICoord.

pub fn neighbors4(self) -> Vec<Coord>

Get a list of this coordinate’s orthagonal neighbors. They are given in clockwise order starting with the neighbor to the north, as if each of Direction4::DIRECTIONS had been added to them.

If a neighbor is out of bounds, it is skipped in the output.

There may be 2, 3, or 4 neighbors:

• 2 if this is at (0, 0)
• 3 if this is on an edge (x or y are 0)
• 4 otherwise.

assert_eq!(
    Coord::new(5, 7).neighbors4(),
    &[
        Coord::new(5, 6),
        Coord::new(6, 7),
        Coord::new(5, 8),
        Coord::new(4, 7),
    ]
);

// May return fewer than 4 neighbors
assert_eq!(
    Coord::new(0, 5).neighbors4(),
    &[
        Coord::new(0, 4),
        Coord::new(1, 5),
        Coord::new(0, 6),
        // Skip (-1, 5) for being out of bounds
    ]
);

pub fn neighbors8(self) -> Vec<Coord>

Get a list of this coordinate’s orthagonal and diagonal neighbors. They are given in clockwise order starting with the neighbor to the north, as if each of Direction8::DIRECTIONS had been added to them.

If a neighbor is out of bounds, it is skipped in the output.

There may be 3, 5, or 8 neighbors:

• 3 if this is at (0, 0)
• 5 if this is on an edge (x or y are 0)
• 8 otherwise.

assert_eq!(
    Coord::new(5, 7).neighbors8(),
    [
        Coord::new(5, 6),
        Coord::new(6, 6),
        Coord::new(6, 7),
        Coord::new(6, 8),
        Coord::new(5, 8),
        Coord::new(4, 8),
        Coord::new(4, 7),
        Coord::new(4, 6),
    ]
);

// May return fewer than 8 neighbors
assert_eq!(
    Coord::new(0, 5).neighbors8(),
    &[
        Coord::new(0, 4),
        Coord::new(1, 4),
        Coord::new(1, 5),
        Coord::new(1, 6),
        Coord::new(0, 6),
        // Skip (-1, 6) for being out of bounds
        // Skip (-1, 5)
        // Skip (-1, 4)
    ]
);

Trait Implementations

impl Add<Coord> for Coord

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl AddAssign<Coord> for Coord

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for Coord

fn clone(&self) -> Coord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Coord

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

Formats the value using the given formatter.

impl Display for Coord

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

Formats the value using the given formatter.

impl From<Coord> for ICoord

fn from(value: Coord) -> Self

Performs the conversion.

impl Hash for Coord

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, 

Feeds a slice of this type into the given Hasher.

impl Mul<usize> for Coord

type Output = Self

The resulting type after applying the * operator.

fn mul(self, rhs: usize) -> Self::Output

Performs the * operation.

impl MulAssign<usize> for Coord

fn mul_assign(&mut self, rhs: usize)

Performs the *= operation.

impl PartialEq<Coord> for Coord

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryFrom<ICoord> for Coord

Try to convert an ICoord to a Coord. Will return Error if the ICoord has any negatives in it.

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: ICoord) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Coord

impl Eq for Coord

impl StructuralEq for Coord

impl StructuralPartialEq for Coord