oxihuman-mesh 0.2.1

Mesh processing, topology, and geometry algorithms for OxiHuman
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
//! Geodesic distance computation on triangle mesh surfaces using Dijkstra on graph.
//!
//! Builds a weighted graph from mesh edges where edge weights are Euclidean
//! distances between vertices, then runs Dijkstra's algorithm from a source
//! vertex to compute geodesic distances to all other vertices.

use std::collections::BinaryHeap;
use std::cmp::Ordering;

// ---------------------------------------------------------------------------
// Structures
// ---------------------------------------------------------------------------

/// Configuration for geodesic distance computation.
#[allow(dead_code)]
pub struct GeodesicConfig {
    /// Maximum distance to explore (f32::INFINITY = no limit).
    pub max_distance: f32,
    /// Whether to normalise distances to [0, 1].
    pub normalise: bool,
}

/// Result of geodesic distance computation from a single source vertex.
#[allow(dead_code)]
pub struct GeodesicResult {
    /// Geodesic distance from source to each vertex.
    pub distances: Vec<f32>,
    /// Previous vertex on the shortest path (usize::MAX if none).
    pub previous: Vec<usize>,
    /// The source vertex index.
    pub source: u32,
}

// ---------------------------------------------------------------------------
// Internal priority-queue node
// ---------------------------------------------------------------------------

#[derive(Clone, PartialEq)]
struct NodeDist {
    vertex: usize,
    dist: f32,
}

impl Eq for NodeDist {}

impl PartialOrd for NodeDist {
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        Some(self.cmp(other))
    }
}

impl Ord for NodeDist {
    // Min-heap: flip comparison
    fn cmp(&self, other: &Self) -> Ordering {
        other
            .dist
            .partial_cmp(&self.dist)
            .unwrap_or(Ordering::Equal)
    }
}

// ---------------------------------------------------------------------------
// Default config
// ---------------------------------------------------------------------------

#[allow(dead_code)]
pub fn default_geodesic_config() -> GeodesicConfig {
    GeodesicConfig {
        max_distance: f32::INFINITY,
        normalise: false,
    }
}

// ---------------------------------------------------------------------------
// Helpers
// ---------------------------------------------------------------------------

fn dist3(a: [f32; 3], b: [f32; 3]) -> f32 {
    let dx = a[0] - b[0];
    let dy = a[1] - b[1];
    let dz = a[2] - b[2];
    (dx * dx + dy * dy + dz * dz).sqrt()
}

/// Build an adjacency list with edge weights from a triangle index buffer.
fn build_weighted_adjacency(
    verts: &[[f32; 3]],
    faces: &[[u32; 3]],
) -> Vec<Vec<(usize, f32)>> {
    let n = verts.len();
    let mut adj: Vec<Vec<(usize, f32)>> = vec![Vec::new(); n];

    for face in faces {
        let a = face[0] as usize;
        let b = face[1] as usize;
        let c = face[2] as usize;
        if a >= n || b >= n || c >= n {
            continue;
        }
        let pairs = [(a, b), (b, c), (a, c)];
        for (u, v) in pairs {
            let w = dist3(verts[u], verts[v]);
            if !adj[u].iter().any(|&(nb, _)| nb == v) {
                adj[u].push((v, w));
            }
            if !adj[v].iter().any(|&(nb, _)| nb == u) {
                adj[v].push((u, w));
            }
        }
    }
    adj
}

// ---------------------------------------------------------------------------
// Core functions
// ---------------------------------------------------------------------------

/// Compute geodesic distances from `source` to all vertices using Dijkstra.
#[allow(dead_code)]
pub fn compute_geodesic_distances(
    verts: &[[f32; 3]],
    faces: &[[u32; 3]],
    source: u32,
    cfg: &GeodesicConfig,
) -> GeodesicResult {
    let n = verts.len();
    let src = source as usize;
    let mut distances = vec![f32::INFINITY; n];
    let mut previous = vec![usize::MAX; n];

    if src >= n {
        return GeodesicResult {
            distances,
            previous,
            source,
        };
    }

    let adj = build_weighted_adjacency(verts, faces);
    distances[src] = 0.0;

    let mut heap: BinaryHeap<NodeDist> = BinaryHeap::new();
    heap.push(NodeDist { vertex: src, dist: 0.0 });

    while let Some(NodeDist { vertex: u, dist: d }) = heap.pop() {
        if d > distances[u] {
            continue;
        }
        if d > cfg.max_distance {
            break;
        }
        for &(v, w) in &adj[u] {
            let new_dist = d + w;
            if new_dist < distances[v] {
                distances[v] = new_dist;
                previous[v] = u;
                heap.push(NodeDist { vertex: v, dist: new_dist });
            }
        }
    }

    if cfg.normalise {
        let max_d = distances
            .iter()
            .copied()
            .filter(|x| x.is_finite())
            .fold(0.0f32, f32::max);
        if max_d > 1e-10 {
            for d in &mut distances {
                if d.is_finite() {
                    *d /= max_d;
                }
            }
        }
    }

    GeodesicResult {
        distances,
        previous,
        source,
    }
}

/// Reconstruct the shortest path from source to `target` as a list of vertex indices.
#[allow(dead_code)]
pub fn geodesic_path(result: &GeodesicResult, target: u32) -> Vec<u32> {
    let mut path: Vec<u32> = Vec::new();
    let mut cur = target as usize;
    let src = result.source as usize;

    if cur >= result.distances.len() || result.distances[cur].is_infinite() {
        return path;
    }

    loop {
        path.push(cur as u32);
        if cur == src {
            break;
        }
        let prev = result.previous[cur];
        if prev == usize::MAX {
            break;
        }
        cur = prev;
    }
    path.reverse();
    path
}

/// Return all vertices whose geodesic distance is ≤ `threshold`.
#[allow(dead_code)]
pub fn geodesic_iso_contour(result: &GeodesicResult, threshold: f32) -> Vec<u32> {
    result
        .distances
        .iter()
        .enumerate()
        .filter(|&(_, &d)| d <= threshold)
        .map(|(i, _)| i as u32)
        .collect()
}

/// Farthest-point sampling: greedily select `n` vertices that are mutually far apart.
#[allow(dead_code)]
pub fn farthest_point_sampling(
    verts: &[[f32; 3]],
    faces: &[[u32; 3]],
    n: usize,
) -> Vec<u32> {
    let v_count = verts.len();
    if v_count == 0 || n == 0 {
        return Vec::new();
    }

    let cfg = GeodesicConfig {
        max_distance: f32::INFINITY,
        normalise: false,
    };

    let mut selected: Vec<u32> = Vec::with_capacity(n);
    let mut min_dists = vec![f32::INFINITY; v_count];

    // Start from vertex 0.
    selected.push(0);

    for _ in 1..n {
        let last = selected[selected.len() - 1];
        let result = compute_geodesic_distances(verts, faces, last, &cfg);

        // Update min distances.
        for (v, &d) in result.distances.iter().enumerate() {
            if d < min_dists[v] {
                min_dists[v] = d;
            }
        }

        // Pick vertex with largest min-distance.
        let farthest = min_dists
            .iter()
            .enumerate()
            .max_by(|(_, &da), (_, &db)| da.partial_cmp(&db).unwrap_or(Ordering::Equal))
            .map(|(i, _)| i as u32)
            .unwrap_or(0);

        selected.push(farthest);
    }

    selected
}

/// Assign each vertex to the nearest source vertex (Voronoi-style labels).
/// Returns a label vector of length `result.distances.len()`.
#[allow(dead_code)]
pub fn geodesic_voronoi_regions(result: &GeodesicResult) -> Vec<u32> {
    // With a single source result, every reachable vertex maps to source=0.
    result
        .distances
        .iter()
        .map(|&d| if d.is_finite() { 0u32 } else { u32::MAX })
        .collect()
}

/// Compute the average geodesic distance from source to all reachable vertices.
#[allow(dead_code)]
pub fn average_geodesic_distance(result: &GeodesicResult) -> f32 {
    let finite: Vec<f32> = result
        .distances
        .iter()
        .copied()
        .filter(|x| x.is_finite())
        .collect();
    if finite.is_empty() {
        return 0.0;
    }
    finite.iter().sum::<f32>() / finite.len() as f32
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use super::*;

    // Simple 4-vertex tetrahedron-like mesh.
    fn quad_verts() -> Vec<[f32; 3]> {
        vec![
            [0.0, 0.0, 0.0],
            [1.0, 0.0, 0.0],
            [1.0, 1.0, 0.0],
            [0.0, 1.0, 0.0],
        ]
    }

    fn quad_faces() -> Vec<[u32; 3]> {
        vec![[0, 1, 2], [0, 2, 3]]
    }

    #[test]
    fn test_source_has_zero_distance() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = default_geodesic_config();
        let result = compute_geodesic_distances(&verts, &faces, 0, &cfg);
        assert_eq!(result.distances[0], 0.0);
    }

    #[test]
    fn test_all_vertices_reachable() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = default_geodesic_config();
        let result = compute_geodesic_distances(&verts, &faces, 0, &cfg);
        for (i, &d) in result.distances.iter().enumerate() {
            assert!(
                d.is_finite(),
                "vertex {i} is not reachable, distance = {d}"
            );
        }
    }

    #[test]
    fn test_geodesic_path_reaches_source() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = default_geodesic_config();
        let result = compute_geodesic_distances(&verts, &faces, 0, &cfg);
        let path = geodesic_path(&result, 3);
        assert!(!path.is_empty());
        assert_eq!(*path.first().expect("should succeed"), 0, "path must start at source");
        assert_eq!(*path.last().expect("should succeed"), 3, "path must end at target");
    }

    #[test]
    fn test_geodesic_iso_contour_includes_source() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = default_geodesic_config();
        let result = compute_geodesic_distances(&verts, &faces, 0, &cfg);
        let contour = geodesic_iso_contour(&result, 0.0);
        assert!(contour.contains(&0), "source must be in iso-contour at threshold 0");
    }

    #[test]
    fn test_farthest_point_sampling_count() {
        let verts = quad_verts();
        let faces = quad_faces();
        let samples = farthest_point_sampling(&verts, &faces, 3);
        assert_eq!(samples.len(), 3);
    }

    #[test]
    fn test_average_geodesic_distance_positive() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = default_geodesic_config();
        let result = compute_geodesic_distances(&verts, &faces, 0, &cfg);
        let avg = average_geodesic_distance(&result);
        assert!(avg > 0.0, "average geodesic distance should be positive");
    }

    #[test]
    fn test_geodesic_voronoi_regions_all_zero_for_single_source() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = default_geodesic_config();
        let result = compute_geodesic_distances(&verts, &faces, 0, &cfg);
        let labels = geodesic_voronoi_regions(&result);
        assert_eq!(labels.len(), verts.len());
        for &l in &labels {
            assert_eq!(l, 0, "all vertices should map to source region 0");
        }
    }

    #[test]
    fn test_normalise_config_clamps_to_one() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = GeodesicConfig {
            max_distance: f32::INFINITY,
            normalise: true,
        };
        let result = compute_geodesic_distances(&verts, &faces, 0, &cfg);
        for &d in &result.distances {
            if d.is_finite() {
                assert!(d <= 1.0 + 1e-6, "normalised distance > 1.0: {d}");
            }
        }
    }

    #[test]
    fn test_invalid_source_returns_infinities() {
        let verts = quad_verts();
        let faces = quad_faces();
        let cfg = default_geodesic_config();
        let result = compute_geodesic_distances(&verts, &faces, 100, &cfg);
        for &d in &result.distances {
            assert!(d.is_infinite(), "expected all infinite for invalid source");
        }
    }
}