lib3mf 0.1.6

Pure Rust implementation for 3MF (3D Manufacturing Format) parsing and writing
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

//! Volumetric extension writing for 3MF model files
//!
//! This module provides functionality to write Volumetric extension elements
//! such as `<v:volumetricdata>`, `<v:boundary>`, `<v:voxels>`, `<v:voxel>`,
//! `<v:volumetricpropertygroup>`, and `<v:property>`.

use crate::error::{Error, Result};
use crate::model::*;
use quick_xml::Writer;
use quick_xml::events::{BytesEnd, BytesStart, Event};
use std::fmt::Write as FmtWrite;
use std::io::Write as IoWrite;

/// Write a volumetric property group resource (`<v:volumetricpropertygroup>`)
pub(super) fn write_volumetric_property_group<W: IoWrite>(
    writer: &mut Writer<W>,
    group: &VolumetricPropertyGroup,
) -> Result<()> {
    let mut fmt_buf = String::with_capacity(32);
    let mut elem = BytesStart::new("v:volumetricpropertygroup");

    write!(fmt_buf, "{}", group.id).unwrap();
    elem.push_attribute(("id", fmt_buf.as_str()));

    writer.write_event(Event::Start(elem)).map_err(|e| {
        Error::xml_write(format!(
            "Failed to write volumetricpropertygroup element: {}",
            e
        ))
    })?;

    for prop in &group.properties {
        let mut prop_elem = BytesStart::new("v:property");

        fmt_buf.clear();
        write!(fmt_buf, "{}", prop.index).unwrap();
        prop_elem.push_attribute(("index", fmt_buf.as_str()));
        prop_elem.push_attribute(("value", prop.value.as_str()));

        writer
            .write_event(Event::Empty(prop_elem))
            .map_err(|e| Error::xml_write(format!("Failed to write property element: {}", e)))?;
    }

    writer
        .write_event(Event::End(BytesEnd::new("v:volumetricpropertygroup")))
        .map_err(|e| {
            Error::xml_write(format!(
                "Failed to close volumetricpropertygroup element: {}",
                e
            ))
        })?;

    Ok(())
}

/// Write a volumetric data resource (`<v:volumetricdata>`)
pub(super) fn write_volumetric_data<W: IoWrite>(
    writer: &mut Writer<W>,
    vol_data: &VolumetricData,
) -> Result<()> {
    let mut fmt_buf = String::with_capacity(32);
    let mut elem = BytesStart::new("v:volumetricdata");

    write!(fmt_buf, "{}", vol_data.id).unwrap();
    elem.push_attribute(("id", fmt_buf.as_str()));

    writer
        .write_event(Event::Start(elem))
        .map_err(|e| Error::xml_write(format!("Failed to write volumetricdata element: {}", e)))?;

    // Write boundary if present
    if let Some(ref boundary) = vol_data.boundary {
        write_boundary(writer, boundary)?;
    }

    // Write voxel grid if present
    if let Some(ref voxels) = vol_data.voxels {
        write_voxels(writer, voxels)?;
    }

    // Write implicit volume if present
    if let Some(ref implicit) = vol_data.implicit {
        write_implicit(writer, implicit)?;
    }

    writer
        .write_event(Event::End(BytesEnd::new("v:volumetricdata")))
        .map_err(|e| Error::xml_write(format!("Failed to close volumetricdata element: {}", e)))?;

    Ok(())
}

/// Write a `<v:boundary>` element
fn write_boundary<W: IoWrite>(writer: &mut Writer<W>, boundary: &VolumetricBoundary) -> Result<()> {
    let mut fmt_buf = String::with_capacity(64);
    let mut elem = BytesStart::new("v:boundary");

    write!(
        fmt_buf,
        "{} {} {}",
        boundary.min.0, boundary.min.1, boundary.min.2
    )
    .unwrap();
    elem.push_attribute(("min", fmt_buf.as_str()));

    fmt_buf.clear();
    write!(
        fmt_buf,
        "{} {} {}",
        boundary.max.0, boundary.max.1, boundary.max.2
    )
    .unwrap();
    elem.push_attribute(("max", fmt_buf.as_str()));

    writer
        .write_event(Event::Empty(elem))
        .map_err(|e| Error::xml_write(format!("Failed to write boundary element: {}", e)))?;

    Ok(())
}

/// Write a `<v:voxels>` element with child `<v:voxel>` entries
fn write_voxels<W: IoWrite>(writer: &mut Writer<W>, grid: &VoxelGrid) -> Result<()> {
    let mut fmt_buf = String::with_capacity(64);
    let mut elem = BytesStart::new("v:voxels");

    write!(
        fmt_buf,
        "{} {} {}",
        grid.dimensions.0, grid.dimensions.1, grid.dimensions.2
    )
    .unwrap();
    elem.push_attribute(("dimensions", fmt_buf.as_str()));

    if let Some(spacing) = grid.spacing {
        fmt_buf.clear();
        write!(fmt_buf, "{} {} {}", spacing.0, spacing.1, spacing.2).unwrap();
        elem.push_attribute(("spacing", fmt_buf.as_str()));
    }

    if let Some(origin) = grid.origin {
        fmt_buf.clear();
        write!(fmt_buf, "{} {} {}", origin.0, origin.1, origin.2).unwrap();
        elem.push_attribute(("origin", fmt_buf.as_str()));
    }

    writer
        .write_event(Event::Start(elem))
        .map_err(|e| Error::xml_write(format!("Failed to write voxels element: {}", e)))?;

    for voxel in &grid.voxels {
        let mut voxel_elem = BytesStart::new("v:voxel");

        fmt_buf.clear();
        write!(fmt_buf, "{}", voxel.position.0).unwrap();
        voxel_elem.push_attribute(("x", fmt_buf.as_str()));

        fmt_buf.clear();
        write!(fmt_buf, "{}", voxel.position.1).unwrap();
        voxel_elem.push_attribute(("y", fmt_buf.as_str()));

        fmt_buf.clear();
        write!(fmt_buf, "{}", voxel.position.2).unwrap();
        voxel_elem.push_attribute(("z", fmt_buf.as_str()));

        if let Some(prop_id) = voxel.property_id {
            fmt_buf.clear();
            write!(fmt_buf, "{}", prop_id).unwrap();
            voxel_elem.push_attribute(("property", fmt_buf.as_str()));
        }

        if let Some(color_id) = voxel.color_id {
            fmt_buf.clear();
            write!(fmt_buf, "{}", color_id).unwrap();
            voxel_elem.push_attribute(("color", fmt_buf.as_str()));
        }

        writer
            .write_event(Event::Empty(voxel_elem))
            .map_err(|e| Error::xml_write(format!("Failed to write voxel element: {}", e)))?;
    }

    writer
        .write_event(Event::End(BytesEnd::new("v:voxels")))
        .map_err(|e| Error::xml_write(format!("Failed to close voxels element: {}", e)))?;

    Ok(())
}

/// Write a `<v:implicit>` element
fn write_implicit<W: IoWrite>(writer: &mut Writer<W>, implicit: &ImplicitVolume) -> Result<()> {
    let mut elem = BytesStart::new("v:implicit");
    elem.push_attribute(("type", implicit.implicit_type.as_str()));

    for (key, value) in &implicit.parameters {
        elem.push_attribute((key.as_str(), value.as_str()));
    }

    writer
        .write_event(Event::Empty(elem))
        .map_err(|e| Error::xml_write(format!("Failed to write implicit element: {}", e)))?;

    Ok(())
}

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

    #[test]
    fn test_write_volumetric_property_group() {
        let mut group = VolumetricPropertyGroup::new(1);
        group
            .properties
            .push(VolumetricProperty::new(0, "solid".to_string()));

        let mut buffer = Vec::new();
        let mut writer = Writer::new_with_indent(&mut buffer, b' ', 2);
        write_volumetric_property_group(&mut writer, &group).unwrap();

        let xml = String::from_utf8(buffer).unwrap();
        assert!(xml.contains("v:volumetricpropertygroup"));
        assert!(xml.contains("id=\"1\""));
        assert!(xml.contains("index=\"0\""));
        assert!(xml.contains("value=\"solid\""));
    }

    #[test]
    fn test_write_volumetric_data_with_boundary_and_voxels() {
        let mut vol_data = VolumetricData::new(1);
        vol_data.boundary = Some(VolumetricBoundary::new((0.0, 0.0, 0.0), (10.0, 10.0, 10.0)));

        let mut grid = VoxelGrid::new((10, 10, 10));
        grid.spacing = Some((1.0, 1.0, 1.0));
        grid.voxels.push(Voxel::new((5, 5, 5)));
        vol_data.voxels = Some(grid);

        let mut buffer = Vec::new();
        let mut writer = Writer::new_with_indent(&mut buffer, b' ', 2);
        write_volumetric_data(&mut writer, &vol_data).unwrap();

        let xml = String::from_utf8(buffer).unwrap();
        assert!(xml.contains("v:volumetricdata"));
        assert!(xml.contains("v:boundary"));
        assert!(xml.contains("v:voxels"));
        assert!(xml.contains("v:voxel"));
        assert!(xml.contains("x=\"5\""));
    }

    #[test]
    fn test_write_volumetric_data_with_implicit() {
        let mut vol_data = VolumetricData::new(2);
        let mut implicit = ImplicitVolume::new("sdf".to_string());
        implicit
            .parameters
            .push(("radius".to_string(), "5.0".to_string()));
        vol_data.implicit = Some(implicit);

        let mut buffer = Vec::new();
        let mut writer = Writer::new_with_indent(&mut buffer, b' ', 2);
        write_volumetric_data(&mut writer, &vol_data).unwrap();

        let xml = String::from_utf8(buffer).unwrap();
        assert!(xml.contains("v:implicit"));
        assert!(xml.contains("type=\"sdf\""));
        assert!(xml.contains("radius=\"5.0\""));
    }
}