Struct arcs::components::Space

pub struct Space { /* fields omitted */ }

A global Resource for looking up which Entitys inhabit a given spatial point or region

Methods

impl Space

pub const WORLD_RADIUS: f64

pub fn modify(&mut self, spatial: SpatialEntity)

Modifies the spatial position of the given SpatialEntity inside of Space If the SpatialEntity is not already inside of Space it will be inserted.

pub fn remove(&mut self, entity: Entity)

Removes the given Entity from this Space

pub fn remove_by_id(&mut self, id: Index)

Removes an Entity from this Space given its Index

pub fn iter<'this>(&'this self) -> impl Iterator<Item = SpatialEntity> + 'this

Returns an iterator over all SpatialEntity in this Space

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn query_point<'this>(
    &'this self,
    point: Point,
    radius: f64
) -> impl Iterator<Item = SpatialEntity> + 'this

Performs a spatial query in an radius around a given Point Returns an iterator with all SpatialEntity inhabiting the Space close to the given point The returned iterator can be empty

pub fn query_region<'this>(
    &'this self,
    region: BoundingBox
) -> impl Iterator<Item = SpatialEntity> + 'this

Performs a spatial query for a given BoundingBox Returns an iterator with all SpatialEntity inhabiting the Space of the given BoundingBox The returned iterator can be empty

pub fn clear(&mut self)

Clears the Space of all SpatialEntity

pub fn resize(&mut self, size: impl Spatial<f64>)

Resizes the inner quadtree to the given bigger size

Panics

Panics if the size given is not bigger then the initial bounding_box of the Space

Trait Implementations

impl Debug for Space

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

Formats the value using the given formatter.

impl Default for Space

fn default() -> Self

Returns the "default value" for a type.