Struct hexagon_map::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: AxialPoint, 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 path_finder( &self, start: &AxialPoint, end: &AxialPoint ) -> 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.count_points(), 10)

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

impl<T> HexagonMap<T>

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

Get the value at a point, if it exists.

pub fn add_point(&mut self, point: AxialPoint, 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: AxialPoint) -> Option<&mut T>

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

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

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

pub fn count_points(&self) -> usize

Count all defined points in the map.

pub fn nearby_points(&self, from: &AxialPoint) -> Vec<AxialPoint>

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

pub fn around_points( &self, from: &AxialPoint, distance: usize ) -> Vec<AxialPoint>

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

pub fn points(&self) -> impl Iterator<Item = &AxialPoint>

Trait Implementations

impl<'i, T> IntoIterator for &'i HexagonMap<T>

type Item = (&'i AxialPoint, &'i T)

The type of the elements being iterated over.

type IntoIter = Iter<'i, AxialPoint, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.