SparseField

Struct SparseField 

Source
pub struct SparseField<T: Float> { /* private fields */ }
Expand description

3-dimensional sparse field for scalar values.

The field uses a three-level hierarchical structure:

  • A dynamic root node that can be subdivided arbitrarily (e.g., 1x1x2, 2x2x2, etc.)
  • Internal nodes with a fixed subdivision pattern defined by BlockSize
  • Dense leaf nodes containing the actual field data

This structure provides a balance between memory efficiency and computational performance, allowing dense sampling only in regions where the field is active. Empty or uniform regions can be efficiently represented at the internal node level.

Note: This type should not be constructed directly. Instead, use ~SparseSampler to sample and extract a sparse field from an implicit model.

Implementations§

Source§

impl<T: Float> SparseField<T>

Source

pub fn new(config: SparseFieldConfig<T>) -> Self

Creates a new empty sparse field with the given configuration.

§Arguments
  • config - The configuration specifying block sizes and sampling mode.
Source

pub fn init_bounds(&mut self, bounds: &BoundingBox<T>)

Initializes the field’s bounds and activates the necessary internal nodes.

§Arguments
  • bounds - The bounding box defining the field’s extents.
Source§

impl<T: ModelFloat + 'static + Default> SparseField<T>

Source

pub fn n_active_nodes(&self) -> usize

Compute the total number of active leaf nodes.

Trait Implementations§

Source§

impl<T: Float + 'static> CellIterator<T> for SparseField<T>

Source§

fn iter_cells<'a>(&'a self) -> Self::Iter<'a>

Returns an iterator that yields all cell coordinates in the leaf nodes in the sparse field.

Source§

type Iter<'a> = Box<dyn Iterator<Item = BoundingBox<T>> + 'a> where Self: 'a

A different Iterator<Item=BoundingBox<T>> for each borrow‐lifetime 'a.
Source§

impl<T: Float + 'static> CellValueIterator<T> for SparseField<T>

Source§

fn iter_cell_values<'a>(&'a self) -> Self::Iter<'a>

Returns an iterator that yields the values at each cell’s corners in the leaf nodes in the sparse field.

Source§

type Iter<'a> = Box<dyn Iterator<Item = [T; 8]> + 'a> where Self: 'a

A different Iterator<Item=[T;8]> for each borrow‐lifetime 'a.
Source§

impl<T: Clone + Float> Clone for SparseField<T>

Source§

fn clone(&self) -> SparseField<T>

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<T: Debug + Float> Debug for SparseField<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de, T> Deserialize<'de> for SparseField<T>
where T: Deserialize<'de> + Float,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl<T: Float + 'static> PointIterator<T> for SparseField<T>

Source§

fn iter_points<'a>(&'a self) -> Self::Iter<'a>

Returns an iterator that yields all point coordinates in each leaf node in the sparse field.

Source§

type Iter<'a> = Box<dyn Iterator<Item = Vec3<T>> + 'a> where Self: 'a

A different Iterator<Item=Vec3<T>> for each borrow‐lifetime 'a.
Source§

impl<T: ModelFloat + 'static + Default> Sampler<T, SparseField<T>> for SparseSampler<T>

Source§

fn sample_field( &mut self, model: &ImplicitModel<T>, ) -> Result<&SparseField<T>, ModelError>

Sample a field for the default component given by ImplicitModel::get_default_output Read more
Source§

fn sample_field_for_component( &mut self, model: &ImplicitModel<T>, component_tag: &str, ) -> Result<&SparseField<T>, ModelError>

Sample a field from one of the model components. Read more
Source§

fn iso_surface(&self, iso_val: T) -> Result<Mesh<T>, ModelError>

Extract an iso-surface for a certain iso value. Read more
Source§

fn field(&self) -> &SparseField<T>

Access the field data.
Source§

impl<T> Serialize for SparseField<T>
where T: Serialize + Float,

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl<T: Float + 'static> ValueIterator<T> for SparseField<T>

Source§

fn iter_values<'a>(&'a self) -> Self::Iter<'a>

Returns an iterator that yields each value in the leaf nodes in the sparse field.

Source§

type Iter<'a> = Box<dyn Iterator<Item = T> + 'a> where Self: 'a

A different Iterator<Item=T> for each borrow‐lifetime 'a.

Auto Trait Implementations§

§

impl<T> Freeze for SparseField<T>
where T: Freeze,

§

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

§

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

§

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

§

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

§

impl<T> UnwindSafe for SparseField<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> 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> Downcast<T> for T

Source§

fn downcast(&self) -> &T

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<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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Serialize for T
where T: Serialize + ?Sized,

Source§

fn erased_serialize(&self, serializer: &mut dyn Serializer) -> Result<(), Error>

Source§

fn do_erased_serialize( &self, serializer: &mut dyn Serializer, ) -> Result<(), ErrorImpl>

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<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

impl<T> WasmNotSendSync for T

Source§

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