Struct Voxel

pub struct Voxel {
    pub coords: Point<u32>,
    pub is_on_surface: bool,
    /* private fields */
}

A single voxel in a voxel grid.

A voxel represents a cubic (or square in 2D) cell in a discrete grid. Each voxel is identified by its integer grid coordinates and contains metadata about its position relative to the voxelized shape.

Fields

• coords: The grid position (i, j) in 2D or (i, j, k) in 3D. These are integer coordinates in the voxel grid, not world-space coordinates.

• is_on_surface: Whether this voxel intersects the surface boundary of the shape. If false, the voxel is completely inside the shape (only possible when using FillMode::FloodFill).

Example

use parry3d::transformation::voxelization::{FillMode, VoxelSet};
use parry3d::shape::Ball;
///
let ball = Ball::new(1.0);
let (vertices, indices) = ball.to_trimesh(10, 10);

let voxels = VoxelSet::voxelize(
    &vertices,
    &indices,
    8,
    FillMode::FloodFill { detect_cavities: false },
    false,
);

// Examine individual voxels
for voxel in voxels.voxels() {
    // Grid coordinates (integer position in the voxel grid)
    println!("Grid position: {:?}", voxel.coords);

    // World-space position (actual 3D coordinates)
    let world_pos = voxels.get_voxel_point(voxel);
    println!("World position: {:?}", world_pos);

    // Surface vs interior
    if voxel.is_on_surface {
        println!("This voxel is on the surface boundary");
    } else {
        println!("This voxel is inside the shape");
    }
}

Fields

coords: Point<u32>

The integer coordinates of the voxel as part of the voxel grid.

is_on_surface: bool

Is this voxel on the surface of the volume (i.e. not inside of it)?

Trait Implementations

impl Clone for Voxel

fn clone(&self) -> Voxel

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Voxel

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

Formats the value using the given formatter.

impl Default for Voxel

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Voxel