Enum VoxelType

pub enum VoxelType {
    Empty,
    Vertex,
    Face,
    Interior,
}

Categorization of a voxel based on its neighbors.

This enum describes the local topology of a filled voxel by examining which of its immediate neighbors (along coordinate axes) are also filled. This information is crucial for collision detection to avoid the “internal edges problem” where objects can get caught on edges between adjacent voxels.

Type Classification

• Empty: The voxel is not filled.
• Interior: All axis-aligned neighbors are filled (safest for collision).
• Face: Missing neighbors in one coordinate direction (e.g., top face exposed).
• Edge (3D only): Missing neighbors in two coordinate directions (e.g., corner edge exposed).
• Vertex: Missing neighbors in all coordinate directions (isolated corner).

Examples

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

// Create a small 2x2x2 cube of voxels
let voxels = Voxels::new(
    Vector3::new(1.0, 1.0, 1.0),
    &[
        Point3::new(0, 0, 0),
        Point3::new(1, 0, 0),
        Point3::new(0, 1, 0),
        Point3::new(1, 1, 0),
        Point3::new(0, 0, 1),
        Point3::new(1, 0, 1),
        Point3::new(0, 1, 1),
        Point3::new(1, 1, 1),
    ],
);

// Check voxel type - interior voxels are fully surrounded
let state = voxels.voxel_state(Point3::new(0, 0, 0)).unwrap();
let voxel_type = state.voxel_type();
println!("Voxel type: {:?}", voxel_type);

Variants

Empty

The voxel is empty.

Vertex

The voxel is a vertex if all three coordinate axis directions have at least one empty neighbor.

Face

The voxel is on an edge if it has non-empty neighbors in both directions of two coordinate axes.

Interior

The voxel is on an edge if it has non-empty neighbors in both directions of all coordinate axes.

Trait Implementations

impl Clone for VoxelType

fn clone(&self) -> VoxelType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoxelType

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

Formats the value using the given formatter.

impl PartialEq for VoxelType

fn eq(&self, other: &VoxelType) -> 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 VoxelType

impl Eq for VoxelType

impl StructuralPartialEq for VoxelType