Skip to main content

GridLayout

Struct GridLayout 

Source
pub struct GridLayout {
    pub origin: Vec2,
    pub cell_size: Vec2,
}
Expand description

Maps grid cells to world-space cells.

Cell (x, y) covers origin + (x, y) * cell_size to one cell further along both axes. In 3D, use the vector’s y as world z. Searches measure distance in cells, so with non-square cells a path is shortest in cell steps rather than in world units.

Fields§

§origin: Vec2

World position of cell (0, 0)’s minimum corner.

§cell_size: Vec2

Width and height of one cell in world units. Must be finite and positive.

Implementations§

Source§

impl GridLayout

Source

pub fn new(origin: Vec2, cell_size: Vec2) -> Self

Creates a layout. Panics for a nonfinite origin or a nonpositive or nonfinite cell size.

Source

pub fn cell_center(&self, cell: UVec2) -> Vec2

World position of a cell’s center.

Source

pub fn cell_bounds(&self, cell: UVec2) -> Aabb2

World bounds of a cell, for example as a static collider. Neighboring cells share exact edges.

Source

pub fn clearance(&self, half_size: Vec2) -> Vec2

A body’s clearance in cell units, for smooth_path and line_of_sight: its half size divided by the cell size, such as layout.clearance(body.half_size).

Source

pub fn cell_at(&self, point: Vec2, size: UVec2) -> Option<UVec2>

Cell containing point in a grid of size, or None outside it. Points on a shared edge belong to the cell with the larger coordinate.

Trait Implementations§

Source§

impl Clone for GridLayout

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for GridLayout

Source§

impl Debug for GridLayout

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for GridLayout

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for GridLayout

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Component for T
where T: Send + Sync + 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.