Struct VoxelState

pub struct VoxelState(/* private fields */);

A description of the local neighborhood of a voxel.

This compact representation stores which immediate neighbors (along coordinate axes) of a voxel are filled. This information is essential for proper collision detection between voxels and other shapes, as it helps avoid the “internal edges problem.”

The state is encoded as a single byte where each pair of bits represents one coordinate axis, indicating whether neighbors in the positive and negative directions are filled.

Special States

• VoxelState::EMPTY: The voxel itself is empty (not part of the shape).
• VoxelState::INTERIOR: All neighbors are filled (completely surrounded voxel).

Examples

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

// Create a simple voxel shape
let voxels = Voxels::new(
    Vector3::new(1.0, 1.0, 1.0),
    &[Point3::new(0, 0, 0), Point3::new(1, 0, 0)],
);

// Query the state of a voxel
let state = voxels.voxel_state(Point3::new(0, 0, 0)).unwrap();

// Check if empty
assert!(!state.is_empty());

// Get which faces are exposed (not adjacent to other voxels)
let free_faces = state.free_faces();
if free_faces.contains(AxisMask::X_NEG) {
    println!("The -X face is exposed");
}

// Get the voxel type based on neighborhood
println!("Voxel type: {:?}", state.voxel_type());

Implementations

impl VoxelState

pub const EMPTY: VoxelState

The value of empty voxels.

pub const INTERIOR: VoxelState

The value of a voxel with non-empty neighbors in all directions.

pub const fn is_empty(self) -> bool

Is this voxel empty?

pub const fn free_faces(self) -> AxisMask

A bit mask indicating which faces of the voxel don’t have any adjacent non-empty voxel.

pub const fn voxel_type(self) -> VoxelType

The VoxelType of this voxel.

Trait Implementations

impl Clone for VoxelState

fn clone(&self) -> VoxelState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoxelState

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

Formats the value using the given formatter.

impl PartialEq for VoxelState

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

impl Eq for VoxelState

impl StructuralPartialEq for VoxelState