Struct sark_grids::world_grid::WorldGrid

pub struct WorldGrid {
    pub world_space: WorldSpace,
    pub pixels_per_tile: UVec2,
    pub tile_count: UVec2,
}

A sized grid which can be used to translate world positions to tile positions based on WorldSpace and the size of the grid.

Fields

world_space: WorldSpace

The WorldSpace for this grid.

pixels_per_tile: UVec2

How many pixels constitute a “tile” in the grid.

tile_count: UVec2

How many tiles the grid has.

Implementations

impl WorldGrid

pub fn unit_grid( tile_count: impl GridPoint, pixels_per_tile: impl GridPoint ) -> Self

Create a WorldGrid set to WorldSpace::Units.

pub fn pixel_grid( tile_count: impl GridPoint, pixels_per_tile: impl GridPoint ) -> Self

Create a WorldGrid set to WorldSpace::Pixels.

pub fn tile_size_world(&self) -> Vec2

The size of a tile in world space, given pixels_per_tile and world_space.

pub fn pos_to_index(&self, pos: impl Point2d) -> IVec2

Convert a position to it’s corresponding tile index.

pub fn get_pos_to_index(&self, pos: impl Point2d) -> Option<IVec2>

Try to get the corresponding tile index of a given position.

Returns none if the position is out of grid bounds.

pub fn index_to_pos(&self, pos: impl GridPoint) -> Vec2

Convert a tile index to it’s corresponding position.

The returned position is the bottom left of the tile.

pub fn world_size(&self) -> Vec2

How large the grid is in world space, given the WorldSpace of the grid.

pub fn pos_to_tile_pos(&self, pos: impl Point2d) -> Vec2

Convert a position to it’s tile position in the grid.

pub fn index_to_tile_center(&self, index: impl GridPoint) -> Vec2

Return the world center of the tile at the given index.

pub fn pivot_pos(&self, pivot: Pivot) -> Vec2

Return the tile position of a pivot point given the size of the grid.

pub fn pivot_pos_world(&self, pivot: Pivot) -> Vec2

pub fn index_in_bounds(&self, index: impl GridPoint) -> bool

pub fn pos_in_bounds(&self, pos: impl Point2d) -> bool

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

An iterator over the 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 center of every tile in the grid.

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 PartialEq for WorldGrid

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WorldGrid

impl StructuralPartialEq for WorldGrid