Struct PathNetwork 

pub struct PathNetwork<N>
where
    N: PathNetworkNodeTrait,
{ /* private fields */ }

Path network. This struct is used to manage nodes and paths between nodes in 2D space.

This struct provides:

• functions to add, remove, and search nodes and paths.
• functions to search nodes around a site or a line segment.

Implementations

impl<N> PathNetwork<N>

where N: PathNetworkNodeTrait,

pub fn new() -> Self

Create a new path network.

pub fn nodes_iter(&self) -> impl Iterator<Item = (NodeId, &N)>

Get nodes in the network.

pub fn neighbors_iter( &self, node_id: NodeId, ) -> Option<impl Iterator<Item = (NodeId, &N)>>

Get neighbors of a node.

pub fn get_node(&self, node_id: NodeId) -> Option<&N>

Get a node by its NodeId.

pub fn has_path(&self, start: NodeId, to: NodeId) -> bool

Check if there is a path between two nodes.

pub fn nodes_around_site_iter( &self, site: Site, radius: f64, ) -> impl Iterator<Item = &NodeId>

Search nodes around a site within a radius.

pub fn nodes_around_line_iter( &self, line: LineSegment, radius: f64, ) -> impl Iterator<Item = &NodeId>

Search nodes around a line segment within a radius.

pub fn paths_touching_rect_iter( &self, corner_0: Site, corner_1: Site, ) -> impl Iterator<Item = &(NodeId, NodeId)>

Search paths touching a rectangle.

pub fn into_optimized(self) -> Self

Get the optimized path network.

Trait Implementations

impl<N> Clone for PathNetwork<N>

where N: PathNetworkNodeTrait + Clone,

fn clone(&self) -> PathNetwork<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for PathNetwork<N>

where N: PathNetworkNodeTrait + Debug,

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

Formats the value using the given formatter.

impl<N> Default for PathNetwork<N>

where N: PathNetworkNodeTrait,

fn default() -> Self

Returns the “default value” for a type.