Struct fdg_sim::force::Force

pub struct Force<N, E, Ty = Undirected> {
    pub dict: LinkedHashMap<String, Value>,
    pub dict_default: LinkedHashMap<String, Value>,
    pub name: &'static str,
    pub continuous: bool,
    pub info: Option<&'static str>,
    pub update: fn(dict: &LinkedHashMap<String, Value>, graph: &mut ForceGraph<N, E, Ty>, dt: f32),
}

A struct that defines how your force behaves.

Fields

dict: LinkedHashMap<String, Value>

Current dictionary

dict_default: LinkedHashMap<String, Value>

Default dictionary

name: &'static str

Name of the force

continuous: bool

Whether or not the force should be run on each frame.

info: Option<&'static str>

A short description of the force.

update: fn(dict: &LinkedHashMap<String, Value>, graph: &mut ForceGraph<N, E, Ty>, dt: f32)

Force callback function.

Implementations

impl<N, E, Ty> Force<N, E, Ty>

pub fn name(&self) -> &'static str

Retrieve the name of the force.

pub fn info(&self) -> Option<&'static str>

Retrieve the force’s information.

pub fn update(&self, graph: &mut ForceGraph<N, E, Ty>, dt: f32)

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

Examples found in repository

src/simulation.rs (line 128)

    pub fn update(&mut self, dt: f32) {
        self.parameters.force().update(&mut self.graph, dt);
    }

    /// Update the graph's node's positions for a given interval with a custom [`Force`].
    pub fn update_custom(&mut self, force: &Force<N, E, Ty>, dt: f32) {
        force.update(&mut self.graph, dt)
    }

pub fn dict_mut(&mut self) -> &mut LinkedHashMap<String, Value>

Retrieve a mutable reference to the force’s internal dictionary.

pub fn dict(&self) -> &LinkedHashMap<String, Value>

Retrieve a reference to the force’s internal dictionary.

pub fn reset(&mut self)

Reset the force’s internal dictionary.

pub fn continuous(&self) -> bool

Retrieve if the force is continuous. Continuous forces run their update on every frame, non-continuous forces run their update every time the user clicks a “Run” button.

Trait Implementations

impl<N: Clone, E: Clone, Ty: Clone> Clone for Force<N, E, Ty>

fn clone(&self) -> Force<N, E, Ty>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<N, E, Ty> PartialEq<Force<N, E, Ty>> for Force<N, E, Ty>

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.