Struct pathfinder::Map

pub struct Map { /* fields omitted */ }

High abstraction Map which helps position objects.

Methods

impl Map

pub fn new() -> Self

Creates a new map, no min_max are intially required and are generated automatically when calling Map::map.

pub fn save(self, path: &Path) -> Result<(), Error>

Saves the image to disk. Can be absolute or relative path.

Examples

let nodes = Node::from_list(&[(0, 0), (10, 10)]);
Map::new()
    .map(&nodes)
    .save(Path::new("/tmp/example.png"))
    .unwrap();

pub fn consume(self) -> IW

Unwraps the image wrapper

pub fn map<T: Draw + Location + Hash + MinMax>(self, element: &[T]) -> Self

Maps any struct that has implemented Draw, on to an ImageBuffer.

Examples

let nodes: Vec<Node> = vec![
    Node::new("1", Coordinate::new(0, 0)),
    Node::new("2", Coordinate::new(100, 100)),
];
// Add content to vectors.
let mut map = Map::new();
map = map.map(&nodes);

pub fn map_filter<T: Draw + Location + Hash + MinMax>(     self,     element: &[T],     filter: &dyn Fn(&T) -> bool ) -> Self

Maps the elements but with an added filter parameter to exclude elements.

pub fn map_shape<T: Draw + Location + Hash + MinMax, S: Shape>(     self,     element: &[T],     shape: &S ) -> Self

Maps the elements with a specified shape struct.

pub fn map_absolute<T: Draw + Location + Hash + MinMax>(     self,     element: &[T] ) -> Self

Maps the elements without stabalizing the positions on the canvas.

pub fn map_params<T: Draw + Location + Hash + MinMax, S: Shape>(     self,     element: &[T],     filter: &dyn Fn(&T) -> bool,     shape: &S ) -> Self

Maps the elements but with all added parameters.

Trait Implementations

impl Clone for Map

fn clone(&self) -> Map

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Map

fn default() -> Map

Returns the "default value" for a type.

impl Debug for Map

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

Formats the value using the given formatter.