Struct HexagonMap 

pub struct HexagonMap<T> { /* private fields */ }

A sparse hexagon map, if your map size will grow, or most areas will be blank, this is a better choice.

Implementations

impl<T> HexagonMap<T>

pub fn action_field( &self, start: CubicPoint, action: f64, ) -> ActionFieldSolver<'_, T>

Set the passable function.

Arguments

• passable: A function that returns true if the point is passable.

returns: PathFinder

Examples

impl<T> HexagonMap<T>

pub fn points_all(&self) -> GetHexagonPoints<'_, T>

pub fn points_mut(&mut self) -> MutGetHexagonPoints<'_, T>

impl<T> HexagonMap<T>

pub fn points_count(&self) -> usize

Count all defined points in the map.

pub fn points_nearby(&self, source: CubicPoint) -> Vec<CubicPoint>

Find at most 6 points that are exists and adjacent to given point.

pub fn joints_nearby(&self, source: CubicPoint) -> Vec<Joint>

Find at most 6 joints that are exists and adjacent to given point.

pub fn points_around( &self, source: CubicPoint, steps: usize, ) -> GetHexagonAround<'_, T>

Find all points that are within a certain distance of a point.

impl<T> HexagonMap<T>

pub fn path_finder( &self, start: CubicPoint, end: CubicPoint, ) -> PathFinder<'_, T>

Set the passable function.

Arguments

• passable: A function that returns true if the point is passable.

returns: PathFinder

Examples

impl<T: Default> HexagonMap<T>

pub fn circle(diameter: usize) -> Self

pub fn rhombus(width: usize, height: usize) -> Self

pub fn width_first(rows: usize, columns: usize, odd_left: bool) -> Self

Create a width first hexagon map.

Arguments

• width: row count
• height: column count
• odd_left: Fill the extra line at left if width is odd.

returns: HexagonMap

Examples

let map = HexagonMap::<u8>::width_first(5, 5, true);
assert_eq!(map.points_count(), 25)

pub fn height_first(rows: usize, columns: usize, odd_up: bool) -> Self

impl<T> HexagonMap<T>

pub fn get_point(&self, point: CubicPoint) -> Option<&T>

Get the value at a point, if it exists.

pub fn add_point(&mut self, point: CubicPoint, value: T) -> Option<T>

Add a point to the map, if it already exists, return the old value.

pub fn mut_point(&mut self, point: CubicPoint) -> Option<&mut T>

Get a mutable reference to a point, if it exists.

pub fn remove_point(&mut self, point: CubicPoint) -> Option<T>

Remove a point from the map, if it exists, return the old value.