Renaming and API stabilization (#240)

Author: blitzarx1

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "egui_graphs"
-version = "0.25.1"
+version = "0.26.0"
 authors = ["Dmitrii Samsonov <blitzarx1@gmail.com>"]
 license = "MIT"
 homepage = "https://github.com/blitzarx1/egui_graphs"

examples/demo/Cargo.toml

@@ -6,11 +6,12 @@ license = "MIT"
 edition = "2021"
 
 [dependencies]
-egui_graphs = { version = "0.25", features = ["events"] }
+egui_graphs = { version = "0.24", features = ["events"] }
 egui = "0.31"
 eframe = "0.31"
 serde_json = "1.0"
 petgraph = "0.7"
+# TODO: need to implement fdg to upgrade to newer petgraph and egui_graphs
 fdg = { git = "https://github.com/grantshandy/fdg" }
 rand = "0.9"
 crossbeam = "0.8"

examples/demo/src/drawers.rs

@@ -7,7 +7,7 @@ pub struct ValuesConfigButtonsStartReset {
 pub fn draw_start_reset_buttons(
     ui: &mut egui::Ui,
     mut values: ValuesConfigButtonsStartReset,
-    mut on_change: impl FnMut(bool, bool),
+    mut on_change: impl FnMut(&mut egui::Ui, bool, bool),
 ) {
     ui.vertical(|ui| {
         ui.label("Stop or start simulation again or reset to default settings.");
@@ -29,7 +29,7 @@ pub fn draw_start_reset_buttons(
             }
 
             if start_simulation_stopped != values.simulation_stopped || reset_pressed {
-                on_change(values.simulation_stopped, reset_pressed);
+                on_change(ui, values.simulation_stopped, reset_pressed);
             }
         });
     });

examples/demo/src/main.rs

@@ -248,10 +248,10 @@ impl DemoApp {
             drawers::ValuesConfigButtonsStartReset {
                 simulation_stopped: self.simulation_stopped,
             },
-            |simulation_stopped: bool, reset_pressed: bool| {
+            |ui: &mut egui::Ui, simulation_stopped: bool, reset_pressed: bool| {
                 self.simulation_stopped = simulation_stopped;
                 if reset_pressed {
-                    self.reset()
+                    self.reset(ui)
                 };
             },
         );
@@ -443,7 +443,7 @@ impl DemoApp {
         );
     }
 
-    fn reset(&mut self) {
+    fn reset(&mut self, ui: &mut egui::Ui) {
         let settings_graph = settings::SettingsGraph::default();
         let settings_simulation = settings::SettingsSimulation::default();
 
@@ -464,6 +464,8 @@ impl DemoApp {
         self.sim = sim;
         self.g = g;
         self.force = force;
+
+        DefaultGraphView::clear_cache(ui);
     }
 }
 

examples/layouts/src/main.rs

@@ -36,7 +36,7 @@ impl LayoutsApp {
         }
     }
 
-    fn clear_cache(&mut self, ui: &mut egui::Ui) {
+    fn reset(&mut self, ui: &mut egui::Ui) {
         match self.settings.layout {
             Layout::Hierarchical => {
                 GraphView::<
@@ -48,7 +48,7 @@ impl LayoutsApp {
                     DefaultEdgeShape,
                     LayoutStateHierarchical,
                     LayoutHierarchical,
-                >::clear_cache(ui);
+                >::reset(ui);
             }
             Layout::Random => {
                 GraphView::<
@@ -60,7 +60,7 @@ impl LayoutsApp {
                     DefaultEdgeShape,
                     LayoutStateRandom,
                     LayoutRandom,
-                >::clear_cache(ui);
+                >::reset(ui);
             }
         };
     }
@@ -82,13 +82,13 @@ impl App for LayoutsApp {
                             )
                             .changed()
                         {
-                            self.clear_cache(ui);
+                            self.reset(ui);
                         };
                         if ui
                             .radio_value(&mut self.settings.layout, Layout::Random, "Random")
                             .changed()
                         {
-                            self.clear_cache(ui);
+                            self.reset(ui);
                         };
                     });
                     ui.horizontal(|ui| {
@@ -97,7 +97,7 @@ impl App for LayoutsApp {
                             .add(egui::Slider::new(&mut self.settings.num_nodes, 1..=250))
                             .changed()
                         {
-                            self.clear_cache(ui);
+                            self.reset(ui);
                             self.g = random_graph(self.settings.num_nodes, self.settings.num_edges);
                         };
                     });
@@ -107,7 +107,7 @@ impl App for LayoutsApp {
                             .add(egui::Slider::new(&mut self.settings.num_edges, 1..=250))
                             .changed()
                         {
-                            self.clear_cache(ui);
+                            self.reset(ui);
                             self.g = random_graph(self.settings.num_nodes, self.settings.num_edges);
                         };
                     });

src/elements/node.rs

@@ -23,15 +23,14 @@ where
 
     color: Option<Color32>,
     location: Pos2,
-    location_user: Option<Pos2>,
 }
 
 impl<N> NodeProps<N>
 where
     N: Clone,
 {
     pub fn location(&self) -> Pos2 {
-        self.location_user.unwrap_or(self.location)
+        self.location
     }
 
     pub fn color(&self) -> Option<Color32> {
@@ -103,7 +102,6 @@ where
             payload,
             location: Pos2::default(),
             color: Option::default(),
-            location_user: Option::default(),
             label: String::default(),
             selected: bool::default(),
             dragged: bool::default(),
@@ -166,11 +164,6 @@ where
     }
 
     pub fn set_location(&mut self, loc: Pos2) {
-        self.props.location_user = Some(loc);
-    }
-
-    // TODO: why crate? how to use by external layoyuts?? do we need this func???
-    pub(crate) fn set_layout_location(&mut self, loc: Pos2) {
         self.props.location = loc;
     }
 

src/graph_view.rs

@@ -174,18 +174,19 @@ where
         self
     }
 
-    /// Clears cached values of layout and metadata.
-    pub fn clear_cache(ui: &mut Ui) {
+    /// Helper to reset both [`Metadata`] and [`Layout`] cache. Can be useful when you want to change layout
+    /// in runtime
+    pub fn reset(ui: &mut Ui) {
         GraphView::<N, E, Ty, Ix, Dn, De, S, L>::reset_metadata(ui);
         GraphView::<N, E, Ty, Ix, Dn, De, S, L>::reset_layout(ui);
     }
 
-    /// Resets navigation metadata
+    /// Resets [`Metadata`] state
     pub fn reset_metadata(ui: &mut Ui) {
         Metadata::default().save(ui);
     }
 
-    /// Resets layout state
+    /// Resets [`Layout`] state
     pub fn reset_layout(ui: &mut Ui) {
         ui.data_mut(|data| {
             data.insert_persisted(Id::new(KEY_LAYOUT), S::default());

src/layouts/hierarchical/layout.rs

@@ -89,7 +89,7 @@ where
     let x = start_col * NODE_DIST;
 
     let node = &mut g.g[*root_idx];
-    node.set_layout_location(Pos2::new(x as f32, y as f32));
+    node.set_location(Pos2::new(x as f32, y as f32));
 
     let mut max_col = start_col;
     g.g.neighbors_directed(*root_idx, Outgoing)

src/layouts/random/layout.rs

@@ -38,7 +38,7 @@ impl Layout<State> for Random {
 
         let mut rng = rand::rng();
         for node in g.g.node_weights_mut() {
-            node.set_layout_location(Pos2::new(
+            node.set_location(Pos2::new(
                 rng.random_range(0. ..SPAWN_SIZE),
                 rng.random_range(0. ..SPAWN_SIZE),
             ));