Struct SpatialMessages2D 

pub struct SpatialMessages2D<M> { /* private fields */ }

2D spatial message list with spatial-hashing neighbor lookup.

Messages carry an (x, y) position. During finalization, messages are sorted into a uniform grid of bins (side length = radius). During the read phase, agents query nearby messages by position and only iterate bins within the search radius.

This mirrors FlameGPU2’s MessageSpatial2D and its Partition Boundary Matrix (PBM) – a sorted index of messages by spatial bin.

Performance: O(k) per agent where k = messages in neighboring bins.

Implementations

impl<M: Clone> SpatialMessages2D<M>

pub fn new(radius: f32) -> Result<Self, MessageConfigError>

Create a new 2D spatial message list.

radius is both the search radius and the bin side length.

pub fn output(&mut self, message: M, x: f32, y: f32)

Output a message at a 2D position (phase 1).

pub fn try_output( &mut self, message: M, x: f32, y: f32, ) -> Result<(), MessagePhaseError>

Try to output a message at a 2D position, returning a typed phase error on misuse.

pub fn finalize(&mut self)

Build the spatial index (phase boundary).

This constructs a PBM-like structure: messages are logically sorted by bin, and a map records the (start, count) of each bin.

pub fn read_nearby(&self, x: f32, y: f32, radius: f32) -> SpatialIter2D<'_, M>

Iterate messages within radius of (x, y) (phase 2).

Returns an iterator yielding (message_ref, distance_squared). The caller should filter by distance_squared <= radius * radius for exact circular queries (the method returns a superset from the bin neighborhood).

Panics

Panics if called before finalize. Use try_read_nearby to handle phase errors explicitly.

pub fn try_read_nearby( &self, x: f32, y: f32, radius: f32, ) -> Result<SpatialIter2D<'_, M>, MessagePhaseError>

Try to iterate messages within radius of (x, y) (phase 2).

pub fn is_finalized(&self) -> bool

Whether the message buffer has been finalized for reading.

pub fn len(&self) -> usize

Number of messages.

pub fn is_empty(&self) -> bool

Returns true if no messages have been output.

pub fn clear(&mut self)

Clear all messages and the spatial index for the next step.

Trait Implementations

impl<M: Clone> Clone for SpatialMessages2D<M>

fn clone(&self) -> SpatialMessages2D<M>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<M: Debug> Debug for SpatialMessages2D<M>

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

Formats the value using the given formatter.