Struct Simulation

Source

pub struct Simulation<N, E, Ty = Undirected> { /* private fields */ }

Expand description

A simulation for managing the main event loop and forces.

Implementations§

Source §

impl<N, E, Ty: EdgeType> Simulation<N, E, Ty>

Source

pub fn from_graph( graph: ForceGraph<N, E, Ty>, parameters: SimulationParameters<N, E, Ty>, ) -> Self

Create a simulation from a ForceGraph.

Examples found in repository ?

examples/basic.rs (line 14)

3fn main() {
4    // initialize a graph
5    let mut graph: ForceGraph<(), ()> = ForceGraph::default();
6
7    // add nodes to it
8    let one = graph.add_force_node("one", ());
9    let two = graph.add_force_node("two", ());
10    let _three = graph.add_force_node("three", ());
11    graph.add_edge(one, two, ());
12
13    // create a simulation from the graph
14    let mut simulation = Simulation::from_graph(graph, SimulationParameters::default());
15
16    // your event/render loop
17    for frame in 0..50 {
18        // update the nodes positions based on force algorithm
19        simulation.update(0.035);
20
21        // render (print) your nodes new locations.
22        println!("---- frame {frame} ----");
23        for node in simulation.get_graph().node_weights() {
24            println!("\"{}\" - {:?}", node.name, node.location);
25        }
26    }
27}

Source

pub fn reset_node_placement(&mut self)

Randomly place the nodes within the starting square. In practice, this restarts the simulation.

Source

pub fn update(&mut self, dt: f32)

Update the graph’s node’s positions for a given interval.

Examples found in repository ?

examples/basic.rs (line 19)

3fn main() {
4    // initialize a graph
5    let mut graph: ForceGraph<(), ()> = ForceGraph::default();
6
7    // add nodes to it
8    let one = graph.add_force_node("one", ());
9    let two = graph.add_force_node("two", ());
10    let _three = graph.add_force_node("three", ());
11    graph.add_edge(one, two, ());
12
13    // create a simulation from the graph
14    let mut simulation = Simulation::from_graph(graph, SimulationParameters::default());
15
16    // your event/render loop
17    for frame in 0..50 {
18        // update the nodes positions based on force algorithm
19        simulation.update(0.035);
20
21        // render (print) your nodes new locations.
22        println!("---- frame {frame} ----");
23        for node in simulation.get_graph().node_weights() {
24            println!("\"{}\" - {:?}", node.name, node.location);
25        }
26    }
27}

Source

pub fn update_custom(&mut self, force: &Force<N, E, Ty>, dt: f32)

Update the graph’s node’s positions for a given interval with a custom Force.

Source

pub fn visit_nodes(&self, cb: &mut impl Fn(&Node<N>))

Run a callback on all the nodes.

Source

pub fn visit_edges(&self, cb: &mut impl Fn(&Node<N>, &Node<N>))

Run a callback on all of the edges.

Source

pub fn get_graph(&self) -> &ForceGraph<N, E, Ty>

Retrieve a reference to the internal ForceGraph.

Examples found in repository ?

examples/basic.rs (line 23)

3fn main() {
4    // initialize a graph
5    let mut graph: ForceGraph<(), ()> = ForceGraph::default();
6
7    // add nodes to it
8    let one = graph.add_force_node("one", ());
9    let two = graph.add_force_node("two", ());
10    let _three = graph.add_force_node("three", ());
11    graph.add_edge(one, two, ());
12
13    // create a simulation from the graph
14    let mut simulation = Simulation::from_graph(graph, SimulationParameters::default());
15
16    // your event/render loop
17    for frame in 0..50 {
18        // update the nodes positions based on force algorithm
19        simulation.update(0.035);
20
21        // render (print) your nodes new locations.
22        println!("---- frame {frame} ----");
23        for node in simulation.get_graph().node_weights() {
24            println!("\"{}\" - {:?}", node.name, node.location);
25        }
26    }
27}