Struct VoxelData

pub struct VoxelData {
    pub linear_id: VoxelIndex,
    pub grid_coords: Point<i32>,
    pub center: Point<f32>,
    pub state: VoxelState,
}

Information associated to a voxel.

This structure provides complete information about a single voxel including its position in both grid coordinates and world space, as well as its state (empty/filled and neighborhood).

Note

The linear_id field is an internal implementation detail that can become invalidated when the voxel structure is modified (e.g., via Voxels::set_voxel or Voxels::crop). For stable references to voxels, always use grid_coords.

Examples

use parry3d::shape::Voxels;
use nalgebra::{Point3, Vector3};

let voxels = Voxels::new(
    Vector3::new(0.5, 0.5, 0.5),
    &[Point3::new(0, 0, 0), Point3::new(1, 0, 0)],
);

// Iterate through all voxels
for voxel in voxels.voxels() {
    if !voxel.state.is_empty() {
        println!("Voxel at grid position {:?}", voxel.grid_coords);
        println!("  World center: {:?}", voxel.center);
        println!("  Type: {:?}", voxel.state.voxel_type());
    }
}

Fields

linear_id: VoxelIndex

The temporary index in the internal voxels’ storage.

This index can be invalidated after a call to Voxels::set_voxel, or Voxels::crop.

grid_coords: Point<i32>

The voxel’s integer grid coordinates.

center: Point<f32>

The voxel’s center position in the local-space of the Voxels shape it is part of.

state: VoxelState

The voxel’s state, indicating if it’s empty or full.

Trait Implementations

impl Clone for VoxelData

fn clone(&self) -> VoxelData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoxelData

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for VoxelData

fn eq(&self, other: &VoxelData) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for VoxelData

impl StructuralPartialEq for VoxelData