Enum Tessellation 

pub enum Tessellation {
    Sokoban,
    Hexoban,
    Trioban,
    Octoban,
}

Sokoban game variants.

Variants

Sokoban

Classic Sokoban game variant.

Game board is grid of squares.

Direction <-> character mapping:

Direction	Characters
Direction::Left	l, L
Direction::Right	r, R
Direction::Up	u, U
Direction::Down	d, D

Example board

Hexoban

Hexoban game variant.

Game board is grid of vertical, equilateral hexagons with following coordinate system:

Textual representation uses two characters for each hexagon. This allows different encoding schemes.

Scheme 1	Scheme 2

As long as encoding of single board is consistent, all methods handle any scheme transparently - parsing of board strings ‘Just Works ™’.

Direction <-> character mapping:

Direction	Characters
Direction::Left	l, L
Direction::Right	r, R
Direction::NorthWest	u, U
Direction::SouthWest	d, D
Direction::NorthEast	n, N
Direction::SouthEast	s, S

Example board

Trioban

Trioban game variant.

Game board is grid of alternating triangles with origin triangle pointing down.

Depending on pusher position, not all move directions are allowed on all board positions:

Direction <-> character mapping:

Direction	Characters
Direction::Left	l, L
Direction::Right	r, R
Direction::NorthWest	u, U
Direction::SouthWest	s, S
Direction::NorthEast	n, N
Direction::SouthEast	d, D

Example board

Octoban

Octoban game variant.

Game board is grid of alternating squares and octagons with origin of coordinate system being octagon.

This game variant allows usage of all 8 directions of movement from Direction. Depending on current pusher position, some of these directions may not result in successful move or may even be invalid (ie. trying to move north-west while standing on square tile).

Direction <-> character mapping:

Direction	Characters
Direction::Up	u, U
Direction::NorthEast	n, N
Direction::Right	r, R
Direction::SouthEast	e, E
Direction::Down	d, D
Direction::SouthWest	s, S
Direction::Left	l, L
Direction::NorthWest	w, W

Example board

Implementations

impl Tessellation

pub const COUNT: usize = 4

Number of all possible Tessellations.

pub const ALL: [Tessellation; 4]

All possible Tessellations in order of their discriminant values.

pub fn rotation_step_degrees(&self) -> u16

Angle of one call to GameBoard::rotate(), in degrees.

pub fn translation_period(&self) -> Size2D

Smallest axis-aligned integer translation that preserves the tiling.

Board resizing may apply a smaller shift by adding perpendicular padding or, for Hexoban, reindexing alternating rows.

pub fn known_directions(&self) -> &'static [Direction]

Slice of all directions that are supported by this tessellation.

pub fn tile_shapes(&self) -> &'static [TileShape]

Slice of all tile shapes that are supported by this tessellation.

pub const fn tile_shape_from_pos(&self, x: usize, y: usize) -> TileShape

TileShape for given game board position.

Doesn’t check if (x, y) is off board position because planar tiling applies to whole 2D plane, not just to some part of it enclosed by some game board.

pub fn neighbor( &self, x: usize, y: usize, to: Direction, width: usize, height: usize, ) -> Option<(usize, usize)>

Calculates neighbor position in part of plane enclosed by some game board.

It returns None if:

• input coordinate (x, y) is off-board coordinate
• output coordinate in direction to would’ve been off-board coordinate
• to is not supported direction of movement for underlying Tessellation (for example, trying to move north-west in Tessellation::Sokoban from any position)
• to is supported direction of movement for underlying Tessellation but is not allowed for from (for example, trying to move north-west in Tessellation::Octoban from position of square tile)

pub fn neighbor_directions( &self, x: usize, y: usize, width: usize, height: usize, ) -> Option<DirectionsSet>

Calculates set of directions where all directions in output set lead to valid Self::neighbor() positions.

If input coordinate (x, y) is off board position, returns None.

Trait Implementations

impl Clone for Tessellation

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 Tessellation

impl Debug for Tessellation

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

Formats the value using the given formatter.

impl Default for Tessellation

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Tessellation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Tessellation

impl Hash for Tessellation

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 Ord for Tessellation

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 Tessellation

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Tessellation

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 Serialize for Tessellation

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Tessellation