From 8c334a92c08158a4af8609a3fcc0ade32844380d Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 22 May 2024 20:01:04 +0200 Subject: [PATCH] Document `CoincidentHalfEdgesAreNotSiblings` --- crates/fj-core/src/validate/shell.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/crates/fj-core/src/validate/shell.rs b/crates/fj-core/src/validate/shell.rs index 694e6c356..d07c97229 100644 --- a/crates/fj-core/src/validate/shell.rs +++ b/crates/fj-core/src/validate/shell.rs @@ -117,6 +117,11 @@ impl ShellValidationError { } } +/// A [`Shell`] contains two [`HalfEdge`]s that are coincident but not siblings +/// +/// Coincident half-edges must reference the same curve, and have the same +/// boundaries on that curve. This provides clear, topological information, +/// which is important to handle the shell geometry in a robust way. #[derive(Clone, Debug, thiserror::Error)] pub struct CoincidentHalfEdgesAreNotSiblings { /// The boundaries of the half-edges