1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
use crate::cell::{CellObject, GridCell};
use crate::storage::{cell_range, CellIdx, SparseStorage};
use crate::Vec2;
use slotmapd::{new_key_type, SlotMap};
use std::marker::PhantomData;
pub type GridObjects<O, V2> = SlotMap<GridHandle, StoreObject<O, V2>>;
new_key_type! {
/// This handle is used to modify the associated object or to update its position.
/// It is returned by the _insert_ method of a Grid.
pub struct GridHandle;
}
/// State of an object, maintain() updates the internals of the grid and resets this to Unchanged
#[derive(Clone, Copy, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum ObjectState<V2: Vec2> {
Unchanged,
NewPos(V2),
Relocate(V2, CellIdx),
Removed,
}
/// The actual object stored in the store
#[derive(Clone, Copy)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct StoreObject<O, V2: Vec2> {
/// User-defined object to be associated with a value
obj: O,
pub state: ObjectState<V2>,
pub pos: V2,
pub cell_id: CellIdx,
}
/// Grid is a point-based spatial partitioning structure that uses a generic storage of cells which acts as a
/// grid instead of a tree.
///
/// ## Fast queries
/// In theory, Grid should be faster than a quadtree/r-tree because it has no log costs
/// (calculating the cells around a point is trivial).
/// However, it only works if the cell size is adapted to the problem, much like how a tree has to
/// be balanced to be efficient.
///
/// ## Dynamicity
/// Grid's big advantage is that it is dynamic, supporting lazy positions updates
/// and object removal in constant time. Once objects are in, there is almost no allocation happening.
///
/// Compare that to most immutable spatial partitioning structures out there, which pretty much require
/// to rebuild the entire tree every time.
///
/// A `SlotMap` is used for objects managing, adding a level of indirection between points and objects.
/// `SlotMap` is used because removal doesn't alter handles given to the user, while still having constant time access.
/// However it requires O to be copy, but `SlotMap's` author stated that they were working on a similar
/// map where Copy isn't required.
///
/// ## About object management
///
/// In theory, you don't have to use the object management directly, you can make your custom
/// Handle -> Object map by specifying "`()`" to be the object type.
/// _(This can be useful if your object is not Copy)_
/// Since `()` is zero sized, it should probably optimize away a lot of the object management code.
///
///
/// ## Examples
/// Here is a basic example that shows most of its capabilities:
/// ```rust
/// use flat_spatial::Grid;
///
/// let mut g: Grid<i32, [f32; 2]> = Grid::new(10); // Creates a new grid with a cell width of 10 with an integer as extra data
/// let a = g.insert([0.0, 0.0], 0); // Inserts a new element with data: 0
///
/// {
/// let mut before = g.query_around([0.0, 0.0], 5.0).map(|(id, _pos)| id); // Queries for objects around a given point
/// assert_eq!(before.next(), Some(a));
/// assert_eq!(g.get(a).unwrap().1, &0);
/// }
/// let b = g.insert([0.0, 0.0], 1); // Inserts a new element, assigning a new unique and stable handle, with data: 1
///
/// g.remove(a); // Removes a value using the handle given by `insert`
/// // This won't have an effect until g.maintain() is called
///
/// g.maintain(); // Maintains the grid, which applies all removals and position updates (not needed for insertions)
///
/// assert_eq!(g.handles().collect::<Vec<_>>(), vec![b]); // We check that the "a" object has been removed
///
/// let after: Vec<_> = g.query_around([0.0, 0.0], 5.0).map(|(id, _pos)| id).collect(); // And that b is query-able
/// assert_eq!(after, vec![b]);
///
/// assert_eq!(g.get(b).unwrap().1, &1); // We also check that b still has his data associated
/// assert_eq!(g.get(a), None); // But that a doesn't exist anymore
/// ```
#[derive(Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct Grid<O, V2: Vec2> {
storage: SparseStorage<GridCell<V2>>,
objects: GridObjects<O, V2>,
// Cache maintain vec to avoid allocating every time maintain is called
to_relocate: Vec<CellObject<V2>>,
_phantom: PhantomData<V2>,
}
impl<O: Copy, V2: Vec2> Grid<O, V2> {
/// Creates an empty grid.
/// The cell size should be about the same magnitude as your queries size.
pub fn new(cell_size: i32) -> Self {
Self {
storage: SparseStorage::new(cell_size),
objects: SlotMap::with_key(),
to_relocate: vec![],
_phantom: Default::default(),
}
}
/// Inserts a new object with a position and an associated object
/// Returns the unique and stable handle to be used with `get_obj`
pub fn insert(&mut self, pos: V2, obj: O) -> GridHandle {
let (cell_id, cell) = self.storage.cell_mut(pos);
let handle = self.objects.insert(StoreObject {
obj,
state: ObjectState::Unchanged,
pos,
cell_id,
});
cell.objs.push((handle, pos));
handle
}
/// Lazily sets the position of an object (if it is not marked for deletion).
/// This won't be taken into account until maintain() is called.
pub fn set_position(&mut self, handle: GridHandle, pos: V2) {
let obj = match self.objects.get_mut(handle) {
Some(x) => x,
None => {
debug_assert!(false, "Object not in grid anymore");
return;
}
};
if matches!(obj.state, ObjectState::Removed) {
return;
}
let target_id = self.storage.cell_id(pos);
obj.state = if target_id == obj.cell_id {
ObjectState::NewPos(pos)
} else {
ObjectState::Relocate(pos, target_id)
};
self.storage.cell_mut_unchecked(obj.cell_id).dirty = true;
}
/// Lazily removes an object from the grid.
/// This won't be taken into account until maintain() is called.
///
/// # Example
/// ```rust
/// use flat_spatial::Grid;
/// let mut g: Grid<(), [f32; 2]> = Grid::new(10);
/// let h = g.insert([5.0, 3.0], ());
/// g.remove(h);
/// ```
pub fn remove(&mut self, handle: GridHandle) -> Option<O> {
let obj = self.objects.get_mut(handle)?;
obj.state = ObjectState::Removed;
self.storage.cell_mut_unchecked(obj.cell_id).dirty = true;
Some(obj.obj)
}
/// Directly removes an object from the grid.
/// This is equivalent to remove() then maintain() but is much faster (O(1))
///
/// # Example
/// ```rust
/// use flat_spatial::Grid;
/// let mut g: Grid<(), [f32; 2]> = Grid::new(10);
/// let h = g.insert([5.0, 3.0], ());
/// g.remove(h);
/// ```
pub fn remove_maintain(&mut self, handle: GridHandle) -> Option<O> {
let obj = self.objects.remove(handle)?;
let cell = self.storage.cell_mut_unchecked(obj.cell_id);
cell.objs.retain(|&(h, _)| h != handle);
Some(obj.obj)
}
/// Clear all objects from the grid.
/// Returns the objects and their positions.
pub fn clear(&mut self) -> impl Iterator<Item = (V2, O)> {
let objects = std::mem::take(&mut self.objects);
self.storage = SparseStorage::new(self.storage.cell_size());
self.to_relocate.clear();
objects.into_iter().map(|(_, x)| (x.pos, x.obj))
}
/// Maintains the world, updating all the positions (and moving them to corresponding cells)
/// and removing necessary objects and empty cells.
/// Runs in linear time O(N) where N is the number of objects.
/// # Example
/// ```rust
/// use flat_spatial::Grid;
/// let mut g: Grid<(), [f32; 2]> = Grid::new(10);
/// let h = g.insert([5.0, 3.0], ());
/// g.remove(h);
///
/// assert!(g.get(h).is_some());
/// g.maintain();
/// assert!(g.get(h).is_none());
/// ```
pub fn maintain(&mut self) {
let Self {
storage,
objects,
to_relocate,
..
} = self;
storage.modify(|cell| {
cell.maintain(objects, to_relocate);
cell.objs.is_empty()
});
for (handle, pos) in to_relocate.drain(..) {
storage.cell_mut(pos).1.objs.push((handle, pos));
}
}
/// Iterate over all handles
pub fn handles(&self) -> impl Iterator<Item = GridHandle> + '_ {
self.objects.keys()
}
/// Iterate over all objects
pub fn objects(&self) -> impl Iterator<Item = (V2, &O)> + '_ {
self.objects.values().map(|x| (x.pos, &x.obj))
}
/// Returns a reference to the associated object and its position, using the handle.
///
/// # Example
/// ```rust
/// use flat_spatial::Grid;
/// let mut g: Grid<i32, [f32; 2]> = Grid::new(10);
/// let h = g.insert([5.0, 3.0], 42);
/// assert_eq!(g.get(h), Some(([5.0, 3.0], &42)));
/// ```
pub fn get(&self, id: GridHandle) -> Option<(V2, &O)> {
self.objects.get(id).map(|x| (x.pos, &x.obj))
}
/// Returns a mutable reference to the associated object and its position, using the handle.
///
/// # Example
/// ```rust
/// use flat_spatial::Grid;
/// let mut g: Grid<i32, [f32; 2]> = Grid::new(10);
/// let h = g.insert([5.0, 3.0], 42);
/// *g.get_mut(h).unwrap().1 = 56;
/// assert_eq!(g.get(h).unwrap().1, &56);
/// ```
pub fn get_mut(&mut self, id: GridHandle) -> Option<(V2, &mut O)> {
self.objects.get_mut(id).map(|x| (x.pos, &mut x.obj))
}
/// The underlying storage
pub fn storage(&self) -> &SparseStorage<GridCell<V2>> {
&self.storage
}
pub fn query_around(&self, pos: V2, radius: f32) -> impl Iterator<Item = CellObject<V2>> + '_ {
let ll = [pos.x() - radius, pos.y() - radius];
let ur = [pos.x() + radius, pos.y() + radius];
let radius2 = radius * radius;
self.query(ll.into(), ur.into())
.filter(move |(_, pos_obj)| {
let x = pos_obj.x() - pos.x();
let y = pos_obj.y() - pos.y();
x * x + y * y < radius2
})
}
pub fn query_aabb(&self, ll_: V2, ur_: V2) -> impl Iterator<Item = CellObject<V2>> + '_ {
let ll = [ll_.x().min(ur_.x()), ll_.y().min(ur_.y())];
let ur = [ll_.x().max(ur_.x()), ll_.y().max(ur_.y())];
self.query(ll.into(), ur.into())
.filter(move |(_, pos_obj)| {
(ll[0]..=ur[0]).contains(&pos_obj.x()) && (ll[1]..=ur[1]).contains(&pos_obj.y())
})
}
pub fn query_aabb_visitor(&self, ll_: V2, ur_: V2, mut visitor: impl FnMut(CellObject<V2>)) {
let ll = [ll_.x().min(ur_.x()), ll_.y().min(ur_.y())];
let ur = [ll_.x().max(ur_.x()), ll_.y().max(ur_.y())];
self.query_visitor(ll.into(), ur.into(), move |cell| {
if (ll[0]..=ur[0]).contains(&cell.1.x()) && (ll[1]..=ur[1]).contains(&cell.1.y()) {
visitor(cell)
}
});
}
/// Queries for all objects in the cells intersecting an axis-aligned rectangle defined by lower left (ll) and upper right (ur)
/// Try to keep the rect's width/height of similar magnitudes to the cell size for better performance.
///
/// # Example
/// ```rust
/// use flat_spatial::Grid;
///
/// let mut g: Grid<(), [f32; 2]> = Grid::new(10);
/// let a = g.insert([0.0, 0.0], ());
/// let b = g.insert([5.0, 5.0], ());
///
/// let around: Vec<_> = g.query([-1.0, -1.0].into(), [1.0, 1.0].into()).map(|(id, _pos)| id).collect();
///
/// assert_eq!(vec![a, b], around);
/// ```
pub fn query(&self, ll: V2, ur: V2) -> impl Iterator<Item = CellObject<V2>> + '_ {
let ll_id = self.storage.cell_id(ll);
let ur_id = self.storage.cell_id(ur);
cell_range(ll_id, ur_id)
.flat_map(move |id| self.storage.cell(id))
.flat_map(|x| x.objs.iter().copied())
}
/// query_visitor is similar to query, but uses a visitor function to be slightly more performant.
pub fn query_visitor(&self, ll: V2, ur: V2, mut visitor: impl FnMut(CellObject<V2>)) {
let ll_id = self.storage.cell_id(ll);
let ur_id = self.storage.cell_id(ur);
for celly in ll_id.1..=ur_id.1 {
for cellx in ll_id.0..=ur_id.0 {
let cell = match self.storage.cell((cellx, celly)) {
Some(x) => x,
None => continue,
};
for h in cell.objs.iter() {
visitor(*h);
}
}
}
}
/// Returns the number of objects currently available
/// (removals that were not confirmed with maintain() are still counted)
pub fn len(&self) -> usize {
self.objects.len()
}
/// Checks if the grid contains objects or not
/// (removals that were not confirmed with maintain() are still counted)
pub fn is_empty(&self) -> bool {
self.objects.is_empty()
}
}