Merge pull request #1180 from hannobraun/stores

Integrate `GlobalVertex` into centralized object storage

crates/fj-kernel/src/algorithms/sweep/edge.rs

@@ -63,7 +63,7 @@ impl Sweep for (HalfEdge, Color) {
                     let surface_vertex = SurfaceVertex::new(
                         point_surface,
                         surface.clone(),
-                        *vertex.global_form(),
+                        vertex.global_form().clone(),
                     );
 
                     Vertex::new(
@@ -87,7 +87,7 @@ impl Sweep for (HalfEdge, Color) {
 
             let global_vertices = side_edges.clone().map(|edge| {
                 let [_, vertex] = edge.vertices();
-                *vertex.global_form()
+                vertex.global_form().clone()
             });
 
             let points_curve_and_surface =
@@ -113,8 +113,10 @@ impl Sweep for (HalfEdge, Color) {
                 Curve::new(surface.clone(), path, global, stores)
             };
 
-            let global =
-                GlobalEdge::new(curve.global_form().clone(), global_vertices);
+            let global = GlobalEdge::new(
+                curve.global_form().clone(),
+                global_vertices.clone(),
+            );
 
             let vertices = {
                 let surface_points = points_curve_and_surface

crates/fj-kernel/src/algorithms/sweep/vertex.rs

@@ -54,7 +54,7 @@ impl Sweep for (Vertex, Handle<Surface>) {
         // as that is the most straight-forward part of this operations, and
         // we're going to need it soon anyway.
         let (edge_global, vertices_global) =
-            vertex.global_form().sweep(path, stores);
+            vertex.global_form().clone().sweep(path, stores);
 
         // Next, let's compute the surface coordinates of the two vertices of
         // the output `Edge`, as we're going to need these for the rest of this
@@ -120,17 +120,18 @@ impl Sweep for (Vertex, Handle<Surface>) {
     }
 }
 
-impl Sweep for GlobalVertex {
-    type Swept = (GlobalEdge, [GlobalVertex; 2]);
+impl Sweep for Handle<GlobalVertex> {
+    type Swept = (GlobalEdge, [Handle<GlobalVertex>; 2]);
 
     fn sweep(self, path: impl Into<Vector<3>>, stores: &Stores) -> Self::Swept {
         let curve = GlobalCurve::new(stores);
 
-        let a = self;
-        let b = GlobalVertex::from_position(self.position() + path.into());
+        let a = self.clone();
+        let b =
+            GlobalVertex::from_position(self.position() + path.into(), stores);
 
         let vertices = [a, b];
-        let global_edge = GlobalEdge::new(curve, vertices);
+        let global_edge = GlobalEdge::new(curve, vertices.clone());
 
         // The vertices of the returned `GlobalEdge` are in normalized order,
         // which means the order can't be relied upon by the caller. Return the

crates/fj-kernel/src/algorithms/validate/mod.rs

@@ -37,9 +37,20 @@ pub trait Validate: Sized {
     /// # use fj_kernel::{
     /// #     algorithms::validate::{Validate, ValidationConfig},
     /// #     objects::GlobalVertex,
+    /// #     stores::Stores,
     /// # };
-    /// # let object = GlobalVertex::from_position([0., 0., 0.]);
+    /// # let stores = Stores::new();
+    /// # let object = GlobalVertex::from_position([0., 0., 0.], &stores);
     /// object.validate();
+    /// ```
+    /// ``` rust
+    /// # use fj_kernel::{
+    /// #     algorithms::validate::{Validate, ValidationConfig},
+    /// #     objects::GlobalVertex,
+    /// #     stores::Stores,
+    /// # };
+    /// # let stores = Stores::new();
+    /// # let object = GlobalVertex::from_position([0., 0., 0.], &stores);
     /// object.validate_with_config(&ValidationConfig::default());
     /// ```
     fn validate(self) -> Result<Validated<Self>, ValidationError> {
@@ -181,8 +192,8 @@ mod tests {
             Curve::new(surface.clone(), path, global_form, &stores)
         };
 
-        let [a_global, b_global] =
-            points_global.map(GlobalVertex::from_position);
+        let [a_global, b_global] = points_global
+            .map(|point| GlobalVertex::from_position(point, &stores));
 
         let [a_surface, b_surface] = {
             // Can be cleaned up, once `zip` is stable:
@@ -231,6 +242,7 @@ mod tests {
 
     #[test]
     fn uniqueness_vertex() -> anyhow::Result<()> {
+        let stores = Stores::new();
         let mut shape = Vec::new();
 
         let deviation = Scalar::from_f64(0.25);
@@ -246,11 +258,11 @@ mod tests {
         };
 
         // Adding a vertex should work.
-        shape.push(GlobalVertex::from_position(a));
+        shape.push(GlobalVertex::from_position(a, &stores));
         shape.clone().validate_with_config(&config)?;
 
         // Adding a second vertex that is considered identical should fail.
-        shape.push(GlobalVertex::from_position(b));
+        shape.push(GlobalVertex::from_position(b, &stores));
         let result = shape.validate_with_config(&config);
         assert!(matches!(result, Err(ValidationError::Uniqueness(_))));
 

crates/fj-kernel/src/builder/shell.rs

@@ -117,7 +117,7 @@ impl<'a> ShellBuilder<'a> {
                                 to.position() + [Z, edge_length],
                             ))
                             .with_surface(Some(surface.clone()))
-                            .with_global_form(Some(*from.global_form()));
+                            .with_global_form(Some(from.global_form().clone()));
 
                         let curve = Handle::<Curve>::partial()
                             .with_global_form(Some(
@@ -151,7 +151,7 @@ impl<'a> ShellBuilder<'a> {
                             from.position() + [-edge_length, Z],
                         ))
                         .with_surface(Some(surface.clone()))
-                        .with_global_form(Some(*to.global_form()));
+                        .with_global_form(Some(to.global_form().clone()));
 
                     let from = Vertex::partial().with_surface_form(Some(from));
                     let to = Vertex::partial().with_surface_form(Some(to));
@@ -208,7 +208,9 @@ impl<'a> ShellBuilder<'a> {
                         let surface_form = SurfaceVertex::partial()
                             .with_position(Some(point))
                             .with_surface(Some(surface.clone()))
-                            .with_global_form(Some(*vertex.global_form()))
+                            .with_global_form(Some(
+                                vertex.global_form().clone(),
+                            ))
                             .build(self.stores);
                         Vertex::partial()
                             .with_position(Some(vertex.position()))

crates/fj-kernel/src/iter.rs

@@ -192,7 +192,7 @@ impl<'r> ObjectIters<'r> for Handle<GlobalCurve> {
     }
 }
 
-impl<'r> ObjectIters<'r> for GlobalVertex {
+impl<'r> ObjectIters<'r> for Handle<GlobalVertex> {
     fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters> {
         Vec::new()
     }
@@ -460,7 +460,9 @@ mod tests {
 
     #[test]
     fn global_vertex() {
-        let object = GlobalVertex::from_position([0., 0., 0.]);
+        let stores = Stores::new();
+
+        let object = GlobalVertex::from_position([0., 0., 0.], &stores);
 
         assert_eq!(0, object.curve_iter().count());
         assert_eq!(0, object.cycle_iter().count());
@@ -586,7 +588,7 @@ mod tests {
             .with_surface(Some(surface.clone()))
             .as_u_axis()
             .build(&stores);
-        let global_vertex = GlobalVertex::from_position([0., 0., 0.]);
+        let global_vertex = GlobalVertex::from_position([0., 0., 0.], &stores);
         let surface_vertex =
             SurfaceVertex::new([0., 0.], surface, global_vertex);
         let object = Vertex::new([0.], curve, surface_vertex);

crates/fj-kernel/src/objects/edge.rs

@@ -48,7 +48,7 @@ impl HalfEdge {
         );
         assert_eq!(
             &normalize_vertex_order(
-                [&a, &b].map(|vertex| *vertex.global_form())
+                [&a, &b].map(|vertex| vertex.global_form().clone())
             ),
             global_form.vertices_in_normalized_order(),
             "The global forms of a half-edge's vertices must match the \
@@ -104,7 +104,7 @@ impl fmt::Display for HalfEdge {
 #[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
 pub struct GlobalEdge {
     curve: HandleWrapper<GlobalCurve>,
-    vertices: [GlobalVertex; 2],
+    vertices: [Handle<GlobalVertex>; 2],
 }
 
 impl GlobalEdge {
@@ -115,7 +115,7 @@ impl GlobalEdge {
     /// of `vertices` here.
     pub fn new(
         curve: impl Into<HandleWrapper<GlobalCurve>>,
-        vertices: [GlobalVertex; 2],
+        vertices: [Handle<GlobalVertex>; 2],
     ) -> Self {
         let curve = curve.into();
         let vertices = normalize_vertex_order(vertices);
@@ -137,12 +137,14 @@ impl GlobalEdge {
     /// and might not match the order of the vertices that were passed to
     /// [`GlobalEdge::new`]. You must not rely on the vertices being in any
     /// specific order.
-    pub fn vertices_in_normalized_order(&self) -> &[GlobalVertex; 2] {
+    pub fn vertices_in_normalized_order(&self) -> &[Handle<GlobalVertex>; 2] {
         &self.vertices
     }
 }
 
-fn normalize_vertex_order([a, b]: [GlobalVertex; 2]) -> [GlobalVertex; 2] {
+fn normalize_vertex_order(
+    [a, b]: [Handle<GlobalVertex>; 2],
+) -> [Handle<GlobalVertex>; 2] {
     if a < b {
         [a, b]
     } else {

crates/fj-kernel/src/objects/vertex.rs

@@ -1,7 +1,7 @@
 use fj_math::Point;
 use pretty_assertions::assert_eq;
 
-use crate::stores::Handle;
+use crate::stores::{Handle, Stores};
 
 use super::{Curve, Surface};
 
@@ -58,7 +58,7 @@ impl Vertex {
     }
 
     /// Access the global form of this vertex
-    pub fn global_form(&self) -> &GlobalVertex {
+    pub fn global_form(&self) -> &Handle<GlobalVertex> {
         self.surface_form.global_form()
     }
 }
@@ -68,15 +68,15 @@ impl Vertex {
 pub struct SurfaceVertex {
     position: Point<2>,
     surface: Handle<Surface>,
-    global_form: GlobalVertex,
+    global_form: Handle<GlobalVertex>,
 }
 
 impl SurfaceVertex {
     /// Construct a new instance of `SurfaceVertex`
     pub fn new(
         position: impl Into<Point<2>>,
         surface: Handle<Surface>,
-        global_form: GlobalVertex,
+        global_form: Handle<GlobalVertex>,
     ) -> Self {
         let position = position.into();
         Self {
@@ -97,7 +97,7 @@ impl SurfaceVertex {
     }
 
     /// Access the global form of this vertex
-    pub fn global_form(&self) -> &GlobalVertex {
+    pub fn global_form(&self) -> &Handle<GlobalVertex> {
         &self.global_form
     }
 }
@@ -127,9 +127,12 @@ pub struct GlobalVertex {
 
 impl GlobalVertex {
     /// Construct a `GlobalVertex` from a position
-    pub fn from_position(position: impl Into<Point<3>>) -> Self {
+    pub fn from_position(
+        position: impl Into<Point<3>>,
+        stores: &Stores,
+    ) -> Handle<Self> {
         let position = position.into();
-        Self { position }
+        stores.global_vertices.insert(Self { position })
     }
 
     /// Access the position of the vertex

crates/fj-kernel/src/partial/objects/edge.rs

@@ -81,7 +81,7 @@ impl PartialHalfEdge {
             let [a_curve, b_curve] =
                 [Scalar::ZERO, Scalar::TAU].map(|coord| Point::from([coord]));
 
-            let global_vertex = GlobalVertex::partial()
+            let global_vertex = Handle::<GlobalVertex>::partial()
                 .from_curve_and_position(curve.clone(), a_curve);
 
             [a_curve, b_curve].map(|point_curve| {
@@ -236,7 +236,7 @@ pub struct PartialGlobalEdge {
     /// The vertices that bound the [`GlobalEdge`] in the curve
     ///
     /// Must be provided before [`PartialGlobalEdge::build`] is called.
-    pub vertices: Option<[GlobalVertex; 2]>,
+    pub vertices: Option<[Handle<GlobalVertex>; 2]>,
 }
 
 impl PartialGlobalEdge {
@@ -251,7 +251,7 @@ impl PartialGlobalEdge {
     /// Update the partial global edge with the given vertices
     pub fn with_vertices(
         mut self,
-        vertices: Option<[GlobalVertex; 2]>,
+        vertices: Option<[Handle<GlobalVertex>; 2]>,
     ) -> Self {
         if let Some(vertices) = vertices {
             self.vertices = Some(vertices);
@@ -267,7 +267,7 @@ impl PartialGlobalEdge {
     ) -> Self {
         self.with_curve(Some(curve.global_form().clone()))
             .with_vertices(Some(
-                vertices.clone().map(|vertex| *vertex.global_form()),
+                vertices.clone().map(|vertex| vertex.global_form().clone()),
             ))
     }
 
@@ -288,7 +288,7 @@ impl From<&GlobalEdge> for PartialGlobalEdge {
     fn from(global_edge: &GlobalEdge) -> Self {
         Self {
             curve: Some(global_edge.curve().clone().into()),
-            vertices: Some(*global_edge.vertices_in_normalized_order()),
+            vertices: Some(global_edge.vertices_in_normalized_order().clone()),
         }
     }
 }

crates/fj-kernel/src/partial/objects/mod.rs

@@ -44,7 +44,7 @@ impl_traits!(
     Handle<Curve>, PartialCurve;
     Cycle, PartialCycle;
     GlobalEdge, PartialGlobalEdge;
-    GlobalVertex, PartialGlobalVertex;
+    Handle<GlobalVertex>, PartialGlobalVertex;
     HalfEdge, PartialHalfEdge;
     SurfaceVertex, PartialSurfaceVertex;
     Vertex, PartialVertex;