Trait ReadVol

pub trait ReadVol: BaseVol {
    // Required method
    fn get(&self, pos: Vec3<i32>) -> Result<&Self::Vox, Self::Error>;

    // Provided methods
    fn get_unchecked(&self, pos: Vec3<i32>) -> &Self::Vox { ... }
    fn ray(
        &self,
        from: Vec3<f32>,
        to: Vec3<f32>,
    ) -> Ray<'_, Self, fn(&Self::Vox) -> bool, fn(&Self::Vox, Vec3<i32>)>
       where Self: Sized { ... }
    fn for_each_in(&self, aabb: Aabb<i32>, f: impl FnMut(Vec3<i32>, Self::Vox))
       where Self::Vox: Copy { ... }
}

A volume that provides read access to its voxel data.

Required Methods

fn get(&self, pos: Vec3<i32>) -> Result<&Self::Vox, Self::Error>

Get a reference to the voxel at the provided position in the volume.

Provided Methods

fn get_unchecked(&self, pos: Vec3<i32>) -> &Self::Vox

Get a reference to the voxel at the provided position in the volume. Many volumes provide a fast path, provided the position is always in-bounds. Note that this function is still safe.

fn ray( &self, from: Vec3<f32>, to: Vec3<f32>, ) -> Ray<'_, Self, fn(&Self::Vox) -> bool, fn(&Self::Vox, Vec3<i32>)>

where Self: Sized,

NOTE: By default, this ray will simply run from from to to without stopping. To make something interesting happen, call until or for_each.

fn for_each_in(&self, aabb: Aabb<i32>, f: impl FnMut(Vec3<i32>, Self::Vox))

where Self::Vox: Copy,

Call provided closure with each block in the supplied Aabb Portions of the Aabb outside the volume are ignored

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementations on Foreign Types

impl<T: ReadVol> ReadVol for &T

fn get(&self, pos: Vec3<i32>) -> Result<&Self::Vox, Self::Error>

Implementors

impl ReadVol for Structure

impl<V, M, A: Access> ReadVol for Dyna<V, M, A>

impl<V, S: RectVolSize, M: Clone> ReadVol for Chonk<V, S, M>

impl<V, S: VolSize, M> ReadVol for Chunk<V, S, M>

impl<V: RasterableVol + ReadVol + Debug> ReadVol for VolGrid3d<V>

impl<V: ReadVol> ReadVol for Scaled<V>

where V::Vox: FilledVox,

impl<V: RectRasterableVol + ReadVol + Debug> ReadVol for VolGrid2d<V>