imodfile 0.1.0

A pure-Rust IMOD model file decoder/encoder — binary & ASCII, with Python bindings
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

//! Integration tests for imodfile library.

use std::io::Cursor;
use imodfile::*;

/// Helper: create a simple test model with one object, two contours, and one mesh.
fn create_test_model() -> Imod {
    let mut model = Imod::default();
    model.name = "TestModel".to_string();
    model.xmax = 100;
    model.ymax = 200;
    model.zmax = 50;
    model.objsize = 1;

    // Create an object
    let mut obj = Iobj::default();
    obj.name = "Object1".to_string();
    obj.contsize = 2;
    obj.red = 1.0;
    obj.green = 0.5;
    obj.blue = 0.0;
    obj.flags = IMOD_OBJFLAG_DRAW_LABEL | IMOD_OBJFLAG_SCALE_WDTH | IMOD_OBJFLAG_FILL;

    // Contour 1: triangle
    let mut cont1 = Icont::default();
    cont1.psize = 3;
    cont1.pts = vec![
        Ipoint { x: 0.0, y: 0.0, z: 0.0 },
        Ipoint { x: 10.0, y: 0.0, z: 0.0 },
        Ipoint { x: 0.0, y: 10.0, z: 0.0 },
    ];
    cont1.surf = 0;

    // Contour 2: square
    let mut cont2 = Icont::default();
    cont2.psize = 4;
    cont2.pts = vec![
        Ipoint { x: 0.0, y: 0.0, z: 10.0 },
        Ipoint { x: 20.0, y: 0.0, z: 10.0 },
        Ipoint { x: 20.0, y: 20.0, z: 10.0 },
        Ipoint { x: 0.0, y: 20.0, z: 10.0 },
    ];
    cont2.surf = 0;
    cont2.flags = 1;
    cont2.time = 5;

    obj.cont = vec![cont1, cont2];

    // Mesh: simple quad
    let mut mesh = Imesh::default();
    mesh.vsize = 4;
    mesh.lsize = 5;
    mesh.vert = vec![
        Ipoint { x: 0.0, y: 0.0, z: 0.0 },
        Ipoint { x: 10.0, y: 0.0, z: 0.0 },
        Ipoint { x: 10.0, y: 10.0, z: 0.0 },
        Ipoint { x: 0.0, y: 10.0, z: 0.0 },
    ];
    mesh.list = vec![0, 1, 2, 3, -1]; // IMOD_MESH_ENDPOLY = -1
    mesh.flag = 0;
    obj.mesh = vec![mesh];
    obj.meshsize = 1;

    // Add a view
    let mut view = Iview::default();
    view.label = "Default View".to_string();
    view.fovy = 30.0;

    model.obj = vec![obj];
    model.view = vec![view];
    model.viewsize = 1;

    model
}

#[test]
fn test_binary_roundtrip() {
    let model = create_test_model();

    // Write to binary
    let mut buf = Vec::new();
    let mut cursor = Cursor::new(&mut buf);
    write_binary(&mut cursor, &model).expect("write_binary failed");

    // Read back
    cursor.set_position(0);
    let model2 = read_binary(&mut cursor).expect("read_binary failed");

    // Verify
    assert_eq!(model.name, model2.name);
    assert_eq!(model.obj.len(), model2.obj.len());
    assert_eq!(model.xmax, model2.xmax);
    assert_eq!(model.ymax, model2.ymax);
    assert_eq!(model.zmax, model2.zmax);

    let obj = &model.obj[0];
    let obj2 = &model2.obj[0];
    assert_eq!(obj.name, obj2.name);
    assert_eq!(obj.contsize, obj2.contsize);
    assert_eq!(obj.red, obj2.red);
    assert_eq!(obj.green, obj2.green);
    assert_eq!(obj.blue, obj2.blue);
    assert_eq!(obj.flags, obj2.flags);
    assert_eq!(obj.meshsize, obj2.meshsize);

    // Contours
    for i in 0..obj.contsize as usize {
        assert_eq!(obj.cont[i].psize, obj2.cont[i].psize);
        assert_eq!(obj.cont[i].surf, obj2.cont[i].surf);
        assert_eq!(obj.cont[i].flags, obj2.cont[i].flags);
        assert_eq!(obj.cont[i].time, obj2.cont[i].time);
        for j in 0..obj.cont[i].psize as usize {
            let a = obj.cont[i].pts[j];
            let b = obj2.cont[i].pts[j];
            assert!((a.x - b.x).abs() < 1e-5, "point {} cont {} x: {} != {}", j, i, a.x, b.x);
            assert!((a.y - b.y).abs() < 1e-5);
            assert!((a.z - b.z).abs() < 1e-5);
        }
    }

    // Meshes
    let mesh = &obj.mesh[0];
    let mesh2 = &obj2.mesh[0];
    assert_eq!(mesh.vsize, mesh2.vsize);
    assert_eq!(mesh.lsize, mesh2.lsize);
    assert_eq!(mesh.list, mesh2.list);
    for j in 0..mesh.vsize as usize {
        assert!(
            (mesh.vert[j].x - mesh2.vert[j].x).abs() < 1e-5,
            "mesh vert {} x: {} != {}",
            j,
            mesh.vert[j].x,
            mesh2.vert[j].x
        );
    }
}

#[test]
fn test_ascii_roundtrip() {
    let model = create_test_model();

    // Write to ASCII
    let mut buf = Vec::new();
    write_ascii(&mut buf, &model).expect("write_ascii failed");

    let ascii_text = String::from_utf8_lossy(&buf);
    println!("ASCII output:\n{}", ascii_text);

    // Read back from ASCII
    let model2 = read_ascii(&mut Cursor::new(&buf)).expect("read_ascii failed");

    // Verify basic properties
    assert_eq!(model.obj.len(), model2.obj.len());
    assert_eq!(model.xmax, model2.xmax);
    assert_eq!(model.ymax, model2.ymax);

    if !model2.obj.is_empty() {
        let obj2 = &model2.obj[0];
        assert_eq!(obj2.name, "Object1");
        assert!((obj2.red - 1.0).abs() < 0.01);
        assert!((obj2.green - 0.5).abs() < 0.01);
        assert_eq!(obj2.contsize, 2);
        assert_eq!(obj2.cont.len(), 2);

        // Check first contour
        if obj2.cont.len() > 0 {
            assert_eq!(obj2.cont[0].psize, 3);
            assert!(obj2.cont[0].pts.len() >= 3);
        }
    }
}

#[test]
fn test_binary_to_ascii() {
    let model = create_test_model();

    // Write binary
    let mut bin_buf = Vec::new();
    write_binary(&mut Cursor::new(&mut bin_buf), &model).expect("write_binary");

    // Read binary
    let model2 = read_binary(&mut Cursor::new(&bin_buf)).expect("read_binary");

    // Write ASCII from re-read model
    let mut ascii_buf = Vec::new();
    write_ascii(&mut ascii_buf, &model2).expect("write_ascii");

    let ascii_text = String::from_utf8_lossy(&ascii_buf);
    assert!(ascii_text.contains("imod 1"));
    assert!(ascii_text.contains("Object1"));
    assert!(ascii_text.contains("contour 0 0 3"));
    assert!(ascii_text.contains("contour 1 0 4"));
}

#[test]
fn test_create_empty_model() {
    let model = Imod::default();

    let mut buf = Vec::new();
    write_binary(&mut Cursor::new(&mut buf), &model).expect("write_binary empty");

    let model2 = read_binary(&mut Cursor::new(&buf)).expect("read_binary empty");
    assert_eq!(model2.objsize, 0);
    assert!(model2.obj.is_empty());
}

#[test]
fn test_model_with_labels() {
    let mut model = Imod::default();
    model.objsize = 1;

    let mut obj = Iobj::default();
    obj.name = "LabelTest".to_string();
    obj.contsize = 1;

    let mut cont = Icont::default();
    cont.psize = 2;
    cont.pts = vec![
        Ipoint { x: 0.0, y: 0.0, z: 0.0 },
        Ipoint { x: 1.0, y: 1.0, z: 1.0 },
    ];

    // Add label to contour
    let mut label = Ilabel::default();
    label.name = Some("ContourLabel".to_string());
    label.items.push(IlabelItem {
        name: "PointA".to_string(),
        index: 0,
    });
    label.items.push(IlabelItem {
        name: "PointB".to_string(),
        index: 1,
    });
    cont.label = Some(label);

    obj.cont = vec![cont];
    model.obj = vec![obj];

    // Binary round-trip
    let mut buf = Vec::new();
    write_binary(&mut Cursor::new(&mut buf), &model).expect("write_binary with labels");
    let model2 = read_binary(&mut Cursor::new(&buf)).expect("read_binary with labels");

    let cont2 = &model2.obj[0].cont[0];
    assert!(cont2.label.is_some());
    let label2 = cont2.label.as_ref().unwrap();
    assert_eq!(label2.name.as_deref(), Some("ContourLabel"));
    assert_eq!(label2.items.len(), 2);
    assert_eq!(label2.items[0].name, "PointA");
    assert_eq!(label2.items[1].name, "PointB");
}

#[test]
fn test_model_with_point_sizes() {
    let mut model = Imod::default();
    model.objsize = 1;

    let mut obj = Iobj::default();
    obj.name = "SizeTest".to_string();
    obj.contsize = 1;

    let mut cont = Icont::default();
    cont.psize = 3;
    cont.pts = vec![
        Ipoint { x: 0.0, y: 0.0, z: 0.0 },
        Ipoint { x: 1.0, y: 0.0, z: 0.0 },
        Ipoint { x: 0.0, y: 1.0, z: 0.0 },
    ];
    cont.sizes = Some(vec![1.5, 2.0, 0.5]);

    obj.cont = vec![cont];
    model.obj = vec![obj];

    let mut buf = Vec::new();
    write_binary(&mut Cursor::new(&mut buf), &model).expect("write_binary with sizes");
    let model2 = read_binary(&mut Cursor::new(&buf)).expect("read_binary with sizes");

    let cont2 = &model2.obj[0].cont[0];
    assert!(cont2.sizes.is_some());
    let sizes = cont2.sizes.as_ref().unwrap();
    assert_eq!(sizes.len(), 3);
    assert!((sizes[0] - 1.5).abs() < 1e-5);
    assert!((sizes[1] - 2.0).abs() < 1e-5);
    assert!((sizes[2] - 0.5).abs() < 1e-5);
}

#[test]
fn test_clip_planes() {
    let mut model = Imod::default();
    model.objsize = 1;

    let mut obj = Iobj::default();
    obj.name = "ClipTest".to_string();
    obj.contsize = 1;

    // Add a clip plane
    obj.clips.count = 1;
    obj.clips.flags = 1; // enabled
    obj.clips.normal[0] = Ipoint { x: 0.0, y: 0.0, z: 1.0 };
    obj.clips.point[0] = Ipoint { x: 0.0, y: 0.0, z: 50.0 };

    let mut cont = Icont::default();
    cont.psize = 1;
    cont.pts = vec![Ipoint { x: 10.0, y: 10.0, z: 10.0 }];
    obj.cont = vec![cont];
    model.obj = vec![obj];

    let mut buf = Vec::new();
    write_binary(&mut Cursor::new(&mut buf), &model).expect("write_binary with clips");
    let model2 = read_binary(&mut Cursor::new(&buf)).expect("read_binary with clips");

    let obj2 = &model2.obj[0];
    assert_eq!(obj2.clips.count, 1);
    assert!((obj2.clips.normal[0].x - 0.0).abs() < 1e-5);
    assert!((obj2.clips.normal[0].z - 1.0).abs() < 1e-5);
    assert!((obj2.clips.point[0].z - 50.0).abs() < 1e-5);
}

#[test]
fn test_file_read_write() {
    // Create a temp file path
    let tmp = std::env::temp_dir().join("test_imod_roundtrip.mod");

    let model = create_test_model();
    {
        let file = std::fs::File::create(&tmp).expect("create temp file");
        let mut writer = std::io::BufWriter::new(file);
        write_binary(&mut writer, &model).expect("write to file");
    }

    // Read back
    let file = std::fs::File::open(&tmp).expect("open temp file");
    let mut reader = std::io::BufReader::new(file);
    let model2 = read_binary(&mut reader).expect("read from file");
    assert_eq!(model2.obj.len(), 1);

    // Clean up
    let _ = std::fs::remove_file(&tmp);
}