Struct veloren_common::volumes::vol_grid_2d::VolGrid2d

pub struct VolGrid2d<V: RectRasterableVol> {
    map_size_lg: MapSizeLg,
    default: Arc<V>,
    chunks: HashMap<Vec2<i32>, Arc<V>, GridHasher>,
}

Fields

map_size_lg: MapSizeLg

Size of the entire (not just loaded) map.

default: Arc<V>

Default voxel for use outside of max map bounds.

chunks: HashMap<Vec2<i32>, Arc<V>, GridHasher>

Implementations

impl VolGrid2d<Chonk<Block, TerrainChunkSize, TerrainChunkMeta>>

pub fn find_ground(&self, pos: Vec3<i32>) -> Vec3<i32>

Find a location suitable for spawning an entity near the given position (but in the same chunk).

pub fn is_space(&self, pos: Vec3<i32>) -> bool

pub fn try_find_space(&self, pos: Vec3<i32>) -> Option<Vec3<i32>>

pub fn try_find_ground(&self, pos: Vec3<i32>) -> Option<Vec3<i32>>

pub fn get_interpolated<T, F>(&self, pos: Vec2<i32>, f: F) -> Option<T>

where T: Copy + Default + Add<Output = T> + Mul<f32, Output = T>, F: FnMut(&TerrainChunk) -> T,

impl<V: RectRasterableVol> VolGrid2d<V>

pub fn chunk_key<P: Into<Vec2<i32>>>(pos: P) -> Vec2<i32>

pub fn key_chunk<K: Into<Vec2<i32>>>(key: K) -> Vec2<i32>

pub fn par_keys(&self) -> ParKeys<'_, Vec2<i32>, Arc<V>>

where V: Send + Sync,

pub fn chunk_offs(pos: Vec3<i32>) -> Vec3<i32>

impl<V: RectRasterableVol> VolGrid2d<V>

pub fn new( map_size_lg: MapSizeLg, default: Arc<V> ) -> Result<Self, VolGrid2dError<V>>

pub fn chunk_size() -> Vec2<u32>

pub fn insert(&mut self, key: Vec2<i32>, chunk: Arc<V>) -> Option<Arc<V>>

pub fn get_key(&self, key: Vec2<i32>) -> Option<&V>

pub fn get_key_real(&self, key: Vec2<i32>) -> Option<&V>

pub fn contains_key(&self, key: Vec2<i32>) -> bool

pub fn contains_key_real(&self, key: Vec2<i32>) -> bool

pub fn get_key_arc(&self, key: Vec2<i32>) -> Option<&Arc<V>>

pub fn get_key_arc_real(&self, key: Vec2<i32>) -> Option<&Arc<V>>

pub fn clear(&mut self)

pub fn drain(&mut self) -> Drain<'_, Vec2<i32>, Arc<V>>

pub fn remove(&mut self, key: Vec2<i32>) -> Option<Arc<V>>

pub fn key_pos(&self, key: Vec2<i32>) -> Vec2<i32>

Converts a chunk key (i.e. coordinates in terms of chunks) into a position in the world (aka “wpos”).

The returned position will be in the corner of the chunk.

pub fn pos_key(&self, pos: Vec3<i32>) -> Vec2<i32>

Converts a position in the world into a chunk key (i.e. coordinates in terms of chunks).

pub fn pos_chunk(&self, pos: Vec3<i32>) -> Option<&V>

Gets the chunk that contains the provided world position.

pub fn iter(&self) -> ChunkIter<'_, V>

pub fn cached(&self) -> CachedVolGrid2d<'_, V>

Trait Implementations

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

type Error = VolGrid2dError<V>

type Vox = <V as BaseVol>::Vox

fn scaled_by(self, scale: Vec3<f32>) -> Scaled<Self>

where Self: Sized,

impl<V: Clone + RectRasterableVol> Clone for VolGrid2d<V>

fn clone(&self) -> VolGrid2d<V>

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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 Areas outside loaded chunks are ignored

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

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

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.

impl<I: Into<Aabr<i32>>, V: RectRasterableVol + ReadVol + Debug> SampleVol<I> for VolGrid2d<V>

fn sample(&self, range: I) -> Result<Self::Sample, VolGrid2dError<V>>

Take a sample of the terrain by cloning the voxels within the provided range.

Note that the resultant volume does not carry forward metadata from the original chunks.

type Sample = VolGrid2d<V>

impl<V: RectRasterableVol + WriteVol + Clone + Debug> WriteVol for VolGrid2d<V>

fn set( &mut self, pos: Vec3<i32>, vox: V::Vox ) -> Result<V::Vox, VolGrid2dError<V>>

Set the voxel at the provided position in the volume to the provided value.