diff --git a/crates/fj-kernel/src/objects/cycle.rs b/crates/fj-kernel/src/objects/cycle.rs index bf05475c2..363a4f317 100644 --- a/crates/fj-kernel/src/objects/cycle.rs +++ b/crates/fj-kernel/src/objects/cycle.rs @@ -40,10 +40,7 @@ impl Cycle { Cycle { edges } } - /// Access the edges that this cycle refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]s. + /// Access this cycle's edges pub fn edges(&self) -> impl Iterator + '_ { self.edges.iter().cloned() } diff --git a/crates/fj-kernel/src/objects/edge.rs b/crates/fj-kernel/src/objects/edge.rs index c3f95c37a..0524c3815 100644 --- a/crates/fj-kernel/src/objects/edge.rs +++ b/crates/fj-kernel/src/objects/edge.rs @@ -76,18 +76,12 @@ impl Edge { } } - /// Access the curve that the edge refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]. + /// Access this edge's curve pub fn curve(&self) -> Curve<3> { self.curve.global() } - /// Access the vertices that the edge refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]s. + /// Access this edge's vertices pub fn vertices(&self) -> Option<[Vertex; 2]> { self.vertices.0 } diff --git a/crates/fj-kernel/src/objects/face.rs b/crates/fj-kernel/src/objects/face.rs index 3987c7138..1076fa08c 100644 --- a/crates/fj-kernel/src/objects/face.rs +++ b/crates/fj-kernel/src/objects/face.rs @@ -58,31 +58,22 @@ impl Face { } } - /// Access the surface that the face refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]. + /// Access this face's surface pub fn surface(&self) -> Surface { self.brep().surface() } - /// Access the exterior cycles that the face refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]s. + /// Access this face's exterior cycles pub fn exteriors(&self) -> impl Iterator + '_ { self.brep().exteriors() } - /// Access the interior cycles that the face refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]s. + /// Access this face's interior cycles pub fn interiors(&self) -> impl Iterator + '_ { self.brep().interiors() } - /// Access all cycles that the face refers to + /// Access all cycles of this face /// /// This is equivalent to chaining the iterators returned by /// [`Face::exteriors`] and [`Face::interiors`]. @@ -132,31 +123,22 @@ pub struct FaceBRep { } impl FaceBRep { - /// Access the surface that the face refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]. + /// Access this face's surface pub fn surface(&self) -> Surface { self.surface } - /// Access the exterior cycles that the face refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]s. + /// Access this face's exterior cycles pub fn exteriors(&self) -> impl Iterator + '_ { self.exteriors.as_local() } - /// Access the interior cycles that the face refers to - /// - /// This is a convenience method that saves the caller from dealing with the - /// [`Handle`]s. + /// Access this face's interior cycles pub fn interiors(&self) -> impl Iterator + '_ { self.interiors.as_local() } - /// Access all cycles that the face refers to + /// Access all cycles of this face /// /// This is equivalent to chaining the iterators returned by /// [`Face::exteriors`] and [`Face::interiors`]. diff --git a/crates/fj-kernel/src/objects/global_vertex.rs b/crates/fj-kernel/src/objects/global_vertex.rs index d3447455d..6c3957108 100644 --- a/crates/fj-kernel/src/objects/global_vertex.rs +++ b/crates/fj-kernel/src/objects/global_vertex.rs @@ -16,8 +16,10 @@ use fj_math::Point; /// Vertices must be unique within a shape, meaning an identical vertex must not /// exist in the same shape. In the context of vertex uniqueness, points that /// are close to each other are considered identical. The minimum distance -/// between distinct vertices can be configured using -/// [`Shape::with_minimum_distance`]. +/// between distinct vertices can be configured using the respective field in +/// [`ValidationConfig`]. +/// +/// [`ValidationConfig`]: crate::validation::ValidationConfig #[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)] pub struct GlobalVertex { position: Point<3>, diff --git a/crates/fj-kernel/src/validation/mod.rs b/crates/fj-kernel/src/validation/mod.rs index a04a9d8ee..506188bea 100644 --- a/crates/fj-kernel/src/validation/mod.rs +++ b/crates/fj-kernel/src/validation/mod.rs @@ -13,17 +13,6 @@ //! //! Please note that not all of these validation categories are fully //! implemented, as of this writing. -//! -//! # Implementation Note -//! -//! There is an ongoing effort to abolish [`Shape`] and replace it with a much -//! simpler data structure: -//! -//! -//! Once completed, this would make structural validation moot, and reduce the -//! scope of uniqueness validation. -//! -//! [`Shape`]: crate::shape::Shape mod coherence; mod uniqueness; @@ -39,7 +28,7 @@ use fj_math::Scalar; use crate::iter::ObjectIters; -/// Validate the given [`Shape`] +/// Validate the given object pub fn validate( object: T, config: &ValidationConfig,