stepmesh 0.1.0

Pure Rust STEP (ISO 10303-21) reader that turns B-rep solids into watertight triangle meshes
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
//! Curves and surfaces of the exchange structure, in millimetres and radians.

use super::{Decoder, P3, Units, unit};
use crate::Error;
use crate::geom::{Curve, MAX_DEGREE, Nurbs1, Nurbs2, Surface, expand_knots};
use crate::p21::{Record, Value};

/// Wrappers (surface curves, trimmed curves) allowed around one curve.
const MAX_CURVE_NESTING: usize = 8;
const MAX_SURFACE_NESTING: usize = 8;

/// Records that give a B-spline curve its knots, explicitly or by form.
const CURVE_FORMS: [&str; 4] = [
    "B_SPLINE_CURVE_WITH_KNOTS",
    "UNIFORM_CURVE",
    "QUASI_UNIFORM_CURVE",
    "BEZIER_CURVE",
];
const SURFACE_FORMS: [&str; 4] = [
    "B_SPLINE_SURFACE_WITH_KNOTS",
    "UNIFORM_SURFACE",
    "QUASI_UNIFORM_SURFACE",
    "BEZIER_SURFACE",
];

impl Decoder<'_> {
    fn unsupported<T>(&self, id: u64) -> Result<T, Error> {
        Err(Error::Unsupported {
            entity: self.first(id)?.name.clone(),
            id,
        })
    }

    fn integer(&self, id: u64, v: Option<&Value>) -> Result<usize, Error> {
        match v {
            Some(Value::Int(i)) if *i >= 0 => Ok(*i as usize),
            _ => self.invalid(id, "expected a non-negative integer"),
        }
    }

    fn integers(&self, id: u64, v: Option<&Value>) -> Result<Vec<usize>, Error> {
        match v {
            Some(Value::List(items)) => items.iter().map(|i| self.integer(id, Some(i))).collect(),
            _ => self.invalid(id, "expected a list of integers"),
        }
    }

    fn logical(&self, v: Option<&Value>) -> bool {
        matches!(v, Some(Value::Enum(e)) if e == "T")
    }

    /// VECTOR (orientation, magnitude) as a unit direction; the magnitude only scales the parameter.
    fn vector_direction(&self, id: u64) -> Result<P3, Error> {
        let r = self.record(id, "VECTOR")?;
        self.direction(self.reference(id, r.params.get(1))?)
    }

    pub(crate) fn curve(&self, id: u64, units: Units) -> Result<Curve, Error> {
        self.nested_curve(id, units, 0)
    }

    /// `depth` counts wrappers (surface curves, trimmed curves) around the curve read.
    fn nested_curve(&self, id: u64, units: Units, depth: usize) -> Result<Curve, Error> {
        if depth > MAX_CURVE_NESTING {
            return self.invalid(id, "curves wrapped too deeply or in a cycle");
        }
        let e = self.entity(id)?;
        if e.records
            .iter()
            .any(|r| r.name == "B_SPLINE_CURVE" || CURVE_FORMS.contains(&r.name.as_str()))
        {
            return self.bspline_curve(id, units);
        }
        let r = &e.records[0];
        let s = units.length_mm;
        match r.name.as_str() {
            "LINE" => {
                let origin = self.point(self.reference(id, r.params.get(1))?, s)?;
                let dir = self.vector_direction(self.reference(id, r.params.get(2))?)?;
                Ok(Curve::Line { origin, dir })
            }
            "CIRCLE" => Ok(Curve::Circle {
                frame: self.frame(self.reference(id, r.params.get(1))?, s)?,
                r: self.length(id, r.params.get(2), s, false)?,
            }),
            "ELLIPSE" => Ok(Curve::Ellipse {
                frame: self.frame(self.reference(id, r.params.get(1))?, s)?,
                a: self.length(id, r.params.get(2), s, false)?,
                b: self.length(id, r.params.get(3), s, false)?,
            }),
            // The 3D curve; pcurves are not read (boundary points are projected onto the surface).
            "SURFACE_CURVE" | "SEAM_CURVE" | "INTERSECTION_CURVE" => {
                self.nested_curve(self.reference(id, r.params.get(1))?, units, depth + 1)
            }
            // Edges are trimmed by their vertices, so the basis curve is enough.
            "TRIMMED_CURVE" => {
                self.nested_curve(self.reference(id, r.params.get(1))?, units, depth + 1)
            }
            _ => self.unsupported(id),
        }
    }

    /// The B-spline's base record, the record that gives its knots (one of `forms`), and the
    /// index of the degree in the base record. A simple instance carries everything on one
    /// record after the name; a complex one splits it by supertype.
    fn bspline_record(
        &self,
        id: u64,
        base: &str,
        forms: &[&str],
    ) -> Result<(&Record, &Record, usize), Error> {
        let e = self.entity(id)?;
        if e.records.len() == 1 {
            return Ok((&e.records[0], &e.records[0], 1));
        }
        let b = e
            .records
            .iter()
            .find(|r| r.name == base)
            .map_or_else(|| self.invalid(id, base), Ok)?;
        let knots = e
            .records
            .iter()
            .find(|r| forms.contains(&r.name.as_str()))
            .map_or_else(|| self.invalid(id, "B-spline without a knot form"), Ok)?;
        Ok((b, knots, 0))
    }

    /// Finite, non-decreasing knots with a parameter range of positive length.
    fn check_knots(&self, id: u64, k: &[f64], n: usize, p: usize) -> Result<(), Error> {
        let ordered = k.iter().all(|x| x.is_finite()) && k.windows(2).all(|w| w[0] <= w[1]);
        if !ordered || n <= p || k[p] >= k[n] {
            return self.invalid(id, "knots not increasing over the parameter range");
        }
        let mut run = 1;
        for i in 1..k.len() {
            run = if k[i] == k[i - 1] { run + 1 } else { 1 };
            if k[i] > k[p] && k[i] < k[n] && run > p {
                return self.invalid(
                    id,
                    "interior knot multiplicity makes the spline discontinuous",
                );
            }
        }
        Ok(())
    }

    /// Weight of a rational B-spline: finite and positive.
    fn check_weight(&self, id: u64, w: f64) -> Result<f64, Error> {
        if w.is_finite() && w > 0.0 {
            Ok(w)
        } else {
            self.invalid(id, "weight not positive")
        }
    }

    /// A length in millimetres: finite and, unless `zero_ok`, positive.
    pub(crate) fn length(
        &self,
        id: u64,
        v: Option<&Value>,
        mm: f64,
        zero_ok: bool,
    ) -> Result<f64, Error> {
        let l = self.real(id, v)? * mm;
        if l.is_finite() && (l > 0.0 || (zero_ok && l == 0.0)) {
            Ok(l)
        } else {
            self.invalid(id, "length not positive or out of range")
        }
    }

    /// Knot vector of `n` control points of degree `p`: explicit (`*_WITH_KNOTS`, from the
    /// multiplicities and values at `at` and `at + offset`) or implied by the form (ISO 10303-42).
    fn knot_vector(
        &self,
        id: u64,
        form: &Record,
        at: usize,
        offset: usize,
        n: usize,
        p: usize,
    ) -> Result<Vec<f64>, Error> {
        let kind = form.name.as_str();
        if p == 0 || n <= p {
            return self.invalid(id, "invalid degree or too few control points");
        }
        if kind.ends_with("_WITH_KNOTS") {
            let mults = self.integers(id, form.params.get(at))?;
            let ks = self.reals(id, form.params.get(at + offset))?;
            // Checked before expanding: a file can ask for any multiplicity.
            let total = mults.iter().try_fold(0usize, |a, &m| a.checked_add(m));
            if mults.len() != ks.len() || total != Some(n + p + 1) {
                return self.invalid(id, "knot multiplicities do not fit the control points");
            }
            let knots = expand_knots(&mults, &ks);
            self.check_knots(id, &knots, n, p)?;
            return Ok(knots);
        }
        Ok(if kind.starts_with("UNIFORM") {
            (0..n + p + 1).map(|i| i as f64 - p as f64).collect()
        } else if kind.starts_with("QUASI_UNIFORM") {
            let last = (n - p) as f64;
            let mut k = vec![0.0; p + 1];
            k.extend((1..n - p).map(|i| i as f64));
            k.extend(std::iter::repeat_n(last, p + 1));
            k
        } else {
            // BEZIER: piecewise Bézier segments of degree p
            if (n - 1) % p != 0 {
                return self.invalid(id, "control points do not form whole Bézier segments");
            }
            let segments = (n - 1) / p;
            let mut mults = vec![p; segments + 1];
            mults[0] = p + 1;
            mults[segments] = p + 1;
            expand_knots(
                &mults,
                &(0..=segments).map(|i| i as f64).collect::<Vec<_>>(),
            )
        })
    }

    fn weights(&self, id: u64, record: &str) -> Result<Option<&Value>, Error> {
        Ok(self
            .entity(id)?
            .records
            .iter()
            .find(|r| r.name == record)
            .and_then(|r| r.params.first()))
    }

    fn bspline_curve(&self, id: u64, units: Units) -> Result<Curve, Error> {
        let (base, form, off) = self.bspline_record(id, "B_SPLINE_CURVE", &CURVE_FORMS)?;
        let degree = self.integer(id, base.params.get(off))?;
        if degree > MAX_DEGREE {
            return Err(Error::Unsupported {
                entity: format!("B-spline curve of degree {degree}"),
                id,
            });
        }
        let pts = self.references(id, base.params.get(off + 1))?;
        let k0 = if off == 1 { 6 } else { 0 };
        let w = match self.weights(id, "RATIONAL_B_SPLINE_CURVE")? {
            Some(v) => self.reals(id, Some(v))?,
            None => vec![1.0; pts.len()],
        };
        let knots = self.knot_vector(id, form, k0, 1, pts.len(), degree)?;
        if degree == 0 || w.len() != pts.len() || knots.len() != pts.len() + degree + 1 {
            return self.invalid(id, "inconsistent B-spline curve");
        }
        self.check_knots(id, &knots, pts.len(), degree)?;
        let ctrl = pts
            .iter()
            .zip(&w)
            .map(|(&p, &w)| {
                let w = self.check_weight(id, w)?;
                self.point(p, units.length_mm)
                    .map(|q| [q[0] * w, q[1] * w, q[2] * w, w])
            })
            .collect::<Result<_, _>>()?;
        Ok(Curve::Nurbs(Nurbs1 {
            degree,
            knots,
            ctrl,
        }))
    }

    pub(crate) fn surface(&self, id: u64, units: Units) -> Result<Surface, Error> {
        self.nested_surface(id, units, 0)
    }

    /// `depth` counts the offset surfaces around the surface read.
    fn nested_surface(&self, id: u64, units: Units, depth: usize) -> Result<Surface, Error> {
        if depth > MAX_SURFACE_NESTING {
            return self.invalid(id, "offset surfaces nested too deeply");
        }
        let e = self.entity(id)?;
        if e.records
            .iter()
            .any(|r| r.name == "B_SPLINE_SURFACE" || SURFACE_FORMS.contains(&r.name.as_str()))
        {
            return self.bspline_surface(id, units);
        }
        let r = &e.records[0];
        let s = units.length_mm;
        let frame = |i: usize| self.frame(self.reference(id, r.params.get(i))?, s);
        let len = |i: usize| self.length(id, r.params.get(i), s, false);
        match r.name.as_str() {
            "PLANE" => Ok(Surface::Plane(frame(1)?)),
            "CYLINDRICAL_SURFACE" => Ok(Surface::Cylinder {
                frame: frame(1)?,
                r: len(2)?,
            }),
            "CONICAL_SURFACE" => Ok(Surface::Cone {
                frame: frame(1)?,
                r: self.length(id, r.params.get(2), s, true)?,
                half_angle: self.real(id, r.params.get(3))? * units.angle_rad,
            }),
            "SPHERICAL_SURFACE" => Ok(Surface::Sphere {
                frame: frame(1)?,
                r: len(2)?,
            }),
            "TOROIDAL_SURFACE" => Ok(Surface::Torus {
                frame: frame(1)?,
                major: len(2)?,
                minor: len(3)?,
            }),
            "SURFACE_OF_LINEAR_EXTRUSION" => Ok(Surface::Extrusion {
                curve: self.curve(self.reference(id, r.params.get(1))?, units)?,
                dir: self.vector_direction(self.reference(id, r.params.get(2))?)?,
            }),
            "SURFACE_OF_REVOLUTION" => {
                let axis = self.reference(id, r.params.get(2))?;
                let a = self.record(axis, "AXIS1_PLACEMENT")?;
                let axis_origin = self.point(self.reference(axis, a.params.get(1))?, s)?;
                let axis_dir = match self.optional_reference(axis, a.params.get(2))? {
                    Some(d) => self.direction(d)?,
                    None => [0.0, 0.0, 1.0],
                };
                Ok(Surface::Revolution {
                    curve: self.curve(self.reference(id, r.params.get(1))?, units)?,
                    axis_origin,
                    axis_dir: unit(axis_dir).unwrap_or([0.0, 0.0, 1.0]),
                })
            }
            "OFFSET_SURFACE" => {
                let distance = self.real(id, r.params.get(2))? * s;
                if !distance.is_finite() {
                    return self.invalid(id, "offset distance out of range");
                }
                let basis = self.reference(id, r.params.get(1))?;
                Ok(Surface::Offset {
                    basis: Box::new(self.nested_surface(basis, units, depth + 1)?),
                    distance,
                })
            }
            _ => self.unsupported(id),
        }
    }

    fn bspline_surface(&self, id: u64, units: Units) -> Result<Surface, Error> {
        let (base, form, off) = self.bspline_record(id, "B_SPLINE_SURFACE", &SURFACE_FORMS)?;
        let du = self.integer(id, base.params.get(off))?;
        let dv = self.integer(id, base.params.get(off + 1))?;
        if du.max(dv) > MAX_DEGREE {
            return Err(Error::Unsupported {
                entity: format!("B-spline surface of degree {}", du.max(dv)),
                id,
            });
        }
        let Some(Value::List(rows)) = base.params.get(off + 2) else {
            return self.invalid(id, "B-spline surface without control points");
        };
        let closed_u = self.logical(base.params.get(off + 4));
        let closed_v = self.logical(base.params.get(off + 5));
        let k0 = if off == 1 { 8 } else { 0 };
        let nu = rows.len();
        let nv = match rows.first() {
            Some(Value::List(r)) => r.len(),
            _ => return self.invalid(id, "B-spline surface without control points"),
        };
        let ku = self.knot_vector(id, form, k0, 2, nu, du)?;
        let kv = self.knot_vector(id, form, k0 + 1, 2, nv, dv)?;
        let weights: Option<Vec<Vec<f64>>> = match self.weights(id, "RATIONAL_B_SPLINE_SURFACE")? {
            Some(Value::List(ws)) => Some(
                ws.iter()
                    .map(|w| self.reals(id, Some(w)))
                    .collect::<Result<_, _>>()?,
            ),
            Some(_) => return self.invalid(id, "bad weights"),
            None => None,
        };
        let mut ctrl = Vec::with_capacity(rows.len());
        for (i, row) in rows.iter().enumerate() {
            let pts = self.references(id, Some(row))?;
            let mut out = Vec::with_capacity(pts.len());
            for (j, &p) in pts.iter().enumerate() {
                let w = match &weights {
                    Some(ws) => *ws
                        .get(i)
                        .and_then(|r| r.get(j))
                        .map_or_else(|| self.invalid(id, "weights"), Ok)?,
                    None => 1.0,
                };
                let w = self.check_weight(id, w)?;
                let q = self.point(p, units.length_mm)?;
                out.push([q[0] * w, q[1] * w, q[2] * w, w]);
            }
            ctrl.push(out);
        }
        let (nu, nv) = (ctrl.len(), ctrl.first().map_or(0, Vec::len));
        if du == 0
            || dv == 0
            || nu == 0
            || ctrl.iter().any(|r| r.len() != nv)
            || ku.len() != nu + du + 1
            || kv.len() != nv + dv + 1
        {
            return self.invalid(id, "inconsistent B-spline surface");
        }
        self.check_knots(id, &ku, nu, du)?;
        self.check_knots(id, &kv, nv, dv)?;
        Ok(Surface::Nurbs(Nurbs2 {
            du,
            dv,
            ku,
            kv,
            ctrl,
            closed_u,
            closed_v,
        }))
    }
}