Module bracket_pathfinding::prelude
source · [−]Macros
Structs
Line-drawing iterator
An implementation of [Bresenham’s circle algorithm].
[Bresenham’s circle algorithm]: http://members.chello.at/~easyfilter/bresenham.html
Derived from the line_drawing crate, but specialized to use BTerm’s types.
A version of the Bresenham circle that does not make diagonal jumps
New type over
Bresenham which include the end points when iterated over.Convenience type: you can define an angle in Degrees and it is convertible to Radians
(and vice versa)
Representation of a Dijkstra flow map.
map is a vector of floats, having a size equal to size_x * size_y (one per tile).
size_x and size_y are stored for overflow avoidance.
max_depth is the maximum number of iterations this search shall support.
Holds the result of an A-Star navigation query.
destination is the index of the target tile.
success is true if it reached the target, false otherwise.
steps is a vector of each step towards the target, including the starting position.Helper struct defining a 2D point in space.
Helper struct defining a 2D point in space.
Convenience type: you can define an angle in Radians and it is convertible to Degrees
(and vice versa)
Defines a two-dimensional rectangle.
Defines a rectangle with floating-point coordinates.
Since we use
SmallVec, it’s only polite to export it so you don’t have to have multiple copies.
A Vec-like container that can store a small number of elements inline.Define a line using a fast 2D vector. It may not be as pixel-perfect as Bresenham, but with vectorization it is sometimes
faster for a quick line solution.
Enums
Enumeration of available 2D Distance algorithms
Enumeration of available FOV algorithms
Enumeration of available 2D Distance algorithms
Traits
Implement these for handling conversion to/from 2D coordinates (they are separate, because you might
want Dwarf Fortress style 3D!)
Implement these for handling conversion to/from 2D coordinates (they are separate, because you might
want Dwarf Fortress style 3D!)
Implement this trait to support path-finding functions.
Functions
Request an A-Star search. The start and end are specified as index numbers (compatible with your
BaseMap implementation), and it requires access to your map so as to call distance and exit determinations.
Calculates field-of-view for a map that supports Algorithm2D.
Calculates field-of-view for a map that supports Algorithm2D, returning a HashSet. This is a bit faster
than coercing the results into a vector, since internally it uses the set for de-duplication.
Plots a line between two 2D points and returns a vector of points along the line.
Uses a Bresenham’s algorithm to plot a line between two points. On some CPUs, this is faster
than Bresenham.
Uses a 2D vector algorithm to plot a line between two points. On some CPUs, this is faster
than Bresenham.
From a given start point, project forward radius units at an angle of angle_radians degrees.
0 Degrees is north (negative Y), 90 degrees is east (positive X)
Type Definitions
A 2D floating-point position.