Skip to main content

SpatialMessages3D

Struct SpatialMessages3D 

Source
pub struct SpatialMessages3D<M> { /* private fields */ }
Expand description

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

Same concept as SpatialMessages2D but for 3D positions.

Mirrors FlameGPU2 MessageSpatial3D and its 3D Partition Boundary Matrix.

Implementations§

Source§

impl<M: Clone> SpatialMessages3D<M>

Source

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

Create a new 3D spatial message list.

Source

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

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

Source

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

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

Source

pub fn finalize(&mut self)

Build the spatial index (phase boundary).

Source

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

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

Returns an iterator yielding (message_ref, distance_squared).

§Panics

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

Source

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

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

Source

pub fn is_finalized(&self) -> bool

Whether the message buffer has been finalized for reading.

Source

pub fn len(&self) -> usize

Number of messages.

Source

pub fn is_empty(&self) -> bool

Returns true if no messages have been output.

Source

pub fn clear(&mut self)

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

Trait Implementations§

Source§

impl<M: Clone> Clone for SpatialMessages3D<M>

Source§

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

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M: Debug> Debug for SpatialMessages3D<M>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<M> Freeze for SpatialMessages3D<M>

§

impl<M> RefUnwindSafe for SpatialMessages3D<M>
where M: RefUnwindSafe,

§

impl<M> Send for SpatialMessages3D<M>
where M: Send,

§

impl<M> Sync for SpatialMessages3D<M>
where M: Sync,

§

impl<M> Unpin for SpatialMessages3D<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for SpatialMessages3D<M>

§

impl<M> UnwindSafe for SpatialMessages3D<M>
where M: 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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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<T> Message for T
where T: Clone + Send + Sync + 'static,