Skip to main content

SpatialGrid

Struct SpatialGrid 

Source
pub struct SpatialGrid<T: Clone> {
    pub cell_size: f32,
    /* private fields */
}
Expand description

A uniform 3D spatial hash grid.

Space is divided into cubic cells of cell_size. Items are stored in buckets by their cell coordinate. Queries scan all cells overlapping the query sphere.

§Complexity

  • Insert: O(1) average
  • Range query: O(k + m) where k = items in range, m = cells overlapping sphere
  • Rebuild: O(n)

Fields§

§cell_size: f32

Cell size (world units per cell edge).

Implementations§

Source§

impl<T: Clone> SpatialGrid<T>

Source

pub fn new(cell_size: f32) -> Self

Source

pub fn insert(&mut self, pos: Vec3, item: T)

Source

pub fn query_radius(&self, center: Vec3, radius: f32) -> Vec<(T, Vec3, f32)>

Query all items within radius of center, returning (item, position, distance).

Source

pub fn k_nearest(&self, center: Vec3, k: usize) -> Vec<(T, Vec3, f32)>

Find the k nearest items to center.

Source

pub fn nearest(&self, center: Vec3) -> Option<(T, Vec3, f32)>

Find the single nearest item.

Source

pub fn clear(&mut self)

Source

pub fn len(&self) -> usize

Source

pub fn is_empty(&self) -> bool

Source

pub fn bucket_count(&self) -> usize

Source

pub fn avg_bucket_load(&self) -> f32

Average items per occupied bucket (load factor).

Source

pub fn rebuild(&mut self, items: impl Iterator<Item = (Vec3, T)>)

Rebuild from an iterator of (position, item) pairs.

Source

pub fn iter(&self) -> impl Iterator<Item = (&Vec3, &T)>

Iterate over all items.

Auto Trait Implementations§

§

impl<T> Freeze for SpatialGrid<T>

§

impl<T> RefUnwindSafe for SpatialGrid<T>
where T: RefUnwindSafe,

§

impl<T> Send for SpatialGrid<T>
where T: Send,

§

impl<T> Sync for SpatialGrid<T>
where T: Sync,

§

impl<T> Unpin for SpatialGrid<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for SpatialGrid<T>

§

impl<T> UnwindSafe for SpatialGrid<T>
where T: UnwindSafe,

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,