brepkit-offset 3.2.11

Solid offset engine for brepkit
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

//! Integration tests for the offset pipeline.
#![allow(clippy::unwrap_used, clippy::expect_used)]

use brepkit_offset::{OffsetOptions, offset_solid};
use brepkit_operations::measure::solid_volume;
use brepkit_operations::primitives::{make_box, make_cylinder, make_sphere, make_torus};
use brepkit_topology::Topology;

fn offset_opts() -> OffsetOptions {
    OffsetOptions {
        remove_self_intersections: false,
        ..Default::default()
    }
}

#[test]
fn offset_box_outward_face_count() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 2.0, 2.0, 2.0).unwrap();
    let result = offset_solid(&mut topo, solid, 0.5, offset_opts()).unwrap();
    let shell = topo
        .shell(topo.solid(result).unwrap().outer_shell())
        .unwrap();
    assert_eq!(shell.faces().len(), 6, "offset box should have 6 faces");
}

#[test]
fn offset_box_inward_face_count() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 4.0, 4.0, 4.0).unwrap();
    let result = offset_solid(&mut topo, solid, -0.5, offset_opts()).unwrap();
    let shell = topo
        .shell(topo.solid(result).unwrap().outer_shell())
        .unwrap();
    assert_eq!(shell.faces().len(), 6);
}

#[test]
fn offset_rectangular_box() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 3.0, 5.0, 7.0).unwrap();
    let result = offset_solid(&mut topo, solid, 1.0, offset_opts()).unwrap();
    let shell = topo
        .shell(topo.solid(result).unwrap().outer_shell())
        .unwrap();
    assert_eq!(shell.faces().len(), 6);
}

// Volume tests — for planar offsets, Phase 3 computes exact intersection
// line endpoints using the offset distance as margin (no percentage-based
// approximation), and the wire builder clips edges at exact line-line
// intersection corners.  Corner vertices use the first line's point
// directly (no midpoint averaging) since coplanar lines intersect exactly.
// This gives exact volumes for box offsets.

#[test]
fn offset_box_outward_exact_volume() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 2.0, 2.0, 2.0).unwrap();
    let result = offset_solid(&mut topo, solid, 0.5, offset_opts()).unwrap();
    let vol = solid_volume(&topo, result, 0.01).unwrap();
    let expected = 27.0_f64; // (2+1)^3
    let error_pct = ((vol - expected) / expected * 100.0).abs();
    assert!(
        error_pct < 0.01,
        "outward offset volume {vol:.10} should be {expected}, error {error_pct:.6}%"
    );
}

#[test]
fn offset_box_inward_exact_volume() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 4.0, 4.0, 4.0).unwrap();
    let result = offset_solid(&mut topo, solid, -0.5, offset_opts()).unwrap();
    let vol = solid_volume(&topo, result, 0.01).unwrap();
    let expected = 27.0_f64; // (4-1)^3
    let error_pct = ((vol - expected) / expected * 100.0).abs();
    assert!(
        error_pct < 0.01,
        "inward offset volume {vol:.10} should be {expected}, error {error_pct:.6}%"
    );
}

#[test]
fn offset_rectangular_box_exact_volume() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 3.0, 5.0, 7.0).unwrap();
    let result = offset_solid(&mut topo, solid, 1.0, offset_opts()).unwrap();
    let vol = solid_volume(&topo, result, 0.01).unwrap();
    let expected = 5.0 * 7.0 * 9.0; // 315
    let error_pct = ((vol - expected) / expected * 100.0).abs();
    assert!(
        error_pct < 0.01,
        "rectangular offset volume {vol:.10} should be {expected}, error {error_pct:.6}%"
    );
}

#[test]
fn offset_rectangular_box_inward_exact_volume() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 3.0, 5.0, 7.0).unwrap();
    let result = offset_solid(&mut topo, solid, -0.5, offset_opts()).unwrap();
    let vol = solid_volume(&topo, result, 0.01).unwrap();
    let expected = 2.0 * 4.0 * 6.0; // 48
    let error_pct = ((vol - expected) / expected * 100.0).abs();
    assert!(
        error_pct < 0.01,
        "inward rectangular offset volume {vol:.10} should be {expected}, error {error_pct:.6}%"
    );
}

#[test]
fn offset_box_outward_volume_larger_than_original() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 2.0, 2.0, 2.0).unwrap();
    let original_vol = solid_volume(&topo, solid, 0.1).unwrap();

    let result = offset_solid(&mut topo, solid, 0.5, offset_opts()).unwrap();
    let offset_vol = solid_volume(&topo, result, 0.1).unwrap();
    assert!(
        offset_vol > original_vol,
        "outward offset volume ({offset_vol}) should exceed original ({original_vol})"
    );
}

#[test]
fn offset_box_inward_volume_smaller_than_original() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 4.0, 4.0, 4.0).unwrap();
    let original_vol = solid_volume(&topo, solid, 0.1).unwrap();

    let result = offset_solid(&mut topo, solid, -0.5, offset_opts()).unwrap();
    let offset_vol = solid_volume(&topo, result, 0.1).unwrap();
    assert!(
        offset_vol < original_vol,
        "inward offset volume ({offset_vol}) should be less than original ({original_vol})"
    );
}

// ── Cylinder offset tests ──────────────────────────────────────

#[test]
fn offset_cylinder_outward_produces_solid() {
    let mut topo = Topology::new();
    let solid = make_cylinder(&mut topo, 2.0, 5.0).unwrap();
    let result = offset_solid(&mut topo, solid, 0.5, offset_opts()).unwrap();
    let shell = topo
        .shell(topo.solid(result).unwrap().outer_shell())
        .unwrap();
    assert!(
        shell.faces().len() >= 3,
        "offset cylinder should have at least 3 faces, got {}",
        shell.faces().len()
    );
}

#[test]
fn offset_cylinder_volume_increases() {
    let mut topo = Topology::new();
    let solid = make_cylinder(&mut topo, 2.0, 5.0).unwrap();
    let original_vol = solid_volume(&topo, solid, 0.1).unwrap();

    if let Ok(result) = offset_solid(&mut topo, solid, 0.5, offset_opts()) {
        let offset_vol = solid_volume(&topo, result, 0.1).unwrap();
        assert!(
            offset_vol > original_vol,
            "outward offset volume ({offset_vol}) should exceed original ({original_vol})"
        );
    }
}

// ── Thick solid (shell) tests ─────────────────────────────────

#[test]
fn thick_solid_box_produces_hollow() {
    let mut topo = Topology::new();
    let solid = make_box(&mut topo, 2.0, 2.0, 2.0).unwrap();
    let shell_id = topo.solid(solid).unwrap().outer_shell();
    let faces: Vec<_> = topo.shell(shell_id).unwrap().faces().to_vec();
    let exclude = vec![faces[0]];

    let result =
        brepkit_offset::thick_solid(&mut topo, solid, -0.2, &exclude, offset_opts()).unwrap();

    let result_shell = topo
        .shell(topo.solid(result).unwrap().outer_shell())
        .unwrap();
    assert!(
        result_shell.faces().len() >= 9,
        "thick solid should have >= 9 faces, got {}",
        result_shell.faces().len()
    );

    let vol = solid_volume(&topo, result, 0.1).unwrap();
    assert!(
        vol > 0.0,
        "thick solid should have positive volume, got {vol}"
    );
}

// ── Sphere offset tests ────────────────────────────────────────

#[test]
fn offset_sphere_outward_produces_solid() {
    let mut topo = Topology::new();
    let solid = make_sphere(&mut topo, 3.0, 16_usize).unwrap();
    let result = offset_solid(&mut topo, solid, 0.5, offset_opts()).unwrap();
    let shell = topo
        .shell(topo.solid(result).unwrap().outer_shell())
        .unwrap();
    assert!(!shell.faces().is_empty(), "offset sphere should have faces");
}

#[test]
fn offset_torus_stays_analytic() {
    // Regression: a torus face is doubly-periodic (a fundamental-polygon wire
    // with degenerate v0->v0 seam edges). The offset wire-builder's circle/seam
    // and chaining strategies couldn't rebuild it, so the offset solid ended up
    // with no faces ("no faces could be assembled"). The offset of a torus is a
    // concentric torus, so its fundamental-polygon wire is now rebuilt directly.
    for distance in [0.5_f64, -0.5, 1.0] {
        let mut topo = Topology::new();
        let solid = make_torus(&mut topo, 10.0, 3.0, 32).unwrap();
        let result = offset_solid(&mut topo, solid, distance, offset_opts()).unwrap();
        let shell = topo
            .shell(topo.solid(result).unwrap().outer_shell())
            .unwrap();
        assert_eq!(
            shell.faces().len(),
            1,
            "offset torus by {distance} should be a single torus face"
        );
        assert!(
            matches!(
                topo.face(shell.faces()[0]).unwrap().surface(),
                brepkit_topology::face::FaceSurface::Torus(_)
            ),
            "offset torus by {distance} must stay analytic (Torus surface)"
        );
    }
}