Struct pathfinder::Group

pub struct Group {
    pub nodes: Vec<Node>,
    // some fields omitted
}

Holds a set of nodes and applies properties to all child nodes when drawn. The group itself has no displayed output and is not visible. It contains a Node used for Group meta data.

Fields

nodes: Vec<Node>

Methods

impl Group

pub fn new(name: &str, coordinates: Coordinate) -> Self

Constructs a new Group

pub fn new_node(&mut self)

Adds a Node dynamically to the Group.

pub fn radius(&mut self, radius: u32)

Set the radius for the group's meta-data.

pub fn nodes(&self) -> &Vec<Node>

Retrieves the nodes drawing in the group. Positions are relative to the group.

pub fn set(&mut self) -> &mut Node

Retrieves a mutable group meta data.

pub fn add(&mut self, nr: u32)

Adds a set of nodes randomly located inside the group.

pub fn each(&mut self, func: &dyn Fn(&mut Node))

Applies the closure over each mutable child node.

pub fn color(&mut self, rgba: Rgba<u8>)

Sets the color of the Group.

pub fn node_plot(&mut self, calc: &dyn Fn(usize) -> Coordinate)

Plots node according to the fn provided. The closure parameter is the number of children the group has.

pub fn new_node_min_max(&mut self, min: u32, max: u32)

Adds a Node with a specific minimum and maximum distance from the center of the Group.

pub fn new_simple(x: i16, y: i16) -> Self

Removes all non-essentials from the standard implementation.

pub fn push(&mut self, node: Node)

Pushes a Node to the Group.

pub fn dynamic_radius(&self) -> u32

Returns a dynamic radius based on the number of Nodes in the Group.

pub fn rotate(&mut self, rad: f64)

Rotates all the nodes inside the group.

pub fn gen_color(&self, coordinates: Coordinate) -> Rgba<u8>

Generates an image::Rgba based on the color of the Group and the distance from center.

pub fn from_list(list: &[(i16, i16)]) -> Vec<Self>

Converts a list of tuples (x,y) to a Vector of Groups. Names are assigned from "A" and upwards automatically.

use pathfinder::Group;
let list = [(0, 0), (10, 10), (15, 15)];
let groups = Group::from_list(&list);
assert_eq!(groups.len(), 3);

pub fn link(&mut self, other: &Group)

Links together two groups.

use pathfinder::{Coordinate, Group, Location};
let b: Group = Group::new("B", Coordinate::new(100, 100));
let mut a: Group = Group::new("A", Coordinate::new(0, 0));
a.link(&b);

Trait Implementations

impl Hash for Group

fn hash(&self) -> u64

impl Find for Group

fn find<H: Hash>(&self, hash: H) -> Option<Coordinate>

Recursively calls find as the group contains sets of Nodes.

impl MinMax for Group

fn min_max(&self) -> (Coordinate, Coordinate)

impl Location for Group

fn position(&self) -> Coordinate

Retrieves the position Coordinates.

fn eq<L: Location>(&self, other: &L) -> bool

Returns if the positions are equal or not.

fn x(&self) -> i16

Retrieves the X coordinate.

fn y(&self) -> i16

Retrieves the Y coordinate.

fn sum(&self) -> i16

Returns the sum of the x and y value.

impl Draw for Group

fn draw<S: Shape>(&self, image: IW, offset: Coordinate, shape: &S) -> IW

Draws the Nodes inside that Group. If none the Group is draw as blank.

fn size(&self) -> u32

fn links(&self) -> &[HL]

impl Clone for Group

fn clone(&self) -> Group

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Group> for Node

fn from(group: Group) -> Self

Performs the conversion.

impl From<Coordinate> for Group

fn from(c: Coordinate) -> Self

Performs the conversion.

impl From<Node> for Group

fn from(node: Node) -> Self

Performs the conversion.

impl From<Group> for Coordinate

fn from(group: Group) -> Self

Performs the conversion.

impl Debug for Group

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.