egml-core 0.0.2-alpha.3

Core primitives and operations for processing GML data.
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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
use crate::error::Error;
use crate::model::geometry::DirectPosition;
use crate::model::geometry::primitives::{
    AbstractRing, AbstractSolid, AbstractSurface, LinearRing, Polygon, RingPropertyKind, Solid,
    SurfaceKind, SurfaceProperty, TriangulatedSurface,
};
use nalgebra::{Isometry3, Point3, Vector3};
use std::fmt;

/// Axis-aligned bounding box in 3-D space.
///
/// An `Envelope` is defined by a lower corner and an upper corner such that
/// each coordinate component of the lower corner is ≤ the corresponding
/// component of the upper corner.
///
/// Corresponds to `gml:EnvelopeType` in ISO 19136.
#[derive(Debug, Clone, PartialEq, Default)]
pub struct Envelope {
    lower_corner: DirectPosition,
    upper_corner: DirectPosition,

    srs_name: Option<String>,
    srs_dimension: Option<u8>,
}

impl Envelope {
    /// Creates an envelope from explicit lower and upper corners.
    ///
    /// # Errors
    ///
    /// Returns [`Error::InvalidEnvelopeBounds`] if any coordinate
    /// component of `lower_corner` is strictly greater than the corresponding
    /// component of `upper_corner`.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use egml_core::model::geometry::{DirectPosition, Envelope};
    ///
    /// let lo = DirectPosition::new(0.0, 0.0, 0.0).unwrap();
    /// let hi = DirectPosition::new(1.0, 2.0, 3.0).unwrap();
    /// let env = Envelope::new(lo, hi).unwrap();
    /// assert_eq!(env.size_x(), 1.0);
    /// ```
    pub fn new(lower_corner: DirectPosition, upper_corner: DirectPosition) -> Result<Self, Error> {
        if lower_corner.x() > upper_corner.x() {
            return Err(Error::InvalidEnvelopeBounds {
                axis: "x",
                lower: lower_corner.x(),
                upper: upper_corner.x(),
            });
        }
        if lower_corner.y() > upper_corner.y() {
            return Err(Error::InvalidEnvelopeBounds {
                axis: "y",
                lower: lower_corner.y(),
                upper: upper_corner.y(),
            });
        }
        if lower_corner.z() > upper_corner.z() {
            return Err(Error::InvalidEnvelopeBounds {
                axis: "z",
                lower: lower_corner.z(),
                upper: upper_corner.z(),
            });
        }

        Ok(Self {
            lower_corner,
            upper_corner,
            srs_name: None,
            srs_dimension: None,
        })
    }

    /// Creates an `Envelope` without validating that `lower_corner <= upper_corner`.
    ///
    /// # Safety (logical)
    /// The caller must ensure that each component of `lower_corner` is less than
    /// or equal to the corresponding component of `upper_corner`. Violating this
    /// will not cause undefined behavior, but will break the type's invariants
    /// and produce incorrect results from methods like `contains`, `size`, etc.
    pub(crate) fn new_unchecked(
        lower_corner: DirectPosition,
        upper_corner: DirectPosition,
    ) -> Self {
        debug_assert!(
            {
                let lc: Point3<f64> = lower_corner.into();
                let uc: Point3<f64> = upper_corner.into();
                lc <= uc
            },
            "lower_corner must be <= upper_corner"
        );

        Self {
            lower_corner,
            upper_corner,
            srs_name: None,
            srs_dimension: None,
        }
    }

    /// Returns the lower (minimum) corner.
    pub fn lower_corner(&self) -> &DirectPosition {
        &self.lower_corner
    }

    /// Returns the upper (maximum) corner.
    pub fn upper_corner(&self) -> &DirectPosition {
        &self.upper_corner
    }

    /// Returns the diagonal vector from the lower corner to the upper corner.
    pub fn size(&self) -> Vector3<f64> {
        let lower_corner_point: Point3<f64> = self.lower_corner.into();
        let upper_corner_point: Point3<f64> = self.upper_corner.into();
        upper_corner_point - lower_corner_point
    }

    /// Returns the extent along the X axis (`upper.x - lower.x`).
    pub fn size_x(&self) -> f64 {
        self.upper_corner.x() - self.lower_corner.x()
    }

    /// Returns the extent along the Y axis (`upper.y - lower.y`).
    pub fn size_y(&self) -> f64 {
        self.upper_corner.y() - self.lower_corner.y()
    }

    /// Returns the extent along the Z axis (`upper.z - lower.z`).
    pub fn size_z(&self) -> f64 {
        self.upper_corner.z() - self.lower_corner.z()
    }

    /// Returns the volume of the box (`size_x * size_y * size_z`).
    ///
    /// Returns `0.0` for degenerate envelopes where one or more extents are zero.
    pub fn volume(&self) -> f64 {
        self.size_x() * self.size_y() * self.size_z()
    }

    /// Returns `true` if the lower and upper corners are equal, i.e. the envelope collapses to a point.
    pub fn is_point(&self) -> bool {
        self.lower_corner == self.upper_corner
    }

    /// Returns `true` if exactly one axis has non-zero extent (a line segment).
    #[allow(clippy::nonminimal_bool)]
    pub fn is_linear(&self) -> bool {
        let nx = self.size_x() > 0.0;
        let ny = self.size_y() > 0.0;
        let nz = self.size_z() > 0.0;
        (nx && !ny && !nz) || (!nx && ny && !nz) || (!nx && !ny && nz)
    }

    /// Returns `true` if exactly two axes have non-zero extent (a flat rectangle).
    #[allow(clippy::nonminimal_bool)]
    pub fn is_surface(&self) -> bool {
        let nx = self.size_x() > 0.0;
        let ny = self.size_y() > 0.0;
        let nz = self.size_z() > 0.0;
        (nx && ny && !nz) || (nx && !ny && nz) || (!nx && ny && nz)
    }

    /// Returns `true` if all three axes have non-zero extent.
    pub fn is_volume(&self) -> bool {
        self.size_x() > 0.0 && self.size_y() > 0.0 && self.size_z() > 0.0
    }

    fn non_zero_extents(&self) -> u8 {
        [self.size_x(), self.size_y(), self.size_z()]
            .iter()
            .filter(|&&s| s > 0.0)
            .count() as u8
    }

    /// Returns the center point of the envelope.
    ///
    /// Computed as `lower + size / 2` to avoid overflow with large coordinates.
    pub fn center(&self) -> DirectPosition {
        DirectPosition::new(
            self.lower_corner.x() + self.size_x() / 2.0,
            self.lower_corner.y() + self.size_y() / 2.0,
            self.lower_corner.z() + self.size_z() / 2.0,
        )
        .expect("envelope corners are finite")
    }

    /// Returns `true` if `point` lies inside or on the boundary of this envelope.
    pub fn contains(&self, point: &DirectPosition) -> bool {
        let lower_corner: Point3<f64> = self.lower_corner.into();
        let upper_corner: Point3<f64> = self.upper_corner.into();
        let point: Point3<f64> = (*point).into();

        lower_corner <= point && point <= upper_corner
    }

    /// Returns `true` if `envelope` is fully contained within (or touches the boundary of) `self`.
    pub fn contains_envelope(&self, envelope: &Envelope) -> bool {
        self.contains(&envelope.lower_corner) && self.contains(&envelope.upper_corner)
    }

    /// Returns `true` if any corner of `envelope` lies inside or on the boundary of `self`.
    pub fn contains_envelope_partially(&self, envelope: &Envelope) -> bool {
        self.contains(&envelope.lower_corner) || self.contains(&envelope.upper_corner)
    }

    /// Returns a new envelope expanded by `distance` in every direction.
    ///
    /// Each lower-corner coordinate is decreased by `distance` and each
    /// upper-corner coordinate is increased by `distance`.
    ///
    /// # Errors
    ///
    /// Returns [`Error::NonFiniteCoordinate`] if `distance` is NaN or infinite,
    /// or if the resulting coordinates would overflow `f64::MAX`.
    pub fn enlarge(&self, distance: f64) -> Result<Envelope, Error> {
        let lower_corner = DirectPosition::new(
            self.lower_corner.x() - distance,
            self.lower_corner.y() - distance,
            self.lower_corner.z() - distance,
        )?;
        let upper_corner = DirectPosition::new(
            self.upper_corner.x() + distance,
            self.upper_corner.y() + distance,
            self.upper_corner.z() + distance,
        )?;

        Envelope::new(lower_corner, upper_corner)
    }

    /// Applies a rigid-body isometry (rotation + translation) to this envelope in place.
    ///
    /// Both corners are transformed and the result is re-fitted as an axis-aligned bounding
    /// box by taking per-axis minima/maxima. This keeps the AABB invariant valid after
    /// rotation, at the cost of a potentially larger box for non-axis-aligned rotations.
    ///
    /// # Examples
    ///
    /// ```rust
    /// use egml_core::model::geometry::{DirectPosition, Envelope};
    /// use nalgebra::{Isometry3, Vector3};
    ///
    /// let lo = DirectPosition::new(0.0, 0.0, 0.0).unwrap();
    /// let hi = DirectPosition::new(1.0, 2.0, 3.0).unwrap();
    /// let mut env = Envelope::new(lo, hi).unwrap();
    ///
    /// let translation = Isometry3::translation(10.0, 0.0, 0.0);
    /// env.apply_transform(&translation);
    ///
    /// assert_eq!(env.lower_corner().x(), 10.0);
    /// assert_eq!(env.upper_corner().x(), 11.0);
    /// ```
    pub fn apply_transform(&mut self, m: &Isometry3<f64>) {
        let transformed_lower_corner: Point3<f64> = m * Point3::from(self.lower_corner);
        let transformed_upper_corner: Point3<f64> = m * Point3::from(self.upper_corner);

        self.lower_corner = DirectPosition::new(
            transformed_lower_corner.x.min(transformed_upper_corner.x),
            transformed_lower_corner.y.min(transformed_upper_corner.y),
            transformed_lower_corner.z.min(transformed_upper_corner.z),
        )
        .expect("envelope corners are finite");
        self.upper_corner = DirectPosition::new(
            transformed_lower_corner.x.max(transformed_upper_corner.x),
            transformed_lower_corner.y.max(transformed_upper_corner.y),
            transformed_lower_corner.z.max(transformed_upper_corner.z),
        )
        .expect("envelope corners are finite");
    }
}

impl Envelope {
    /// Computes the union of a slice of envelopes.
    ///
    /// Returns `None` if `envelopes` is empty; otherwise returns the smallest
    /// envelope that contains all envelopes in the slice.
    pub fn from_envelopes(envelopes: &[Self]) -> Option<Self> {
        let first = envelopes.first()?;

        let (lower, upper) = envelopes.iter().skip(1).fold(
            (first.lower_corner, first.upper_corner),
            |(lo, hi), e| {
                let new_lo = DirectPosition::new(
                    lo.x().min(e.lower_corner.x()),
                    lo.y().min(e.lower_corner.y()),
                    lo.z().min(e.lower_corner.z()),
                )
                .unwrap();
                let new_hi = DirectPosition::new(
                    hi.x().max(e.upper_corner.x()),
                    hi.y().max(e.upper_corner.y()),
                    hi.z().max(e.upper_corner.z()),
                )
                .unwrap();
                (new_lo, new_hi)
            },
        );

        Some(Envelope::new_unchecked(lower, upper))
    }

    /// Computes the smallest envelope that contains all `points`.
    ///
    /// # Errors
    ///
    /// Returns [`Error::TooFewElements`] if `points` is empty.
    pub fn from_points(points: &[DirectPosition]) -> Result<Self, Error> {
        if points.is_empty() {
            return Err(Error::TooFewElements {
                geometry: "Envelope::from_points",
                minimum: 1,
                spec: None,
                id: None,
                detail: None,
            });
        }

        let first = &points[0];
        let (mut min_x, mut min_y, mut min_z) = (first.x(), first.y(), first.z());
        let (mut max_x, mut max_y, mut max_z) = (first.x(), first.y(), first.z());

        for point in points.iter().skip(1) {
            min_x = min_x.min(point.x());
            min_y = min_y.min(point.y());
            min_z = min_z.min(point.z());
            max_x = max_x.max(point.x());
            max_y = max_y.max(point.y());
            max_z = max_z.max(point.z());
        }

        let lower_corner = DirectPosition::new(min_x, min_y, min_z)?;
        let upper_corner = DirectPosition::new(max_x, max_y, max_z)?;

        Ok(Self::new_unchecked(lower_corner, upper_corner))
    }
}

impl Envelope {
    /// Constructs a [`Solid`] whose boundary is the six faces of the bounding box.
    ///
    /// Each face is a [`Polygon`] with an outward-facing [`LinearRing`] exterior.
    /// Faces are ordered: bottom (−z), top (+z), front (−y), back (+y), left (−x), right (+x).
    ///
    /// # Errors
    ///
    /// Returns [`Error::NotAVolume`] if the envelope does not have all three extents non-zero.
    pub fn to_solid(&self) -> Result<Solid, Error> {
        if !self.is_volume() {
            return Err(Error::NotAVolume {
                non_zero_extents: self.non_zero_extents(),
            });
        }

        let (lx, ly, lz) = (
            self.lower_corner.x(),
            self.lower_corner.y(),
            self.lower_corner.z(),
        );
        let (hx, hy, hz) = (
            self.upper_corner.x(),
            self.upper_corner.y(),
            self.upper_corner.z(),
        );

        let p000 = DirectPosition::new(lx, ly, lz).expect("envelope corners are finite");
        let p100 = DirectPosition::new(hx, ly, lz).expect("envelope corners are finite");
        let p110 = DirectPosition::new(hx, hy, lz).expect("envelope corners are finite");
        let p010 = DirectPosition::new(lx, hy, lz).expect("envelope corners are finite");
        let p001 = DirectPosition::new(lx, ly, hz).expect("envelope corners are finite");
        let p101 = DirectPosition::new(hx, ly, hz).expect("envelope corners are finite");
        let p111 = DirectPosition::new(hx, hy, hz).expect("envelope corners are finite");
        let p011 = DirectPosition::new(lx, hy, hz).expect("envelope corners are finite");

        let face_rings: [Vec<DirectPosition>; 6] = [
            vec![p000, p010, p110, p100], // bottom (−z)
            vec![p001, p101, p111, p011], // top    (+z)
            vec![p000, p100, p101, p001], // front  (−y)
            vec![p010, p011, p111, p110], // back   (+y)
            vec![p000, p001, p011, p010], // left   (−x)
            vec![p100, p110, p111, p101], // right  (+x)
        ];

        let members: Vec<SurfaceProperty> = face_rings
            .into_iter()
            .map(|points| {
                let ring = LinearRing::new(AbstractRing::default(), points).ok()?;
                let polygon = Polygon::new(
                    AbstractSurface::default(),
                    Some(RingPropertyKind::LinearRing(ring)),
                    vec![],
                )
                .ok()?;
                Some(SurfaceProperty::new(SurfaceKind::Polygon(polygon)))
            })
            .collect::<Option<_>>()
            .expect("envelope corners are finite and valid");

        let solid = Solid::new(AbstractSolid::default(), members).expect("envelope is valid");
        Ok(solid)
    }

    /// Constructs a [`Polygon`] from the flat rectangle of this envelope.
    ///
    /// The four corners are wound counter-clockwise when viewed from the
    /// positive side of the collapsed axis (i.e. outward-facing normal).
    ///
    /// # Errors
    ///
    /// Returns [`Error::NotASurface`] if the envelope does not have exactly two non-zero extents.
    pub fn to_polygon(&self) -> Result<Polygon, Error> {
        if !self.is_surface() {
            return Err(Error::NotASurface {
                non_zero_extents: self.non_zero_extents(),
            });
        }

        let (lx, ly, lz) = (
            self.lower_corner.x(),
            self.lower_corner.y(),
            self.lower_corner.z(),
        );
        let (hx, hy, hz) = (
            self.upper_corner.x(),
            self.upper_corner.y(),
            self.upper_corner.z(),
        );

        let points = if self.size_z() == 0.0 {
            // XY plane — normal along +Z
            vec![
                DirectPosition::new(lx, ly, lz).expect("envelope corners are finite"),
                DirectPosition::new(hx, ly, lz).expect("envelope corners are finite"),
                DirectPosition::new(hx, hy, lz).expect("envelope corners are finite"),
                DirectPosition::new(lx, hy, lz).expect("envelope corners are finite"),
            ]
        } else if self.size_y() == 0.0 {
            // XZ plane — normal along +Y
            vec![
                DirectPosition::new(lx, ly, lz).expect("envelope corners are finite"),
                DirectPosition::new(lx, ly, hz).expect("envelope corners are finite"),
                DirectPosition::new(hx, ly, hz).expect("envelope corners are finite"),
                DirectPosition::new(hx, ly, lz).expect("envelope corners are finite"),
            ]
        } else {
            // YZ plane — normal along +X
            vec![
                DirectPosition::new(lx, ly, lz).expect("envelope corners are finite"),
                DirectPosition::new(lx, hy, lz).expect("envelope corners are finite"),
                DirectPosition::new(lx, hy, hz).expect("envelope corners are finite"),
                DirectPosition::new(lx, ly, hz).expect("envelope corners are finite"),
            ]
        };

        let ring = LinearRing::new(AbstractRing::default(), points)
            .expect("envelope corners are finite and valid");
        Polygon::new(
            AbstractSurface::default(),
            Some(RingPropertyKind::LinearRing(ring)),
            vec![],
        )
        .map_err(|_| Error::NotASurface {
            non_zero_extents: self.non_zero_extents(),
        })
    }

    /// Triangulates the envelope into a [`TriangulatedSurface`].
    ///
    /// - For a surface envelope (`is_surface()`): triangulates the single rectangular face.
    /// - For a volume envelope (`is_volume()`): triangulates all six bounding faces and merges them.
    ///
    /// # Errors
    ///
    /// Returns [`Error::NotSurfaceOrVolume`] if the envelope is a point or line segment.
    pub fn to_triangulated_surface(&self) -> Result<TriangulatedSurface, Error> {
        if self.is_surface() {
            self.to_polygon()?.triangulate()
        } else if self.is_volume() {
            self.to_solid()?.triangulate()
        } else {
            Err(Error::NotSurfaceOrVolume {
                non_zero_extents: self.non_zero_extents(),
            })
        }
    }
}

impl fmt::Display for Envelope {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "Envelope[{}, {}, {} -> {}, {}, {}]",
            self.lower_corner.x(),
            self.lower_corner.y(),
            self.lower_corner.z(),
            self.upper_corner.x(),
            self.upper_corner.y(),
            self.upper_corner.z()
        )
    }
}

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

    fn pos(x: f64, y: f64, z: f64) -> DirectPosition {
        DirectPosition::new(x, y, z).unwrap()
    }

    fn env(lx: f64, ly: f64, lz: f64, ux: f64, uy: f64, uz: f64) -> Envelope {
        Envelope::new(pos(lx, ly, lz), pos(ux, uy, uz)).unwrap()
    }

    #[test]
    fn from_envelopes_empty_returns_none() {
        let result = Envelope::from_envelopes(&[]);
        assert!(result.is_none());
    }

    #[test]
    fn from_envelopes_single_returns_same_envelope() {
        let e = env(1.0, 2.0, 3.0, 4.0, 5.0, 6.0);
        let result = Envelope::from_envelopes(&[e.clone()]).unwrap();

        assert_eq!(result, e);
    }

    #[test]
    fn from_envelopes_two_disjoint() {
        let a = env(0.0, 0.0, 0.0, 1.0, 1.0, 1.0);
        let b = env(5.0, 6.0, 7.0, 8.0, 9.0, 10.0);
        let result = Envelope::from_envelopes(&[a, b]).unwrap();

        assert_eq!(result, env(0.0, 0.0, 0.0, 8.0, 9.0, 10.0));
    }

    #[test]
    fn from_envelopes_overlapping() {
        let a = env(0.0, 0.0, 0.0, 5.0, 5.0, 5.0);
        let b = env(3.0, 3.0, 3.0, 7.0, 7.0, 7.0);
        let result = Envelope::from_envelopes(&[a, b]).unwrap();

        assert_eq!(result, env(0.0, 0.0, 0.0, 7.0, 7.0, 7.0));
    }

    #[test]
    fn from_envelopes_one_contains_the_other() {
        let outer = env(0.0, 0.0, 0.0, 10.0, 10.0, 10.0);
        let inner = env(2.0, 3.0, 4.0, 5.0, 6.0, 7.0);
        let result = Envelope::from_envelopes(&[outer.clone(), inner]).unwrap();

        assert_eq!(result, outer);
    }

    #[test]
    fn from_envelopes_multiple() {
        let a = env(0.0, 10.0, 20.0, 1.0, 11.0, 21.0);
        let b = env(-5.0, 8.0, 25.0, 2.0, 12.0, 30.0);
        let c = env(1.0, 9.0, 18.0, 3.0, 15.0, 22.0);
        let result = Envelope::from_envelopes(&[a, b, c]).unwrap();

        assert_eq!(result, env(-5.0, 8.0, 18.0, 3.0, 15.0, 30.0));
    }

    #[test]
    fn from_envelopes_with_negative_coords() {
        let a = env(-10.0, -20.0, -30.0, -1.0, -2.0, -3.0);
        let b = env(-5.0, -25.0, -15.0, 0.0, -1.0, 0.0);
        let result = Envelope::from_envelopes(&[a, b]).unwrap();

        assert_eq!(result, env(-10.0, -25.0, -30.0, 0.0, -1.0, 0.0));
    }

    #[test]
    fn from_envelopes_zero_volume_envelopes() {
        let a = env(1.0, 1.0, 1.0, 1.0, 1.0, 1.0); // point
        let b = env(3.0, 3.0, 3.0, 3.0, 3.0, 3.0); // point
        let result = Envelope::from_envelopes(&[a, b]).unwrap();

        assert_eq!(result, env(1.0, 1.0, 1.0, 3.0, 3.0, 3.0));
    }

    #[test]
    fn is_point_when_corners_equal() {
        let e = env(1.0, 2.0, 3.0, 1.0, 2.0, 3.0);
        assert!(e.is_point());
        assert!(!e.is_linear());
        assert!(!e.is_surface());
        assert!(!e.is_volume());
    }

    #[test]
    fn is_linear_along_x() {
        let e = env(0.0, 0.0, 0.0, 1.0, 0.0, 0.0);
        assert!(!e.is_point());
        assert!(e.is_linear());
        assert!(!e.is_surface());
        assert!(!e.is_volume());
    }

    #[test]
    fn is_linear_along_y() {
        let e = env(0.0, 0.0, 0.0, 0.0, 1.0, 0.0);
        assert!(e.is_linear());
    }

    #[test]
    fn is_linear_along_z() {
        let e = env(0.0, 0.0, 0.0, 0.0, 0.0, 1.0);
        assert!(e.is_linear());
    }

    #[test]
    fn is_surface_xy_plane() {
        let e = env(0.0, 0.0, 0.0, 1.0, 1.0, 0.0);
        assert!(!e.is_point());
        assert!(!e.is_linear());
        assert!(e.is_surface());
        assert!(!e.is_volume());
    }

    #[test]
    fn is_surface_xz_plane() {
        let e = env(0.0, 0.0, 0.0, 1.0, 0.0, 1.0);
        assert!(e.is_surface());
    }

    #[test]
    fn is_surface_yz_plane() {
        let e = env(0.0, 0.0, 0.0, 0.0, 1.0, 1.0);
        assert!(e.is_surface());
    }

    #[test]
    fn is_volume_all_extents_nonzero() {
        let e = env(0.0, 0.0, 0.0, 1.0, 1.0, 1.0);
        assert!(!e.is_point());
        assert!(!e.is_linear());
        assert!(!e.is_surface());
        assert!(e.is_volume());
    }

    #[test]
    fn to_polygon_returns_err_for_point() {
        assert_eq!(
            env(1.0, 1.0, 1.0, 1.0, 1.0, 1.0).to_polygon(),
            Err(Error::NotASurface {
                non_zero_extents: 0
            })
        );
    }

    #[test]
    fn to_polygon_returns_err_for_linear() {
        assert_eq!(
            env(0.0, 0.0, 0.0, 1.0, 0.0, 0.0).to_polygon(),
            Err(Error::NotASurface {
                non_zero_extents: 1
            })
        );
    }

    #[test]
    fn to_polygon_returns_err_for_volume() {
        assert_eq!(
            env(0.0, 0.0, 0.0, 1.0, 1.0, 1.0).to_polygon(),
            Err(Error::NotASurface {
                non_zero_extents: 3
            })
        );
    }

    #[test]
    fn to_polygon_xy_plane() {
        assert!(env(0.0, 0.0, 0.0, 2.0, 3.0, 0.0).to_polygon().is_ok());
    }

    #[test]
    fn to_polygon_xz_plane() {
        assert!(env(0.0, 0.0, 0.0, 2.0, 0.0, 3.0).to_polygon().is_ok());
    }

    #[test]
    fn to_polygon_yz_plane() {
        assert!(env(0.0, 0.0, 0.0, 0.0, 2.0, 3.0).to_polygon().is_ok());
    }

    #[test]
    fn to_triangulated_surface_returns_err_for_point() {
        assert_eq!(
            env(0.0, 0.0, 0.0, 0.0, 0.0, 0.0).to_triangulated_surface(),
            Err(Error::NotSurfaceOrVolume {
                non_zero_extents: 0
            })
        );
    }

    #[test]
    fn to_triangulated_surface_returns_err_for_linear() {
        assert_eq!(
            env(0.0, 0.0, 0.0, 1.0, 0.0, 0.0).to_triangulated_surface(),
            Err(Error::NotSurfaceOrVolume {
                non_zero_extents: 1
            })
        );
    }

    #[test]
    fn to_triangulated_surface_surface_has_two_triangles() {
        let result = env(0.0, 0.0, 0.0, 2.0, 3.0, 0.0)
            .to_triangulated_surface()
            .unwrap();
        assert_eq!(result.triangles().len(), 2);
    }

    #[test]
    fn to_triangulated_surface_volume_has_twelve_triangles() {
        let result = env(0.0, 0.0, 0.0, 1.0, 1.0, 1.0)
            .to_triangulated_surface()
            .unwrap();
        assert_eq!(result.triangles().len(), 12);
    }

    #[test]
    fn envelope_contains() {
        let lower_corner = DirectPosition::new(1.0, 2.0, 3.0).unwrap();
        let upper_corner = DirectPosition::new(2.0, 3.0, 4.0).unwrap();
        let envelope = Envelope::new(lower_corner, upper_corner).unwrap();
        let point_a = DirectPosition::new(1.5, 2.5, 3.5).unwrap();
        let point_b = DirectPosition::new(2.5, 3.5, 4.5).unwrap();

        assert!(envelope.contains(&point_a));
        assert!(!envelope.contains(&point_b));
    }
}