Crates.io docs.rs

egui_graphs

Graph visualization with rust, petgraph and egui in its DNA.

Screenshot 2023-04-28 at 23 14 38

Features

ezgif-4-3e4e4469e6

dynamic_demo


Basic setup example

Step 1: Setting up the BasicApp struct.

First, let's define the BasicApp struct that will hold the graph. rust pub struct BasicApp { g: StableGraph<Node<()>, Edge<()>>, }

Step 2: Implementing the new() function.

Next, implement the new() function for the BasicApp struct. rust impl BasicApp { fn new(_: &CreationContext<'_>) -> Self { let g = generate_graph(); Self { g } } }

Step 3: Generating the graph.

Create a helper function called generate_graph(). In this example, we create three nodes with and three edges connecting them in a triangular pattern. ```rust fn generate_graph() -> StableGraph

let a = g.add_node(Node::new(egui::Vec2::new(0., SIDE_SIZE), ()));
let b = g.add_node(Node::new(egui::Vec2::new(-SIDE_SIZE, 0.), ()));
let c = g.add_node(Node::new(egui::Vec2::new(SIDE_SIZE, 0.), ()));

g.add_edge(a, b, Edge::new(()));
g.add_edge(b, c, Edge::new(()));
g.add_edge(c, a, Edge::new(()));

g

} ```

Step 4: Implementing the update() function.

Now, lets implement the update() function for the BasicApp. This function creates a GraphView widget providing a mutable reference to the graph, and adds it to egui::CentralPanel using the ui.add() function for adding widgets. rust impl App for BasicApp { fn update(&mut self, ctx: &Context, _: &mut eframe::Frame) { egui::CentralPanel::default().show(ctx, |ui| { ui.add(&mut GraphView::new(&mut self.g)); }); } }

Step 5: Running the application.

Finally, run the application using the run_native() function with the specified native options and the BasicApp. rust fn main() { let native_options = eframe::NativeOptions::default(); run_native( "egui_graphs_basic_demo", native_options, Box::new(|cc| Box::new(BasicApp::new(cc))), ) .unwrap(); }

Screenshot 2023-04-24 at 22 04 49

You can further customize the appearance and behavior of your graph by modifying the settings or adding more nodes and edges as needed. Don't forget to apply changes returned from the widget.

Interactive

You can check more advanced interactive example for usage references, settings description and changes apply demonstration.