Struct Space

pub struct Space {
    pub coords: Vec2<i32>,
    pub width: usize,
    pub shape: Vec3<usize>,
    pub min: Vec3<i32>,
    pub options: SpaceOptions,
    pub updated_levels: HashSet<u32>,
    /* private fields */
}

A data structure used in Voxelize to access voxel data of multiple chunks at the same time. Centered with one chunk, a Space allows developers to know what’s around a chunk.

Construct a space by calling chunks.make_space.

Fields

coords: Vec2<i32>

Chunk coordinate of the center chunk of the space.

width: usize

Width of the space.

shape: Vec3<usize>

Shape of the space.

min: Vec3<i32>

Minimum voxel coordinate of the space.

options: SpaceOptions

Parameters to construct the space.

updated_levels: HashSet<u32>

A set of sub-chunks that have been updated.

Trait Implementations

impl Clone for Space

fn clone(&self) -> Space

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Space

fn default() -> Space

Returns the “default value” for a type.

impl VoxelAccess for Space

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

Get the raw voxel data at the voxel position. Zero is returned if chunk doesn’t exist. Panics if space does not contain voxel data.

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

Get the voxel type at the voxel position. Zero is returned if chunk doesn’t exist. Panics if space does not contain voxel data.

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

Get the voxel rotation at the voxel position. Zero is returned if chunk doesn’t exist. Panics if space does not contain voxel data.

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

Get the voxel stage at the voxel position. Zero is returned if chunk doesn’t exist. Panics if space does not contain voxel data.

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

Get the raw light level at the voxel position. Zero is returned if chunk doesn’t exist. Panics if space does not contain lighting data.

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

Set the raw light level at the voxel position. Returns false if chunk doesn’t exist.

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

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

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

Get the max height at the voxel column. Zero is returned if column doesn’t exist.

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

Get a reference of lighting n-dimensional array.

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

Check if space contains this coordinate

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

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

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 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 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 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 get_voxels(&self, cx: i32, cz: i32) -> Option<&Ndarray<u32>>

Get a reference of voxel n-dimensional array.