Struct ForceGraph 

pub struct ForceGraph<UserNodeData = (), UserEdgeData = ()> {
    pub parameters: SimulationParameters,
    /* private fields */
}

The main force graph structure.

Fields

parameters: SimulationParameters

Implementations

impl<UserNodeData, UserEdgeData> ForceGraph<UserNodeData, UserEdgeData>

pub fn new(parameters: SimulationParameters) -> Self

Constructs a new force graph.

Use the following syntax to create a graph with default parameters:

use force_graph::ForceGraph;
let graph = <ForceGraph>::new(Default::default());

pub fn get_graph( &self, ) -> &StableUnGraph<Node<UserNodeData>, EdgeData<UserEdgeData>>

Provides access to the raw graph structure if required.

pub fn add_node(&mut self, node_data: NodeData<UserNodeData>) -> DefaultNodeIdx

Adds a new node and returns an index that can be used to reference the node.

pub fn remove_node(&mut self, idx: DefaultNodeIdx)

Removes a node by index.

pub fn add_edge( &mut self, n1_idx: DefaultNodeIdx, n2_idx: DefaultNodeIdx, edge: EdgeData<UserEdgeData>, )

Adds or updates an edge connecting two nodes by index.

pub fn clear(&mut self)

Removes all nodes from the force graph.

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

Applies the next step of the force graph simulation.

The number of seconds that have elapsed since the previous update must be calculated and provided by the user as dt.

pub fn visit_nodes<F: FnMut(&Node<UserNodeData>)>(&self, cb: F)

Processes each node with a user-defined callback cb.

pub fn visit_nodes_mut<F: FnMut(&mut Node<UserNodeData>)>(&mut self, cb: F)

Mutates each node with a user-defined callback cb.

pub fn visit_edges<F: FnMut(&Node<UserNodeData>, &Node<UserNodeData>, &EdgeData<UserEdgeData>)>( &self, cb: F, )

Processes each edge and its associated nodes with a user-defined callback cb.