Struct voxelize::Chunks

pub struct Chunks {
    pub map: HashMap<Vec2<i32>, Chunk>,
    pub to_update: VecDeque<BlockChange>,
    pub to_remesh: VecDeque<Vec2<i32>>,
    pub to_send: VecDeque<(Vec2<i32>, MessageType)>,
    pub to_save: VecDeque<Vec2<i32>>,
    pub cache: HashSet<Vec2<i32>>,
    /* private fields */
}

A manager for all chunks in the Voxelize world.

Fields

map: HashMap<Vec2<i32>, Chunk>

A map of all the chunks, coords -> Chunk.

to_update: VecDeque<BlockChange>

Voxel updates waiting to be processed.

to_remesh: VecDeque<Vec2<i32>>

A list of chunks that are to be remeshed (light + mesh).

to_send: VecDeque<(Vec2<i32>, MessageType)>

A list of chunks that are done meshing and ready to be sent.

to_save: VecDeque<Vec2<i32>>

A list of chunks that are done meshing and ready to be saved, if config.save is true.

cache: HashSet<Vec2<i32>>

A cache of what chunks has been borrowed mutable.

Implementations

impl Chunks

pub fn new(config: &WorldConfig) -> Self

Create a new instance of a chunk manager.

pub fn try_load(&mut self, coords: &Vec2<i32>) -> Option<Chunk>

pub fn save(&self, coords: &Vec2<i32>) -> bool

pub fn renew(&mut self, chunk: Chunk)

Update a chunk, removing the old chunk instance and updating with a new one.

pub fn add(&mut self, chunk: Chunk)

Add a new chunk, synonym for chunks.renew

pub fn raw(&self, coords: &Vec2<i32>) -> Option<&Chunk>

Get raw chunk data.

pub fn raw_mut(&mut self, coords: &Vec2<i32>) -> Option<&mut Chunk>

Get raw mutable chunk data.

pub fn get(&self, coords: &Vec2<i32>) -> Option<&Chunk>

Get a chunk at a chunk coordinate. Keep in mind that this function only returns a chunk if the chunk has been fully instantiated and meshed. None is returned if not.

pub fn get_mut(&mut self, coords: &Vec2<i32>) -> Option<&mut Chunk>

Get a mutable chunk reference at a chunk coordinate. Keep in mind that this function only returns a chunk if the chunk has been fully instantiated and meshed. None is returned if not.

pub fn raw_chunk_by_voxel(&self, vx: i32, vy: i32, vz: i32) -> Option<&Chunk>

pub fn raw_chunk_by_voxel_mut(
    &mut self,
    vx: i32,
    vy: i32,
    vz: i32
) -> Option<&mut Chunk>

Get a mutable chunk by voxel coordinates. Returns a chunk even if chunk isn’t fully instantiated.

pub fn voxel_affected_chunks(&self, vx: i32, vy: i32, vz: i32) -> Vec<Vec2<i32>>

Get neighboring coords of a voxel coordinate.

pub fn light_traversed_chunks(&self, coords: &Vec2<i32>) -> Vec<Vec2<i32>>

Get a list of chunks that light could traverse within.

pub fn make_space<'a>(
    &'a self,
    coords: &Vec2<i32>,
    margin: usize
) -> SpaceBuilder<'a>

Create a voxel querying space around a chunk coordinate.

Example

// Create a space that has all voxel/light/height_map data.
let space = Chunks::make_space(0, 0, 15).needs_all().build();

pub fn is_within_world(&self, coords: &Vec2<i32>) -> bool

Check to see if chunk is within the world’s min/max chunk.

pub fn is_chunk_ready(&self, coords: &Vec2<i32>) -> bool

Guard to getting a chunk, only allowing chunks to be accessed when they’re ready.

pub fn clear_cache(&mut self)

Clear the mutable chunk borrowing list.

Trait Implementations

impl Default for Chunks

fn default() -> Chunks

Returns the “default value” for a type.

impl VoxelAccess for Chunks

fn get_raw_voxel(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the raw voxel value at a voxel coordinate. If chunk not found, 0 is returned.

fn set_raw_voxel(&mut self, vx: i32, vy: i32, vz: i32, id: u32) -> bool

Set the raw voxel value at a voxel coordinate. Returns false couldn’t set.

fn get_raw_light(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the raw light value at a voxel coordinate. If chunk not found, 0 is returned.

fn set_raw_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32) -> bool

Set the raw light level at a voxel coordinate. Returns false couldn’t set.

fn get_sunlight(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the sunlight level at a voxel position. Returns 0 if chunk does not exist.

fn get_max_height(&self, vx: i32, vz: i32) -> u32

Get the max height at a voxel column. Returns 0 if column does not exist.

fn set_max_height(&mut self, vx: i32, vz: i32, height: u32) -> bool

Set the max height at a voxel column. Does nothing if column does not exist.

fn contains(&self, vx: i32, vy: i32, vz: i32) -> bool

Checks to see if the voxel is contained within the voxel acces.

fn get_voxel(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the voxel ID at a voxel coordinate. If chunk not found, 0 is returned.

fn set_voxel(&mut self, vx: i32, vy: i32, vz: i32, id: u32) -> bool

Set the voxel type at a voxel coordinate. Returns false couldn’t set.

fn get_voxel_rotation(&self, vx: i32, vy: i32, vz: i32) -> BlockRotation

Get the voxel rotation at a voxel coordinate. Panics if chunk isn’t found.

fn set_voxel_rotation(
    &mut self,
    vx: i32,
    vy: i32,
    vz: i32,
    rotation: &BlockRotation
) -> bool

Set the voxel rotation at a voxel coordinate. Does nothing if chunk isn’t found.

fn get_voxel_stage(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the voxel stage at a voxel coordinate. Panics if chunk isn’t found.

fn set_voxel_stage(&mut self, vx: i32, vy: i32, vz: i32, stage: u32) -> bool

Set the voxel stage at a voxel coordinate. Does nothing if chunk isn’t found.

fn set_sunlight(&mut self, vx: i32, vy: i32, vz: i32, level: u32) -> bool

Set the sunlight level at a voxel coordinate. Returns false if could not set.

fn get_red_light(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the red light level at the voxel position. Zero is returned if chunk doesn’t exist.

fn set_red_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32) -> bool

Set the red light level at the voxel position. Returns false if could not set.

fn get_green_light(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the green light level at the voxel position. Zero is returned if chunk doesn’t exist.

fn set_green_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32) -> bool

Set the green light level at the voxel position. Returns false if could not set.

fn get_blue_light(&self, vx: i32, vy: i32, vz: i32) -> u32

Get the blue light level at the voxel position. Zero is returned if chunk doesn’t exist.

fn set_blue_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32) -> bool

Set the blue light level at the voxel position. Returns false if could not set.

fn get_torch_light(&self, vx: i32, vy: i32, vz: i32, color: &LightColor) -> u32

Get the torch light level by color at a voxel coordinate. Returns 0 if chunk does not exist.

fn set_torch_light(
    &mut self,
    vx: i32,
    vy: i32,
    vz: i32,
    level: u32,
    color: &LightColor
) -> bool

Set the torch light level by color at a voxel coordinate. Returns false if could not set.

fn get_voxels(&self, cx: i32, cz: i32) -> Option<&Ndarray<u32>>

Get a reference of voxel n-dimensional array.

fn get_lights(&self, cx: i32, cz: i32) -> Option<&Ndarray<u32>>

Get a reference of lighting n-dimensional array.