Struct OctreeChunkIndex 

pub struct OctreeChunkIndex {
    pub superchunk_octrees: ChunkedOctreeSet,
    /* private fields */
}

A ChunkedOctreeSet that indexes the chunks of a ChunkMap. Useful for representing a clipmap.

Fields

superchunk_octrees: ChunkedOctreeSet

An unbounded set of chunk keys, but scaled down to be contiguous. For example, if the chunk shape is 16^3, then the chunk key [16, 32, -64] is represented as point [1, 2, -4] in this set.

Implementations

impl OctreeChunkIndex

pub fn chunk_shape(&self) -> PointN<[i32; 3]>

The shape of the world extent convered by a single chunk (a leaf of an octree).

pub fn superchunk_shape(&self) -> PointN<[i32; 3]>

The shape of the world extent covered by a single octree, i.e. all of its chunks when full.

pub fn index_chunk_map<T, Ch, Store>( superchunk_shape: PointN<[i32; 3]>, chunk_map: &ChunkMap<[i32; 3], T, Ch, Store>, ) -> OctreeChunkIndex

where Store: for<'r> IterChunkKeys<'r, [i32; 3]>,

Same as index_lod0_chunks, but using the chunk keys and chunk shape from chunk_map.

pub fn index_lod0_chunks<'a>( superchunk_shape: PointN<[i32; 3]>, chunk_shape: PointN<[i32; 3]>, chunk_keys: impl Iterator<Item = &'a ChunkKey<[i32; 3]>>, ) -> OctreeChunkIndex

Create a new OctreeChunkIndex whose octrees contain exactly the set chunk_keys. The number of levels in an octree corresponds to the relative sizes of the chunks and superchunks. A superchunk is a chunk of the domain that contains a single octree of many smaller chunks. Superchunk shape, like chunk shape, must have all dimensions be powers of 2. Because of the static limitations on OctreeSet size, you can only have up to 6 levels of detail. This means superchunk_shape / chunk_shape must be less than 2 ^ [6, 6, 6] = [64, 64, 64]. For example, if your chunk shape is [16, 16, 16], then your superchunk shape can be at most [512, 512, 512].

pub fn clipmap_config(&self, clip_box_radius: u16) -> ClipMapConfig3

pub fn active_clipmap_lod_chunks( &self, extent: &ExtentN<[i32; 3]>, clip_box_radius: u16, lod0_center: ChunkUnits<[i32; 3]>, init_rx: impl FnMut(ChunkKey<[i32; 3]>), )

Traverses all octree nodes overlapping extent to find the ChunkKey3s that are “active” when the clipmap is centered at lod0_center.

pub fn find_clipmap_chunk_updates( &self, extent: &ExtentN<[i32; 3]>, clip_box_radius: u16, old_lod0_center: ChunkUnits<[i32; 3]>, new_lod0_center: ChunkUnits<[i32; 3]>, update_rx: impl FnMut(LodChunkUpdate<[i32; 3]>), )

Trait Implementations

impl Clone for OctreeChunkIndex

fn clone(&self) -> OctreeChunkIndex

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for OctreeChunkIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for OctreeChunkIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.