Struct voxelize::world::space::Space

pub struct Space {
    pub coords: Vec2<i32>,
    pub width: usize,
    pub shape: Vec3<usize>,
    pub min: Vec3<i32>,
    pub params: SpaceParams,
    /* 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.

params: SpaceParams

Parameters to construct the space.

Implementations

impl Space

pub 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.

pub 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.

pub 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.

pub 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.

pub 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.

pub fn set_raw_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32)

Set the raw light level at the voxel position. Does nothing if chunk doesn’t exist. Panics if space does not contain lighting data.

pub 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. Panics if space does not contain lighting data.

pub fn set_sunlight(&mut self, vx: i32, vy: i32, vz: i32, level: u32)

Set the sunlight level at the voxel position. Does nothing if chunk doesn’t exist. Panics if space does not contain lighting data.

pub 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. Panics if space does not contain lighting data.

pub fn set_red_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32)

Set the red light level at the voxel position. Does nothing if chunk doesn’t exist. Panics if space does not contain lighting data.

pub 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. Panics if space does not contain lighting data.

pub fn set_green_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32)

Set the green light level at the voxel position. Does nothing if chunk doesn’t exist. Panics if space does not contain lighting data.

pub 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. Panics if space does not contain lighting data.

pub fn set_blue_light(&mut self, vx: i32, vy: i32, vz: i32, level: u32)

Set the blue light level at the voxel position. Does nothing if chunk doesn’t exist. Panics if space does not contain lighting data.

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

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

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

Set the torch light level of a color at the voxel position. Does nothing if chunk doesn’t exist. Panics if space does not contain lighting data.

pub 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. Panics if height map data does not exist.

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

Get a reference of lighting n-dimensional array.

Trait Implementations

impl Clone for Space

fn clone(&self) -> Space

Returns a copy 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.