Struct Point2D 

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

1D / 2D coordinate for GameBoard positions.

It can calculate it’s neighboring positions in context of underlying Tessellation and Size2D:

let size = Size2D::new(19, 11);

let position = Point2D::new(4, 2);
let neighbor: Option<Point2D> = position.neighbor(Tessellation::Hexoban, Direction::Left, size);

let position = Point2D::new(11, 8);
let neighbor: Option<Point2D> = position.neighbor(Tessellation::Sokoban, Direction::Up, size);
assert!(neighbor.unwrap() == Point2D::new(11, 7));

let neighbor_directions: Option<DirectionsSet> =
    position.neighbor_directions(Tessellation::Sokoban, size);
assert!(
    neighbor_directions.unwrap()
        == [
            Direction::Up,
            Direction::Right,
            Direction::Down,
            Direction::Left
        ]
);

let neighbors = Vec::from_iter(position.neighbors(Tessellation::Sokoban, size).unwrap());
assert!(
    neighbors
        == vec![
            (Direction::Up, Point2D::new(11, 7)),
            (Direction::Right, Point2D::new(12, 8)),
            (Direction::Down, Point2D::new(11, 9)),
            (Direction::Left, Point2D::new(10, 8))
        ]
);

In situations where game board is better represented as 1D array, Point2D can be still used to reference individual game board tiles. It implements conversion between 2D (x, y) coordinate representation and equivalent 1D array index.

let size = Size2D::new(5, 6);
let pos_2d = Point2D::new(4, 2);
let pos_1d: usize = pos_2d.idx(size);

Fields

x: usize

y: usize

Implementations

impl Point2D

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

pub fn new_from_idx(idx: usize, size: &Size2D) -> Self

Creates Point2D from 1D array index and board size.

pub fn origin() -> Self

Returns Point2D at origin (0, 0).

pub fn is_on_board(&self, size: Size2D) -> bool

Returns true if self is on board, given the board size.

pub fn idx(&self, size: Size2D) -> usize

Converts Point2D into 1D array position.

1D index can be used to reference board positions for 2D boards stored as 1D array of tiles.

pub fn neighbor( &self, tessellation: Tessellation, to: Direction, size: Size2D, ) -> Option<Self>

See Tessellation::neighbor().

pub fn neighbors( &self, tessellation: Tessellation, size: Size2D, ) -> Option<IterNeighbors>

Returns iterator over neighboring (Direction, Point2D).

Returns None if self is off-board coordinate.

See Tessellation::neighbor().

pub fn neighbor_directions( &self, tessellation: Tessellation, size: Size2D, ) -> Option<DirectionsSet>

See Tessellation::neighbor_directions().

pub fn tile_shape(&self, tessellation: Tessellation) -> TileShape

See Tessellation::tile_shape_from_pos().

Trait Implementations

impl Clone for Point2D

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Point2D

impl Debug for Point2D

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

Formats the value using the given formatter.

impl Default for Point2D

fn default() -> Self

Returns the “default value” for a type.

impl Display for Point2D

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

Formats the value using the given formatter.

impl Eq for Point2D

impl<'a> Extend<&'a Point2D> for BoardArea

fn extend<T: IntoIterator<Item = &'a Point2D>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Extend<Point2D> for BoardArea

fn extend<T: IntoIterator<Item = Point2D>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: T)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<(u8, u8)> for Point2D

value is (x, y)

fn from(value: (u8, u8)) -> Self

Converts to this type from the input type.

impl From<(u16, u16)> for Point2D

value is (x, y)

fn from(value: (u16, u16)) -> Self

Converts to this type from the input type.

impl From<(usize, usize)> for Point2D

value is (x, y)

fn from(value: (usize, usize)) -> Self

Converts to this type from the input type.

impl From<[u8; 2]> for Point2D

value is (x, y)

fn from(value: [u8; 2]) -> Self

Converts to this type from the input type.

impl From<[u16; 2]> for Point2D

value is (x, y)

fn from(value: [u16; 2]) -> Self

Converts to this type from the input type.

impl From<[usize; 2]> for Point2D

value is (x, y)

fn from(value: [usize; 2]) -> Self

Converts to this type from the input type.

impl Hash for Point2D

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Index<Point2D> for GameBoard

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

index is Point2D of the tile.

Panics

Panics if index is outside of board.

type Output = TileKind

The returned type after indexing.

impl IndexMut<Point2D> for GameBoard

fn index_mut(&mut self, index: Point2D) -> &mut Self::Output

index is Point2D of the tile.

Panics

Panics if index is outside of board.

impl Ord for Point2D

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

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Point2D

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Point2D

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for Point2D

impl TryFrom<(i8, i8)> for Point2D

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

value is (x, y)

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<(i16, i16)> for Point2D

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

value is (x, y)

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<(i32, i32)> for Point2D

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

value is (x, y)

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<(i64, i64)> for Point2D

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

value is (x, y)

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<(isize, isize)> for Point2D

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

value is (x, y)

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<(u32, u32)> for Point2D

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

value is (x, y)

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<(u64, u64)> for Point2D

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

value is (x, y)

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<[i8; 2]> for Point2D

fn try_from(value: [i8; 2]) -> Result<Self, Self::Error>

value is [x, y]

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<[i16; 2]> for Point2D

fn try_from(value: [i16; 2]) -> Result<Self, Self::Error>

value is [x, y]

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<[i32; 2]> for Point2D

fn try_from(value: [i32; 2]) -> Result<Self, Self::Error>

value is [x, y]

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<[i64; 2]> for Point2D

fn try_from(value: [i64; 2]) -> Result<Self, Self::Error>

value is [x, y]

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<[isize; 2]> for Point2D

fn try_from(value: [isize; 2]) -> Result<Self, Self::Error>

value is [x, y]

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<[u32; 2]> for Point2D

fn try_from(value: [u32; 2]) -> Result<Self, Self::Error>

value is [x, y]

type Error = TryFromIntError

The type returned in the event of a conversion error.

impl TryFrom<[u64; 2]> for Point2D

fn try_from(value: [u64; 2]) -> Result<Self, Self::Error>

value is [x, y]

type Error = TryFromIntError

The type returned in the event of a conversion error.