Struct fyrox::utils::astar::PathFinder

pub struct PathFinder { /* private fields */ }

See module docs.

Implementations

impl PathFinder

pub fn new() -> Self

Creates new empty path finder.

pub fn set_vertices(&mut self, vertices: Vec<PathVertex>)

Sets active set of vertices. Links between vertices must contain valid indices (which are not out-of-bounds), otherwise path from/to such vertices won’t be built.

pub fn get_closest_vertex_to(&self, point: Vector3<f32>) -> Option<usize>

Tries to find a vertex closest to given point.

Notes

O(n) complexity.

pub fn link_bidirect(&mut self, a: usize, b: usize)

Creates bidirectional link between two vertices. Bidirectional means that point a can be reached from point b as well as point b can be reached from point a.

pub fn link_unidirect(&mut self, a: usize, b: usize)

Creates unidirectional link between vertex a and vertex b. Unidirectional means that there is no direct link between b to a, only from a to b.

pub fn vertex(&self, index: usize) -> Option<&PathVertex>

Returns shared reference to a path vertex at the given index.

pub fn vertex_mut(&mut self, index: usize) -> Option<&mut PathVertex>

Returns mutable reference to a path vertex at the given index.

pub fn vertices(&self) -> &[PathVertex]

Returns reference to the array of vertices.

pub fn vertices_mut(&mut self) -> &mut [PathVertex]

Returns reference to the array of vertices.

pub fn add_vertex(&mut self, vertex: PathVertex) -> u32

Adds a new vertex to the path finder.

pub fn pop_vertex(&mut self) -> Option<PathVertex>

Removes last vertex from the graph. Automatically cleans “dangling” references to the deleted vertex from every other vertex in the graph and shifts indices of neighbour vertices, to preserve graph structure.

pub fn remove_vertex(&mut self, index: usize) -> PathVertex

Removes a vertex at the given index from the graph. Automatically cleans “dangling” references to the deleted vertex from every other vertex in the graph and shifts indices of neighbour vertices, to preserve graph structure.

pub fn insert_vertex(&mut self, index: u32, vertex: PathVertex)

Inserts the vertex at the given index. Automatically shifts neighbour indices of every other vertex in the graph to preserve graph structure.

pub fn build( &mut self, from: usize, to: usize, path: &mut Vec<Vector3<f32>> ) -> Result<PathKind, PathError>

Tries to build path from begin point to end point. Returns path kind:

• Full: there are direct path from begin to end.
• Partial: there are not direct path from begin to end, but it is closest.
• Empty: no path available - in most cases indicates some error in input params.

Notes

This is more or less naive implementation, it most certainly will be slower than specialized solutions.

pub fn build_and_convert<F, T>( &mut self, from: usize, to: usize, path: &mut Vec<T>, func: F ) -> Result<PathKind, PathError>where F: FnMut(usize, &PathVertex) -> T,

Tries to build path from begin point to end point. Returns path kind:

• Full: there are direct path from begin to end.
• Partial: there are not direct path from begin to end, but it is closest.
• Empty: no path available - in most cases indicates some error in input params.

Notes

This is more or less naive implementation, it most certainly will be slower than specialized solutions.

Trait Implementations

impl Clone for PathFinder

fn clone(&self) -> PathFinder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PathFinder

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

Formats the value using the given formatter.

impl Default for PathFinder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PathFinder

fn eq(&self, other: &PathFinder) -> 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.

impl Visit for PathFinderwhere Vec<PathVertex>: Visit,

fn visit(&mut self, name: &str, visitor: &mut Visitor) -> VisitResult

impl StructuralPartialEq for PathFinder