lib3mf-core 0.4.0

Parse and validate 3MF files for manufacturing workflows - production-ready with streaming parser and comprehensive validation
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
530
531
532
533
534
535
536
537
538
539
540
541
use lib3mf_core::error::Result;
use lib3mf_core::model::{Beam, DisplacementTriangle, ResourceId};
use lib3mf_core::parser::streaming::parse_model_streaming;
use lib3mf_core::parser::visitor::ModelVisitor;
use std::io::Cursor;

struct TestVisitor {
    events: Vec<String>,
    beam_count: usize,
    disp_vertex_count: usize,
    disp_triangle_count: usize,
    disp_normal_count: usize,
    vertex_count: usize,
    triangle_count: usize,
}

impl TestVisitor {
    fn new() -> Self {
        Self {
            events: Vec::new(),
            beam_count: 0,
            disp_vertex_count: 0,
            disp_triangle_count: 0,
            disp_normal_count: 0,
            vertex_count: 0,
            triangle_count: 0,
        }
    }
}

impl ModelVisitor for TestVisitor {
    fn on_vertex(&mut self, _x: f32, _y: f32, _z: f32) -> Result<()> {
        self.vertex_count += 1;
        Ok(())
    }

    fn on_triangle(&mut self, _v1: u32, _v2: u32, _v3: u32) -> Result<()> {
        self.triangle_count += 1;
        Ok(())
    }

    fn on_start_beam_lattice(&mut self, id: ResourceId) -> Result<()> {
        self.events.push(format!("start_beam_lattice:{}", id.0));
        Ok(())
    }

    fn on_beam(&mut self, _beam: &Beam) -> Result<()> {
        self.beam_count += 1;
        Ok(())
    }

    fn on_end_beam_lattice(&mut self) -> Result<()> {
        self.events.push("end_beam_lattice".to_string());
        Ok(())
    }

    fn on_start_displacement_mesh(&mut self, id: ResourceId) -> Result<()> {
        self.events
            .push(format!("start_displacement_mesh:{}", id.0));
        Ok(())
    }

    fn on_displacement_vertex(&mut self, _x: f32, _y: f32, _z: f32) -> Result<()> {
        self.disp_vertex_count += 1;
        Ok(())
    }

    fn on_displacement_triangle(&mut self, _triangle: &DisplacementTriangle) -> Result<()> {
        self.disp_triangle_count += 1;
        Ok(())
    }

    fn on_displacement_normal(&mut self, _nx: f32, _ny: f32, _nz: f32) -> Result<()> {
        self.disp_normal_count += 1;
        Ok(())
    }

    fn on_end_displacement_mesh(&mut self) -> Result<()> {
        self.events.push("end_displacement_mesh".to_string());
        Ok(())
    }
}

/// Helper to build a complete 3MF model XML string with the given resources content
fn make_model_xml(resources: &str, build_items: &str) -> String {
    format!(
        r#"<?xml version="1.0" encoding="UTF-8"?>
<model unit="millimeter" xmlns="http://schemas.microsoft.com/3dmanufacturing/core/2015/02">
    <resources>
        {}
    </resources>
    <build>
        {}
    </build>
</model>"#,
        resources, build_items
    )
}

// --- Tests ---

/// Beam lattice visitor callbacks fire for each beam and lifecycle methods fire in order.
#[test]
fn test_beam_lattice_streaming() {
    let resources = r#"
        <object id="1" type="model">
            <mesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
                <beamlattice radius="0.5" minlength="0.001">
                    <beams>
                        <beam v1="0" v2="1" r1="0.3" r2="0.4" />
                        <beam v1="1" v2="2" />
                    </beams>
                </beamlattice>
            </mesh>
        </object>
    "#;
    let build = r#"<item objectid="1" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    // on_start_beam_lattice fired with ResourceId(1)
    assert!(
        visitor.events.contains(&"start_beam_lattice:1".to_string()),
        "Expected start_beam_lattice:1 in events: {:?}",
        visitor.events
    );
    // Two beams processed
    assert_eq!(visitor.beam_count, 2);
    // on_end_beam_lattice fired
    assert!(
        visitor.events.contains(&"end_beam_lattice".to_string()),
        "Expected end_beam_lattice in events: {:?}",
        visitor.events
    );
    // Order: start_beam_lattice comes before end_beam_lattice
    let start_pos = visitor
        .events
        .iter()
        .position(|e| e == "start_beam_lattice:1")
        .unwrap();
    let end_pos = visitor
        .events
        .iter()
        .position(|e| e == "end_beam_lattice")
        .unwrap();
    assert!(
        start_pos < end_pos,
        "start_beam_lattice must come before end_beam_lattice"
    );
}

/// BeamSets are silently skipped — no crash, no beamset-related events.
#[test]
fn test_beam_lattice_with_beamsets_skipped() {
    let resources = r#"
        <object id="1" type="model">
            <mesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
                <beamlattice radius="0.5" minlength="0.001">
                    <beams>
                        <beam v1="0" v2="1" />
                        <beam v1="1" v2="2" />
                    </beams>
                    <beamsets>
                        <beamset name="set1">
                            <ref index="0"/>
                            <ref index="1"/>
                        </beamset>
                    </beamsets>
                </beamlattice>
            </mesh>
        </object>
    "#;
    let build = r#"<item objectid="1" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    // Must not crash
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    // Beam callbacks still fire
    assert_eq!(visitor.beam_count, 2);
    // No beamset-related events in visitor
    let beamset_events: Vec<&String> = visitor
        .events
        .iter()
        .filter(|e| e.contains("beamset"))
        .collect();
    assert!(
        beamset_events.is_empty(),
        "Unexpected beamset events: {:?}",
        beamset_events
    );
}

/// Displacement mesh visitor callbacks fire for each vertex, triangle, and normal.
#[test]
fn test_displacement_mesh_streaming() {
    let resources = r#"
        <object id="2" type="model">
            <displacementmesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
                <normvectors>
                    <normvector nx="0" ny="0" nz="1" />
                </normvectors>
            </displacementmesh>
        </object>
    "#;
    let build = r#"<item objectid="2" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    // on_start_displacement_mesh fired with ResourceId(2)
    assert!(
        visitor
            .events
            .contains(&"start_displacement_mesh:2".to_string()),
        "Expected start_displacement_mesh:2 in events: {:?}",
        visitor.events
    );
    assert_eq!(visitor.disp_vertex_count, 3);
    assert_eq!(visitor.disp_triangle_count, 1);
    assert_eq!(visitor.disp_normal_count, 1);
    // on_end_displacement_mesh fired
    assert!(
        visitor
            .events
            .contains(&"end_displacement_mesh".to_string()),
        "Expected end_displacement_mesh in events: {:?}",
        visitor.events
    );
}

/// disp2dgroups are silently skipped — no crash, vertices/triangles/normals still parse correctly.
#[test]
fn test_displacement_mesh_disp2dgroups_skipped() {
    let resources = r#"
        <object id="3" type="model">
            <displacementmesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
                <normvectors>
                    <normvector nx="0" ny="0" nz="1" />
                </normvectors>
                <disp2dgroups>
                    <disp2dgroup id="1">
                        <gradient gu="0.1" gv="0.2" />
                    </disp2dgroup>
                </disp2dgroups>
            </displacementmesh>
        </object>
    "#;
    let build = r#"<item objectid="3" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    // Must not crash from disp2dgroups
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    // Vertices, triangles, normals still parsed correctly
    assert_eq!(visitor.disp_vertex_count, 3);
    assert_eq!(visitor.disp_triangle_count, 1);
    assert_eq!(visitor.disp_normal_count, 1);
}

/// Displacement mesh with no normvectors section is handled correctly.
#[test]
fn test_displacement_mesh_no_normals() {
    let resources = r#"
        <object id="4" type="model">
            <displacementmesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
            </displacementmesh>
        </object>
    "#;
    let build = r#"<item objectid="4" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    assert_eq!(visitor.disp_vertex_count, 3);
    assert_eq!(visitor.disp_triangle_count, 1);
    assert_eq!(
        visitor.disp_normal_count, 0,
        "Expected 0 normals when normvectors absent"
    );
}

/// Mesh with vertices/triangles AND beamlattice — both callbacks fire correctly.
#[test]
fn test_mesh_and_beam_lattice_same_object() {
    let resources = r#"
        <object id="5" type="model">
            <mesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                    <vertex x="0" y="0" z="1" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                    <triangle v1="0" v2="1" v3="3" />
                    <triangle v1="0" v2="2" v3="3" />
                    <triangle v1="1" v2="2" v3="3" />
                </triangles>
                <beamlattice radius="0.2" minlength="0.01">
                    <beams>
                        <beam v1="0" v2="1" />
                        <beam v1="1" v2="2" />
                        <beam v1="2" v2="3" />
                    </beams>
                </beamlattice>
            </mesh>
        </object>
    "#;
    let build = r#"<item objectid="5" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    // Both mesh AND beam lattice callbacks fire
    assert_eq!(visitor.vertex_count, 4, "Mesh vertices counted");
    assert_eq!(visitor.triangle_count, 4, "Mesh triangles counted");
    assert_eq!(visitor.beam_count, 3, "Beam lattice beams counted");
}

/// Standard mesh with no extensions produces correct counts — backward compatibility.
#[test]
fn test_backward_compatibility() {
    let resources = r#"
        <object id="6" type="model">
            <mesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
            </mesh>
        </object>
    "#;
    let build = r#"<item objectid="6" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    // Existing behavior unchanged
    assert_eq!(visitor.vertex_count, 3);
    assert_eq!(visitor.triangle_count, 1);
    // No extension callbacks fired
    assert_eq!(visitor.beam_count, 0);
    assert_eq!(visitor.disp_vertex_count, 0);
    assert_eq!(visitor.disp_triangle_count, 0);
    assert_eq!(visitor.disp_normal_count, 0);
    let ext_events: Vec<&String> = visitor
        .events
        .iter()
        .filter(|e| e.contains("beam_lattice") || e.contains("displacement"))
        .collect();
    assert!(
        ext_events.is_empty(),
        "No extension events expected: {:?}",
        ext_events
    );
}

/// Two objects — one regular mesh, one displacement mesh — both processed correctly.
#[test]
fn test_multiple_objects_mixed() {
    let resources = r#"
        <object id="7" type="model">
            <mesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
            </mesh>
        </object>
        <object id="8" type="model">
            <displacementmesh>
                <vertices>
                    <vertex x="0" y="0" z="5" />
                    <vertex x="1" y="0" z="5" />
                    <vertex x="0" y="1" z="5" />
                    <vertex x="1" y="1" z="5" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                    <triangle v1="1" v2="3" v3="2" />
                </triangles>
            </displacementmesh>
        </object>
    "#;
    let build = r#"<item objectid="7" /><item objectid="8" />"#;
    let xml = make_model_xml(resources, build);

    let mut visitor = TestVisitor::new();
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    // Object 7 — regular mesh
    assert_eq!(visitor.vertex_count, 3, "Object 7 mesh vertices");
    assert_eq!(visitor.triangle_count, 1, "Object 7 mesh triangles");

    // Object 8 — displacement mesh
    assert_eq!(
        visitor.disp_vertex_count, 4,
        "Object 8 displacement vertices"
    );
    assert_eq!(
        visitor.disp_triangle_count, 2,
        "Object 8 displacement triangles"
    );

    // start_displacement_mesh fired with id 8
    assert!(
        visitor
            .events
            .contains(&"start_displacement_mesh:8".to_string()),
        "Expected start_displacement_mesh:8 in events: {:?}",
        visitor.events
    );
}

/// Beam attributes are parsed correctly (r1, r2, default radius, cap mode).
#[test]
fn test_beam_attribute_parsing() {
    let resources = r#"
        <object id="9" type="model">
            <mesh>
                <vertices>
                    <vertex x="0" y="0" z="0" />
                    <vertex x="1" y="0" z="0" />
                    <vertex x="0" y="1" z="0" />
                </vertices>
                <triangles>
                    <triangle v1="0" v2="1" v3="2" />
                </triangles>
                <beamlattice radius="0.5" minlength="0.001">
                    <beams>
                        <beam v1="0" v2="1" r1="0.3" r2="0.4" cap="butt" />
                        <beam v1="1" v2="2" r1="0.6" />
                        <beam v1="0" v2="2" />
                    </beams>
                </beamlattice>
            </mesh>
        </object>
    "#;
    let build = r#"<item objectid="9" />"#;
    let xml = make_model_xml(resources, build);

    // Use a visitor that captures beam data
    struct BeamCapture {
        beams: Vec<Beam>,
    }
    impl ModelVisitor for BeamCapture {
        fn on_beam(&mut self, beam: &Beam) -> lib3mf_core::error::Result<()> {
            self.beams.push(beam.clone());
            Ok(())
        }
    }

    let mut visitor = BeamCapture { beams: Vec::new() };
    parse_model_streaming(Cursor::new(xml), &mut visitor).expect("parse failed");

    assert_eq!(visitor.beams.len(), 3);

    // First beam: explicit r1, r2, cap=butt
    assert!((visitor.beams[0].r1 - 0.3).abs() < 1e-5, "beam[0].r1");
    assert!((visitor.beams[0].r2 - 0.4).abs() < 1e-5, "beam[0].r2");
    assert_eq!(visitor.beams[0].cap_mode, lib3mf_core::model::CapMode::Butt);

    // Second beam: explicit r1, r2 defaults to r1
    assert!((visitor.beams[1].r1 - 0.6).abs() < 1e-5, "beam[1].r1");
    assert!(
        (visitor.beams[1].r2 - 0.6).abs() < 1e-5,
        "beam[1].r2 should default to r1"
    );
    assert_eq!(
        visitor.beams[1].cap_mode,
        lib3mf_core::model::CapMode::Sphere
    );

    // Third beam: both r1 and r2 default to lattice radius (0.5)
    assert!(
        (visitor.beams[2].r1 - 0.5).abs() < 1e-5,
        "beam[2].r1 should default to lattice radius"
    );
    assert!(
        (visitor.beams[2].r2 - 0.5).abs() < 1e-5,
        "beam[2].r2 should default to r1"
    );
}