Repository navigation
feat(brep): make the BRep builder public - #36
Basnederveen wants to merge 2 commits into
Conversation
A crate that depends on OpenGeometry and needs a solid the primitives
don't cover can only build one by writing BRep JSON by hand. The builder
the kernel uses for every primitive and boolean result is crate-private.
- brep::{Builder, Use, boundary, plane_boundary, uv_line} are public:
Builder::{new, vertex, edge, face, face_with_holes, finish_solid}
- face() and face_with_holes() return the new face id
- Builder::brep() gives read access while building
- Builder::set_face_sense() sets a face's sense by id
- the types those signatures need are public: brep::Orientation,
brep::PcurveGeometry (and IntersectionSide), math::Interval::new
- the 14 internal tail calls of face() now end in `?; Ok(())`
tests/public_brep_builder.rs builds a box through the public API only:
valid, volume 24, inside/outside classification, STEP export; a face
sense set by id flips face_normal_at; an edge used by a third loop is
rejected.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01VFZvqx1RmXzPtbL9VXP4H7
aka-blackboots
left a comment
There was a problem hiding this comment.
Thanks for this, the need is real. The builder assumes trusted callers, though, so before it goes public I'd like the five points in the inline comments addressed.
| } | ||
|
|
||
| pub(crate) fn plane_boundary( | ||
| pub fn plane_boundary( |
There was a problem hiding this comment.
Bad ids panic. plane_boundary indexes edges[edge] and face_loop indexes vertices[u.from] unchecked.
Suggestion: use .get(..).ok_or(GeometryError::MissingReference { .. }), as set_face_sense already does, and check to as well.
| self.face_with_holes(key, surface, bounds, uses, Vec::new()) | ||
| } | ||
| pub(crate) fn face_with_holes( | ||
| pub fn face_with_holes( |
There was a problem hiding this comment.
A rejected face() leaves the builder half-written, so a corrected retry fails with "nonmanifold primitive edge".
Suggestion: in face_with_holes, check every use (edge exists, vertices exist, edge not already used twice) and build the two Intervals first, then write.
| }); | ||
| Ok(face) | ||
| } | ||
| pub fn set_face_sense(&mut self, face: u32, sense: Orientation) -> Result<(), GeometryError> { |
There was a problem hiding this comment.
finish_solid accepts an inside-out solid after set_face_sense; validate() never reads a face's sense.
Suggestion: say in the docs that the builder does not check orientation and the caller owns it, add a face_sense getter, and have the tests prove it for the solids they build: for each face, a point just off the face along face_normal_at classifies as Outside.
| #[derive(Clone, Debug, PartialEq, Serialize, Deserialize)] | ||
| #[serde(tag = "kind", deny_unknown_fields)] | ||
| pub(crate) enum PcurveGeometry { | ||
| pub enum PcurveGeometry { |
There was a problem hiding this comment.
PcurveGeometry is exposed whole, including two variants an outside caller can't build.
Suggestion: keep the enum private and add a uv_conic(origin, axis_a, axis_b) beside uv_line, both returning an opaque value that boundary() takes. If it must stay public, mark it #[non_exhaustive].
| } | ||
|
|
||
| #[test] | ||
| fn a_box_built_through_the_public_builder_is_a_valid_exportable_solid() { |
There was a problem hiding this comment.
Tests only cover a planar box.
Suggestion: add a face with a hole, a curved face with a seam edge, and a reversed face taken through finish_solid, plus one test each for the bad-id, rejected-face and orientation points.
What
The kernel builds every primitive and boolean result face by face with
brep::Builder, but the builder is crate-private. A crate that depends on OpenGeometry and needs a solid the primitives don't cover (for example a part made of planar faces and cylinder sectors, laid out by its own rules) can't build one, except by writing BRep JSON by hand and reading it back withBrepEnvelope::from_json. That path skips the checks the builder does as it goes (an edge used by a third loop, a missing edge) and gives no face ids back.This makes the builder usable from outside the crate, with the smallest surface that can describe a face:
brep::Builder:new,vertex,edge,face,face_with_holes,finish_solid, plus two new methods:brep(): read access to the body under construction (e.g. to look up an edge's curve);set_face_sense(face, Orientation): a face whose material normal opposes its surface normal (the inside of a tube), without reaching into the topology.faceandface_with_holesreturn the new face's id instead of(), soset_face_sensecan use it. The 14 internal call sites that used the call as a tail expression now end in?; Ok(()).brep::{Use, boundary, plane_boundary, uv_line}: the loop edge uses.brep::Orientation,brep::PcurveGeometry(withIntersectionSide, which one of its variants holds) andmath::Interval::new.PcurveGeometryandOrientationare already part of the BRep JSON schema.edge_geometry,face_loop,finish_wire,WireUse,dimensionsandpadded_uv_boundsstay crate-private. Nothing changes for the TypeScript API.Tests
tests/public_brep_builder.rs, using only the public API:finish_solidandvalidatepass, 12 edges and 24 half-edges, volume 24, a point inside classifies as Inside and one outside as Outside, STEP export writes 6 faces;set_face_senseon the top face's id turns itsface_normal_atfrom +z to -z, and an unknown id is aMissingReference;InvalidTopology.cargo fmt --checkandcargo clippy --all-targets -D warnings: clean.cargo test --all-targetswithCI=true(Windows x86_64, no golden file for this target): 788 pass, 0 fail, 1 ignored (mainwithout this change: 785 pass, 0 fail, the same 1 ignored; the 3 new tests are the difference).npm run check:source,check:duplicates,check:cycles: clean.check:apireads the builtdist/and was not run (this change has no TypeScript or WASM surface).Files
main/opengeometry/src/brep/builder/{brep_builder,boundary,mod}.rs,src/brep/mod.rs,src/brep/pcurve.rs,src/brep/topology/{mod,orientation}.rs,src/math/interval.rs: visibility, the face id return,brep()andset_face_sensesrc/primitives/andsrc/operations/modifying/boolean/handlers/cylinder_cylinder/: tail calls offacenow returnOk(())main/opengeometry/tests/public_brep_builder.rs(new)🤖 Generated with Claude Code