dynamis-world 0.7.0

Host scene registry, step orchestration, and readback
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
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
use super::arena::{Arena, Run, merged};
use super::ids::IdSpace;
use bytemuck::Zeroable;
use dynamis_abi::{BvhNodeRecord, SurfaceRecord, TriangleRecord};
use dynamis_model::{ShapeSourceHandle, SolidGeometry, SurfaceDesc, SurfaceTable};
use dynamis_state::ShapeCapacity;
use dynamis_state::{TRIANGLE_BYTES, VERTEX_BYTES};
use std::mem::size_of;

#[derive(Clone)]
struct Geometry<T> {
    arena: Arena,
    rows: Vec<T>,
    dirty: Vec<Run>,
}

impl<T: Copy> Geometry<T> {
    const fn new() -> Self {
        Self {
            arena: Arena::new(),
            rows: Vec::new(),
            dirty: Vec::new(),
        }
    }

    fn used(&self) -> u32 {
        self.arena.used()
    }

    fn slice(&self, run: Run) -> &[T] {
        &self.rows[run.span()]
    }

    fn take(&mut self, blank: T, values: &[T]) -> Run {
        if values.is_empty() {
            return Run::EMPTY;
        }
        let run = self.arena.take(values.len() as u32);
        self.rows.resize(self.arena.used() as usize, blank);
        self.rows[run.span()].copy_from_slice(values);
        self.dirty.push(run);
        run
    }

    fn rewrite(&mut self, run: Run, blank: T, values: &[T]) -> Run {
        if values.is_empty() {
            self.release(run, blank);
            return Run::EMPTY;
        }
        if run.len as usize == values.len() {
            self.rows[run.span()].copy_from_slice(values);
            self.dirty.push(run);
            return run;
        }
        self.release(run, blank);
        self.take(blank, values)
    }

    fn release(&mut self, run: Run, blank: T) {
        if run.len == 0 {
            return;
        }
        self.rows[run.span()].fill(blank);
        self.arena.release(run);
        self.rows.truncate(self.arena.used() as usize);
    }

    fn take_dirty(&mut self) -> Vec<Run> {
        merged(std::mem::take(&mut self.dirty), self.arena.used())
    }
}

#[derive(Clone, Copy)]
struct Source {
    kind: u32,
    vertices: Run,
    triangles: Run,
    nodes: Run,
    palette: Run,
    bounds: ([f32; 3], [f32; 3]),
    solid: Option<SolidGeometry>,
}

impl Source {
    const DEAD: Self = Self {
        kind: 0,
        vertices: Run::EMPTY,
        triangles: Run::EMPTY,
        nodes: Run::EMPTY,
        palette: Run::EMPTY,
        bounds: ([0.0; 3], [0.0; 3]),
        solid: None,
    };

    fn alive(&self) -> bool {
        self.kind != 0
    }
}

#[derive(Clone)]
pub(crate) struct ShapePool {
    ids: IdSpace,
    refs: Vec<u32>,
    sources: Vec<Source>,
    vertices: Geometry<[f32; 4]>,
    triangles: Geometry<TriangleRecord>,
    nodes: Geometry<BvhNodeRecord>,
    palettes: Geometry<SurfaceRecord>,
}

impl ShapePool {
    pub(crate) const fn new() -> Self {
        Self {
            ids: IdSpace::new(),
            refs: Vec::new(),
            sources: Vec::new(),
            vertices: Geometry::new(),
            triangles: Geometry::new(),
            nodes: Geometry::new(),
            palettes: Geometry::new(),
        }
    }

    pub(crate) fn used(&self) -> ShapeCapacity {
        ShapeCapacity {
            sources: self.sources.len() as u32,
            vertices: self.vertices.used(),
            triangles: self.triangles.used(),
            nodes: self.nodes.used(),
        }
    }

    pub(crate) fn source_surface(&self, source: u32, index: u32) -> SurfaceDesc {
        let source = self
            .sources
            .get(source as usize)
            .filter(|source| source.alive())
            .unwrap_or_else(|| panic!("shape source {source} is not alive"));
        assert!(
            index < source.palette.len,
            "surface index {index} is outside the shape source palette"
        );
        self.palettes.rows[source.palette.offset as usize + index as usize].desc()
    }

    pub(crate) fn solid(&self, handle: ShapeSourceHandle) -> SolidGeometry {
        self.source(handle)
            .solid
            .expect("a hull shape source carries its solid geometry")
    }

    fn source(&self, handle: ShapeSourceHandle) -> &Source {
        let source = self
            .sources
            .get(handle.id as usize)
            .unwrap_or_else(|| panic!("shape source handle {handle:?} is out of range"));
        assert!(
            self.ids.generation(handle.id) == handle.generation,
            "shape source handle {handle:?} is stale"
        );
        assert!(
            source.alive(),
            "shape source handle {handle:?} is not alive"
        );
        source
    }

    fn grow_to(&mut self, id: u32) {
        if self.sources.len() > id as usize {
            return;
        }
        self.refs.resize(id as usize + 1, 0);
        self.sources.resize(id as usize + 1, Source::DEAD);
    }

    pub(crate) fn retain(&mut self, handle: ShapeSourceHandle) {
        self.source(handle);
        self.refs[handle.id as usize] += 1;
    }

    pub(crate) fn release(&mut self, handle: ShapeSourceHandle) {
        self.source(handle);
        assert!(
            self.refs[handle.id as usize] > 0,
            "shape source refcount underflow"
        );
        self.refs[handle.id as usize] -= 1;
    }

    pub(crate) fn remove(&mut self, handle: ShapeSourceHandle) {
        let id = handle.id as usize;
        let source = *self.source(handle);
        assert!(
            self.refs[id] == 0,
            "shape source is still referenced by a live body"
        );
        self.vertices.release(source.vertices, [0.0; 4]);
        self.triangles
            .release(source.triangles, TriangleRecord::zeroed());
        self.nodes.release(source.nodes, BvhNodeRecord::zeroed());
        self.palettes
            .release(source.palette, SurfaceRecord::zeroed());
        self.sources[id] = Source::DEAD;
        self.ids.release(handle.id);
    }

    pub(crate) fn allocate(
        &mut self,
        kind: u32,
        vertices: &[[f32; 3]],
        triangles: &[[u32; 3]],
        surfaces: Option<SurfaceTable<'_>>,
    ) -> ShapeSourceHandle {
        validate_geometry(kind, vertices, triangles, surfaces);
        let nodes = build_bvh(vertices, triangles);
        let bounds = bounds_of(vertices);
        let (id, generation) = self.ids.acquire();
        self.grow_to(id);
        let vertex_rows = vertex_rows(vertices);
        let triangle_rows = triangle_rows(triangles, surfaces);
        let palette_rows = palette_rows(surfaces);
        let vertex_run = self.vertices.take([0.0; 4], &vertex_rows);
        let triangle_run = self
            .triangles
            .take(TriangleRecord::zeroed(), &triangle_rows);
        let node_run = self.nodes.take(BvhNodeRecord::zeroed(), &nodes);
        let palette_run = self.palettes.take(SurfaceRecord::zeroed(), &palette_rows);
        self.sources[id as usize] = Source {
            kind,
            vertices: vertex_run,
            triangles: triangle_run,
            nodes: node_run,
            palette: palette_run,
            bounds,
            solid: solid_of(kind, vertices, triangles),
        };
        ShapeSourceHandle { id, generation }
    }

    pub(crate) fn update_mesh(
        &mut self,
        handle: ShapeSourceHandle,
        vertices: &[[f32; 3]],
        triangles: &[[u32; 3]],
        surfaces: Option<SurfaceTable<'_>>,
    ) {
        let source = *self.source(handle);
        validate_geometry(source.kind, vertices, triangles, surfaces);
        let nodes = build_bvh(vertices, triangles);
        let bounds = bounds_of(vertices);
        let vertex_rows = vertex_rows(vertices);
        let triangle_rows = triangle_rows(triangles, surfaces);
        let palette_rows = palette_rows(surfaces);
        let vertex_run = self
            .vertices
            .rewrite(source.vertices, [0.0; 4], &vertex_rows);
        let triangle_run =
            self.triangles
                .rewrite(source.triangles, TriangleRecord::zeroed(), &triangle_rows);
        let node_run = self
            .nodes
            .rewrite(source.nodes, BvhNodeRecord::zeroed(), &nodes);
        let palette_run =
            self.palettes
                .rewrite(source.palette, SurfaceRecord::zeroed(), &palette_rows);
        self.sources[handle.id as usize] = Source {
            vertices: vertex_run,
            triangles: triangle_run,
            nodes: node_run,
            palette: palette_run,
            bounds,
            solid: solid_of(source.kind, vertices, triangles),
            ..source
        };
    }

    pub(crate) fn upload_pending(
        &mut self,
        queue: &wgpu::Queue,
        sources_buffer: &dynamis_gpu::Stream,
        vertices_buffer: &dynamis_gpu::Stream,
        triangles_buffer: &dynamis_gpu::Stream,
        nodes_buffer: &dynamis_gpu::Stream,
    ) {
        sources_buffer.write(queue, bytemuck::cast_slice(&self.layouts()));
        for run in self.vertices.take_dirty() {
            vertices_buffer.write_at(
                queue,
                run.offset as u64 * VERTEX_BYTES,
                bytemuck::cast_slice(self.vertices.slice(run)),
            );
        }
        for run in self.triangles.take_dirty() {
            triangles_buffer.write_at(
                queue,
                run.offset as u64 * TRIANGLE_BYTES,
                bytemuck::cast_slice(self.triangles.slice(run)),
            );
        }
        for run in self.nodes.take_dirty() {
            nodes_buffer.write_at(
                queue,
                run.offset as u64 * size_of::<BvhNodeRecord>() as u64,
                bytemuck::cast_slice(self.nodes.slice(run)),
            );
        }
    }

    fn layouts(&self) -> Vec<dynamis_abi::ShapeSourceRecord> {
        self.sources
            .iter()
            .map(|source| dynamis_abi::ShapeSourceRecord {
                kind: source.kind,
                vertex_offset: source.vertices.offset,
                vertex_count: source.vertices.len,
                triangle_offset: source.triangles.offset,
                triangle_count: source.triangles.len,
                node_offset: source.nodes.offset,
                node_count: source.nodes.len,
                _pad0: 0,
                local_min: source.bounds.0,
                _pad1: 0.0,
                local_max: source.bounds.1,
                _pad2: 0.0,
            })
            .collect()
    }
}

fn validate_geometry(
    kind: u32,
    vertices: &[[f32; 3]],
    triangles: &[[u32; 3]],
    surfaces: Option<SurfaceTable<'_>>,
) {
    assert!(
        kind != dynamis_abi::SHAPE_HULL || surfaces.is_none(),
        "a hull carries no addressable faces for surfaces"
    );
    if let Some(surfaces) = surfaces {
        assert_eq!(
            surfaces.count(),
            triangles.len(),
            "a surface table carries one surface per triangle"
        );
    }
    assert!(
        kind != dynamis_abi::SHAPE_HULL
            || vertices.len() <= dynamis_abi::FEATURE_INDEX_LIMIT as usize,
        "a hull must not exceed {} vertices so its features stay addressable",
        dynamis_abi::FEATURE_INDEX_LIMIT
    );
    assert!(
        triangles.len() <= dynamis_abi::FEATURE_TRIANGLE_MASK as usize,
        "a shape source must not exceed {} triangles so its features stay addressable",
        dynamis_abi::FEATURE_TRIANGLE_MASK
    );
}

fn vertex_rows(vertices: &[[f32; 3]]) -> Vec<[f32; 4]> {
    vertices
        .iter()
        .map(|vertex| [vertex[0], vertex[1], vertex[2], 0.0])
        .collect()
}

fn triangle_rows(
    triangles: &[[u32; 3]],
    surfaces: Option<SurfaceTable<'_>>,
) -> Vec<TriangleRecord> {
    triangles
        .iter()
        .enumerate()
        .map(|(slot, triangle)| {
            let (surface, material) = match surfaces {
                Some(table) => (
                    table.indices()[slot],
                    SurfaceRecord::build(&table.palette()[table.indices()[slot] as usize]),
                ),
                None => (dynamis_abi::NO_SURFACE, SurfaceRecord::zeroed()),
            };
            TriangleRecord {
                a: triangle[0],
                b: triangle[1],
                c: triangle[2],
                surface,
                material,
            }
        })
        .collect()
}

fn palette_rows(surfaces: Option<SurfaceTable<'_>>) -> Vec<SurfaceRecord> {
    surfaces
        .map(|table| table.palette().iter().map(SurfaceRecord::build).collect())
        .unwrap_or_default()
}

fn solid_of(kind: u32, vertices: &[[f32; 3]], triangles: &[[u32; 3]]) -> Option<SolidGeometry> {
    (kind == dynamis_abi::SHAPE_HULL).then(|| dynamis_hull::solid(vertices, triangles))
}

fn bounds_of(vertices: &[[f32; 3]]) -> ([f32; 3], [f32; 3]) {
    let mut bounds_min = [f32::MAX; 3];
    let mut bounds_max = [f32::MIN; 3];
    for vertex in vertices {
        for axis in 0..3 {
            bounds_min[axis] = bounds_min[axis].min(vertex[axis]);
            bounds_max[axis] = bounds_max[axis].max(vertex[axis]);
        }
    }
    (bounds_min, bounds_max)
}

fn build_bvh(vertices: &[[f32; 3]], triangles: &[[u32; 3]]) -> Vec<BvhNodeRecord> {
    assert!(
        !triangles.is_empty(),
        "a shape source requires at least one triangle"
    );
    let mut nodes = Vec::new();
    let mut order = (0..triangles.len() as u32).collect::<Vec<_>>();
    build_node(vertices, triangles, &mut order, &mut nodes);
    nodes
}

fn build_node(
    vertices: &[[f32; 3]],
    triangles: &[[u32; 3]],
    order: &mut [u32],
    nodes: &mut Vec<BvhNodeRecord>,
) {
    let count = order.len() as u32;
    let mut min = [f32::MAX; 3];
    let mut max = [f32::MIN; 3];
    for &triangle in order.iter() {
        let tri = triangles[triangle as usize];
        for corner in tri {
            let vertex = vertices[corner as usize];
            for axis in 0..3 {
                min[axis] = min[axis].min(vertex[axis]);
                max[axis] = max[axis].max(vertex[axis]);
            }
        }
    }
    let node_index = nodes.len() as u32;
    nodes.push(BvhNodeRecord {
        min,
        _pad0: 0.0,
        max,
        _pad1: 0.0,
        left: 0,
        right: 0,
        leaf: 0,
        _pad2: 0,
    });
    if count == 1 {
        nodes[node_index as usize].leaf = 1;
        nodes[node_index as usize].left = order[0];
        nodes[node_index as usize].right = 1;
        return;
    }
    let extent = [max[0] - min[0], max[1] - min[1], max[2] - min[2]];
    let axis = if extent[0] >= extent[1] && extent[0] >= extent[2] {
        0
    } else if extent[1] >= extent[2] {
        1
    } else {
        2
    };
    order.sort_unstable_by(|a, b| {
        let ca = centroid(triangles[*a as usize], vertices)[axis];
        let cb = centroid(triangles[*b as usize], vertices)[axis];
        ca.total_cmp(&cb)
    });
    let middle = (count / 2) as usize;
    let (left_order, right_order) = order.split_at_mut(middle);
    let left_index = nodes.len() as u32;
    build_node(vertices, triangles, left_order, nodes);
    let right_index = nodes.len() as u32;
    build_node(vertices, triangles, right_order, nodes);
    nodes[node_index as usize].left = left_index;
    nodes[node_index as usize].right = right_index;
}

fn centroid(triangle: [u32; 3], vertices: &[[f32; 3]]) -> [f32; 3] {
    let a = vertices[triangle[0] as usize];
    let b = vertices[triangle[1] as usize];
    let c = vertices[triangle[2] as usize];
    [
        (a[0] + b[0] + c[0]) / 3.0,
        (a[1] + b[1] + c[1]) / 3.0,
        (a[2] + b[2] + c[2]) / 3.0,
    ]
}

pub fn height_field_triangles(
    rows: u32,
    cols: u32,
    heights: &[f32],
    cell_size: [f32; 2],
) -> (Vec<[f32; 3]>, Vec<[u32; 3]>) {
    assert!(
        heights.len() as u32 == rows * cols,
        "height field sample count must match rows * cols"
    );
    let mut vertices = Vec::with_capacity((rows * cols) as usize);
    for row in 0..rows {
        for col in 0..cols {
            let index = (row * cols + col) as usize;
            vertices.push([
                col as f32 * cell_size[0],
                heights[index],
                row as f32 * cell_size[1],
            ]);
        }
    }
    let mut triangles = Vec::with_capacity(((rows - 1) * (cols - 1) * 2) as usize);
    for row in 0..rows - 1 {
        for col in 0..cols - 1 {
            let a = row * cols + col;
            let b = (row + 1) * cols + col;
            let c = row * cols + col + 1;
            let d = (row + 1) * cols + col + 1;
            triangles.push([a, b, c]);
            triangles.push([b, d, c]);
        }
    }
    (vertices, triangles)
}