Struct cogs_gamedev::grids::coords::ICoord

pub struct ICoord {
    pub x: isize,
    pub y: isize,
}

Signed-int coordinates

Fields

x: isize

y: isize

Implementations

impl ICoord

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

Create a new ICoord

pub fn quadrant(self) -> usize

Return the quadrant this coordinate is in.

• 1: +X, +Y
• 2: -X, +Y
• 3: -X, -Y
• 4: +X, -Y

Zeroes are treated as positive.

assert_eq!(ICoord::new(4, 5).quadrant(), 1);
assert_eq!(ICoord::new(-3, -2).quadrant(), 3);
// Zero is treated as positive
assert_eq!(ICoord::new(0, -8).quadrant(), 4);
assert_eq!(ICoord::new(0, 0).quadrant(), 1);

pub fn to_coord(self) -> Option<Coord>

Try to convert this to a Coord. Returns None in case any part is negative.

pub fn neighbors4(self) -> [ICoord; 4]

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.

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

let origin = ICoord::new(-7, -12);
assert_eq!(
    origin.neighbors4()[..],
    Direction4::DIRECTIONS.iter().map(|dir| origin + *dir).collect::<Vec<_>>()[..],
);

pub fn neighbors8(self) -> [ICoord; 8]

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.

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

let origin = ICoord::new(-7, -12);
assert_eq!(
    origin.neighbors8()[..],
    Direction8::DIRECTIONS.iter().map(|dir| origin + *dir).collect::<Vec<_>>()[..],
);

Trait Implementations

impl Add<Direction4> for ICoord

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<Direction8> for ICoord

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<ICoord> for ICoord

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Add<ICoord> for IRect

type Output = IRect

The resulting type after applying the + operator.

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

Performs the + operation.

impl AddAssign<Direction4> for ICoord

fn add_assign(&mut self, rhs: Direction4)

Performs the += operation.

impl AddAssign<Direction8> for ICoord

fn add_assign(&mut self, rhs: Direction8)

Performs the += operation.

impl AddAssign<ICoord> for ICoord

fn add_assign(&mut self, rhs: Self)

Performs the += operation.

impl Clone for ICoord

fn clone(&self) -> ICoord

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ICoord

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

Formats the value using the given formatter.

impl Display for ICoord

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 ICoord

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<isize> for ICoord

type Output = Self

The resulting type after applying the * operator.

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

Performs the * operation.

impl MulAssign<isize> for ICoord

fn mul_assign(&mut self, rhs: isize)

Performs the *= operation.

impl PartialEq<ICoord> for ICoord

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

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

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

impl Eq for ICoord

impl StructuralEq for ICoord

impl StructuralPartialEq for ICoord