blitz-path 0.2.0

Implementations of the A* and JPS pathfinding algorithms.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32

use std::convert::From;

use movingai::Coords2D;

///Describes a route between two points.
///Giving the total distance needed to travel and a vector of each step needed.
pub struct Route {
    distance: f64,
    steps: Vec<Coords2D>,
}

impl From<(f64, Vec<Coords2D>)> for Route {
    fn from(item: (f64, Vec<Coords2D>)) -> Self {
        Route {
            distance: item.0,
            steps: item.1,
        }
    }
}

impl Route {
    ///Returns a vector of Coords2D, each representing a step in the path.
    ///Organised in reverse order (destination is at [0]) to allow calling .pop() to get each step.
    pub fn steps(&self) -> Vec<Coords2D> {
        self.steps.clone()
    }

    ///Returns the total distance needed to travel as an f64.
    pub fn distance(&self) -> f64 {
        self.distance
    }
}