voxelis 25.4.0

Sparse Voxel Octree DAG engine for building worlds, shaping matter, and mastering 3D space — powered by pure Rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276

use glam::IVec3;

use crate::{BlockId, MaxDepth, TraversalDepth, VoxInterner, VoxelTrait};

#[inline(always)]
pub const fn child_index(position: &IVec3, depth: &TraversalDepth) -> usize {
    let shift = depth.max() - depth.current() - 1;

    ((position.x as usize >> shift) & 1)
        | (((position.y as usize >> shift) & 1) << 1)
        | (((position.z as usize >> shift) & 1) << 2)
}

#[inline(always)]
pub const fn child_index2(position: &IVec3, current: usize, max: usize) -> usize {
    let shift = max - current - 1;

    ((position.x as usize >> shift) & 1)
        | (((position.y as usize >> shift) & 1) << 1)
        | (((position.z as usize >> shift) & 1) << 2)
}

#[inline(always)]
pub const fn encode_child_index_path(position: &IVec3) -> u32 {
    const MASK_10_BITS: u32 = 0x000003FF; // Mask for lower 10 bits
    const MASK_1: u32 = 0x30000FF;
    const MASK_2: u32 = 0x300F00F;
    const MASK_3: u32 = 0x30C30C3;
    const MASK_4: u32 = 0x9249249;

    let x = (position.x as u32) & MASK_10_BITS;
    let y = (position.y as u32) & MASK_10_BITS;
    let z = (position.z as u32) & MASK_10_BITS;

    // Split x bits using magic shifts and masks
    let x = (x | (x << 16)) & MASK_1;
    let x = (x | (x << 8)) & MASK_2;
    let x = (x | (x << 4)) & MASK_3;
    let x = (x | (x << 2)) & MASK_4;

    // Split y bits
    let y = (y | (y << 16)) & MASK_1;
    let y = (y | (y << 8)) & MASK_2;
    let y = (y | (y << 4)) & MASK_3;
    let y = (y | (y << 2)) & MASK_4;

    // Split z bits
    let z = (z | (z << 16)) & MASK_1;
    let z = (z | (z << 8)) & MASK_2;
    let z = (z | (z << 4)) & MASK_3;
    let z = (z | (z << 2)) & MASK_4;

    // Combine results - x at positions 3n, y at 3n+1, z at 3n+2
    x | (y << 1) | (z << 2)
}

#[macro_export]
macro_rules! encode_child_index_path_macro {
    ($position:expr) => {{
        const MASK_10_BITS: u32 = 0x000003FF; // Mask for lower 10 bits
        const MASK_1: u32 = 0x30000FF;
        const MASK_2: u32 = 0x300F00F;
        const MASK_3: u32 = 0x30C30C3;
        const MASK_4: u32 = 0x9249249;

        let x = ($position.x as u32) & MASK_10_BITS;
        let y = ($position.y as u32) & MASK_10_BITS;
        let z = ($position.z as u32) & MASK_10_BITS;

        // Split x bits using magic shifts and masks
        let x = (x | (x << 16)) & MASK_1;
        let x = (x | (x << 8)) & MASK_2;
        let x = (x | (x << 4)) & MASK_3;
        let x = (x | (x << 2)) & MASK_4;

        // Split y bits
        let y = (y | (y << 16)) & MASK_1;
        let y = (y | (y << 8)) & MASK_2;
        let y = (y | (y << 4)) & MASK_3;
        let y = (y | (y << 2)) & MASK_4;

        // Split z bits
        let z = (z | (z << 16)) & MASK_1;
        let z = (z | (z << 8)) & MASK_2;
        let z = (z | (z << 4)) & MASK_3;
        let z = (z | (z << 2)) & MASK_4;

        // Combine results - x at positions 3n, y at 3n+1, z at 3n+2
        x | (y << 1) | (z << 2)
    }};
}

#[macro_export]
macro_rules! child_index_macro {
    ($position:expr, $depth:expr) => {{
        let shift = ($depth.max() - $depth.current() - 1) as usize;
        (((($position).x as usize >> shift) & 1)
            | (((($position).y as usize >> shift) & 1) << 1)
            | (((($position).z as usize >> shift) & 1) << 2))
    }};
}

#[macro_export]
macro_rules! child_index_macro_2 {
    ($position:expr, $current_depth:expr, $max_depth:expr) => {{
        let shift = ($max_depth - $current_depth - 1);
        (((($position).x as usize >> shift) & 1)
            | (((($position).y as usize >> shift) & 1) << 1)
            | (((($position).z as usize >> shift) & 1) << 2))
    }};
}

#[macro_export]
macro_rules! child_index_macro_2d {
    ($position:expr, $current_depth:expr, $max_depth:expr) => {{
        let shift = ($max_depth - $current_depth - 1);
        (((($position).x as usize >> shift) & 1) | (((($position).y as usize >> shift) & 1) << 1))
    }};
}

#[inline(always)]
pub fn get_at_depth<T: VoxelTrait>(
    interner: &VoxInterner<T>,
    mut node_id: BlockId,
    position: &IVec3,
    depth: &TraversalDepth,
) -> Option<T> {
    let max_depth = depth.max();
    let mut depth = depth.current();

    while !node_id.is_empty() {
        if depth >= max_depth {
            return Some(*interner.get_value(&node_id));
        }

        if node_id.is_branch() {
            let index = child_index_macro_2!(position, depth, max_depth);
            node_id = interner.get_child_id(&node_id, index);
            depth += 1;
        } else {
            return Some(*interner.get_value(&node_id));
        }
    }

    None
}

pub fn to_vec<T: VoxelTrait>(
    interner: &VoxInterner<T>,
    root_id: &BlockId,
    max_depth: MaxDepth,
) -> Vec<T> {
    let max_depth = max_depth.max();
    let voxels_per_axis = 1 << max_depth;
    let size: usize = voxels_per_axis * voxels_per_axis * voxels_per_axis;

    if !root_id.is_empty() {
        if root_id.is_branch() {
            let mut data = vec![T::default(); size];
            let shift_y: usize = 1 << (2 * max_depth);
            let shift_z: usize = voxels_per_axis;
            let depth = TraversalDepth::new(0, max_depth);
            let mut pos = IVec3::default();

            for y in 0..voxels_per_axis {
                pos.y = y as i32;
                let base_index_y = y * shift_y;
                for z in 0..voxels_per_axis {
                    pos.z = z as i32;

                    let base_index_z = base_index_y + z * shift_z;
                    for x in 0..voxels_per_axis {
                        pos.x = x as i32;

                        if let Some(voxel) = get_at_depth(interner, *root_id, &pos, &depth) {
                            data[base_index_z + x] = voxel;
                        }
                    }
                }
            }

            data
        } else {
            vec![*interner.get_value(root_id); size]
        }
    } else {
        vec![T::default(); size]
    }
}

pub fn dump_structure<T: VoxelTrait>(
    interner: &VoxInterner<T>,
    root_id: BlockId,
    max_depth: usize,
) {
    println!("\n=== Octree Structure Dump ===");
    println!("Max depth: {}", max_depth);

    if !root_id.is_empty() {
        interner.dump_node(root_id, 0, "  ");
    } else {
        println!("Empty octree (no root)");
    }
    println!("=== End of Structure Dump ===\n");
}

pub fn dump_root<T: VoxelTrait>(interner: &VoxInterner<T>, root_id: BlockId) {
    println!("\n=== Octree Root Dump ===");
    if !root_id.is_empty() {
        interner.dump_node(root_id, 0, "");
    } else {
        println!("Empty octree (no root)");
    }
    println!("=== End of Root Dump ===\n");
}

#[derive(Default)]
struct OctreeStats {
    total_nodes: usize,
    branch_nodes: usize,
    leaf_nodes: usize,
    max_depth_reached: u8,
    nodes_by_depth: Vec<usize>,
}

pub fn dump_statistics<T: VoxelTrait>(interner: &VoxInterner<T>, root_id: BlockId) {
    println!("\n=== Octree Statistics ===");
    if !root_id.is_empty() {
        let mut stats = OctreeStats::default();
        collect_stats(interner, root_id, 0, &mut stats);
        println!("Total nodes: {}", stats.total_nodes);
        println!("Branch nodes: {}", stats.branch_nodes);
        println!("Leaf nodes: {}", stats.leaf_nodes);
        println!("Max depth reached: {}", stats.max_depth_reached);
        println!("Nodes by depth:");
        for (depth, count) in stats.nodes_by_depth.iter().enumerate() {
            println!("  Depth {}: {} nodes", depth, count);
        }
    } else {
        println!("Empty octree (no statistics available)");
    }
    println!("=== End of Statistics ===\n");
}

fn collect_stats<T: VoxelTrait>(
    interner: &VoxInterner<T>,
    node_id: BlockId,
    depth: u8,
    stats: &mut OctreeStats,
) {
    stats.total_nodes += 1;

    // Ensure we have enough space in nodes_by_depth
    while stats.nodes_by_depth.len() <= depth as usize {
        stats.nodes_by_depth.push(0);
    }
    stats.nodes_by_depth[depth as usize] += 1;

    // Update max depth
    stats.max_depth_reached = stats.max_depth_reached.max(depth);

    match node_id.is_leaf() {
        true => {
            stats.leaf_nodes += 1;
        }
        false => {
            stats.branch_nodes += 1;
            let children = interner.get_children(&node_id);
            for child in children.iter() {
                if !child.is_empty() {
                    collect_stats(interner, *child, depth + 1, stats);
                }
            }
        }
    }
}