Struct SquareGrid 

pub struct SquareGrid {
    pub size: Size,
    pub layout: SquareLayout,
    pub wrap_flags: WrapFlags,
}

Fields

size: Size

layout: SquareLayout

wrap_flags: WrapFlags

Implementations

impl SquareGrid

pub const fn new( size: Size, layout: SquareLayout, wrap_flags: WrapFlags, ) -> Self

Creates a new SquareGrid with the specified size, layout, and wrap flags.

pub const fn with_resized_layout(&self, layout_size: [f32; 2]) -> Self

Returns a new SquareGrid with the specified layout size, keeping other properties unchanged.

Trait Implementations

impl Clone for SquareGrid

fn clone(&self) -> SquareGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SquareGrid

impl Grid for SquareGrid

type GridCoordinateType = Square

Internal coordinate type used by the grid.

type DirectionArrayType = [Direction; 4]

Direction array type for edges or corners.

fn with_dimensions(&self, width: u32, height: u32) -> Self

Returns a new Grid with the specified width and height, preserving all other fields from the current instance.

fn edge_direction_array(&self) -> Self::DirectionArrayType

Returns the array of edge directions for the grid.

fn corner_direction_array(&self) -> Self::DirectionArrayType

Returns the array of corner directions for the grid.

fn size(&self) -> Size

Returns the grid dimensions as a Size struct.

fn wrap_flags(&self) -> WrapFlags

Returns the flags that indicate how a grid/map wraps at its borders.

fn center(&self) -> [f32; 2]

Get the center of the grid in pixel coordinates.

fn left_bottom(&self) -> [f32; 2]

Get the left-bottom position of the grid in pixel coordinates.

fn right_top(&self) -> [f32; 2]

Get the right-top position of the grid in pixel coordinates.

fn offset_to_pixel(&self, offset_coordinate: OffsetCoordinate) -> [f32; 2]

Returns the pixel coordinates of the center of the given OffsetCoordinate.

fn pixel_to_offset(&self, pixel: [f32; 2]) -> OffsetCoordinate

Returns the OffsetCoordinate which contains the given pixel coordinates.

fn grid_coordinate_to_cell( &self, grid_coordinate: Self::GridCoordinateType, ) -> Option<Cell>

Convert GridCoordinateType to a Cell in the grid.

fn distance_to(&self, start: Cell, dest: Cell) -> i32

Computes the distance from start to dest in the grid.

fn neighbor(self, center: Cell, direction: Direction) -> Option<Cell>

Returns the neighbor of center in the given direction.

fn cells_at_distance( self, center: Cell, distance: u32, ) -> impl Iterator<Item = Cell>

Returns an iterator over all grid cells that are at a distance of distance from center.

fn cells_within_distance( self, center: Cell, distance: u32, ) -> impl Iterator<Item = Cell>

Returns an iterator over all grid cells that are within a distance of distance from center. This includes the center cell itself.

fn estimate_direction(&self, start: Cell, dest: Cell) -> Option<Direction>

Determine the direction of dest relative to start.

fn width(&self) -> u32

Returns the grid width in cells (number of columns).

fn height(&self) -> u32

Returns the height of the grid in cells (number of rows).

fn wrap_x(&self) -> bool

Returns if the grid is wrapped in the X direction (horizontal wrapping).

fn wrap_y(&self) -> bool

Returns if the grid is wrapped in the Y direction (vertical wrapping).

fn cell_to_offset(&self, cell: Cell) -> OffsetCoordinate

Converts a Cell to an OffsetCoordinate.

fn offset_to_cell( &self, offset_coordinate: OffsetCoordinate, ) -> Result<Cell, String>

Converts an OffsetCoordinate to a Cell. If the coordinate is out of bounds, an error is returned.

fn normalize_offset( &self, offset_coordinate: OffsetCoordinate, ) -> Result<OffsetCoordinate, String>

Normalizes an offset coordinate to fit within the grid’s bounds. If the coordinate is out of bounds, an error is returned.

fn within_grid_bounds(&self, offset_coordinate: OffsetCoordinate) -> bool

Checks if the given OffsetCoordinate is within the grid bounds.

impl GridSize for SquareGrid

fn default_size(world_size_type: WorldSizeType) -> Size

Get the default size of the grid based on its world size type. This is used to initialize the grid with a default size.

fn world_size_type(&self) -> WorldSizeType

Get world size type of the grid based on its size.