Struct sark_grids::world_grid::WorldGrid

pub struct WorldGrid {
    pub world_pos: Vec2,
    /* private fields */
}

A sized grid with a custom pivot for translating between aligned grid points and world space.

Fields

world_pos: Vec2

Implementations

impl WorldGrid

pub fn new(world_pos: impl Point2d, size: impl Size2d, pivot: Pivot) -> Self

pub fn origin(size: impl Size2d, pivot: Pivot) -> Self

Create a grid with it’s world position set to origin.

pub fn tile_pos(&self, grid_pos: impl Point2d) -> Vec2

Returns the tile position of a given tile.

A tile’s “position” refers to the bottom left point on the tile.

pub fn tile_center(&self, grid_pos: impl Point2d) -> Vec2

Returns the center point of a given tile.

pub fn tile_pos_world(&self, grid_pos: impl Point2d) -> Vec2

Returns the position of the given tile in world space.

A tile’s “position” refers to the bottom left point on the tile.

pub fn tile_center_world(&self, grid_pos: [i32; 2]) -> Vec2

Return’s the center of the given tile in world space.

pub fn grid_pos_in_bounds(&self, grid_pos: [i32; 2]) -> bool

Whether or not the given grid position is inside the grid bounds.

A grid’s bounds are determined by it’s pivot - a grid’s pivot always sits on the world origin.

pub fn index_2d_in_bounds(&self, index: impl Point2d) -> bool

Whether or not the given 2d index is inside the grid bounds.

pub fn try_grid_to_index_2d(&self, grid_pos: [i32; 2]) -> Option<IVec2>

Convert a grid point to it’s corresponding 2d index.

Returns none if the given grid point is out of bounds.

pub fn grid_to_index_2d(&self, grid_pos: impl Point2d) -> IVec2

Converts from a local grid position to it’s corresponding 2d index.

This function will return out of bounds values if given out of bounds grid positions. For a bound-checked version use try_grid_to_index_2d

pub fn index_2d_to_grid(&self, i: impl Point2d) -> IVec2

Convert from a 2d index to it’s corresponding grid position.

pub fn width(&self) -> usize

pub fn height(&self) -> usize

pub fn size(&self) -> IVec2

pub fn tile_pos_iter(&self) -> impl Iterator<Item = Vec2>

An iterator over the tile position of every tile in the grid.

A tile’s “position” refers to the bottom left point on the tile.

pub fn tile_center_iter(&self) -> impl Iterator<Item = Vec2>

An iterator over the tile center of every tile in the grid.

pub fn tile_pos_iter_world(&self) -> impl Iterator<Item = Vec2>

An iterator over the tile position of every tile in the grid.

A tile’s “position” refers to the bottom left point on the tile.

Trait Implementations

impl Clone for WorldGrid

fn clone(&self) -> WorldGrid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorldGrid

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

Formats the value using the given formatter.

impl Default for WorldGrid

fn default() -> WorldGrid

Returns the “default value” for a type.