Struct beehive::HexMap

pub struct HexMap<T, I = i16> { /* fields omitted */ }

A generic QuadPrism-shaped dense container indexed by hex coordinates.

This type is only available with the collections feature.

Methods

impl<T, I: Subscript> HexMap<T, I>

pub fn create(area: QuadPrism<I>, value: T) -> Self where
    T: Clone, 

Creates from a default value for all hexes. T must be Clone.

Panics

If area has a negative volume.

pub fn create_with_axial<F>(area: QuadPrism<I>, initializer: F) -> Self where
    F: FnMut(PointAxial<I>) -> T, 

Creates with an initializer function that takes axial points.

Panics

If area has a negative volume.

pub fn create_with<F>(area: QuadPrism<I>, initializer: F) -> Self where
    F: FnMut(Point<I>) -> T, 

Creates with an initializer function that takes cube points.

Panics

If area has a negative volume.

pub fn create_from_axial<U, F>(base: HexMap<U, I>, op: F) -> Self where
    F: FnMut(PointAxial<I>, U) -> T, 

Creates from an existing HexMap

pub fn create_from<U, F>(base: HexMap<U, I>, op: F) -> Self where
    F: FnMut(Point<I>, U) -> T, 

Creates from an existing HexMap

pub fn create_from_ref_axial<U, F>(base: &HexMap<U, I>, op: F) -> Self where
    F: FnMut(PointAxial<I>, &U) -> T, 

Creates from reference of an existing HexMap

pub fn create_from_ref<U, F>(base: &HexMap<U, I>, op: F) -> Self where
    F: FnMut(Point<I>, &U) -> T, 

Creates from reference of an existing HexMap

pub fn from_raw(area: QuadPrism<I>, data: Vec<T>) -> Self

Creates from a raw data Vec.

Panics

If the sizes of area and data mismatch.

pub fn try_from_raw(
    area: QuadPrism<I>,
    data: Vec<T>
) -> Result<Self, RawSizeMismatch>

Creates from a raw data Vec.

Errors

If the sizes of area and data mismatch.

pub fn area(&self) -> &QuadPrism<I>

Returns the QuadPrism that this HexMap covers.

pub fn get_axial(&self, point: PointAxial<I>) -> Option<&T>

Returns a reference to a value, or None if the point is out of bounds.

pub fn get(&self, point: Point<I>) -> Option<&T>

Returns a reference to a value, or None if the point is out of bounds.

pub fn get_mut_axial(&mut self, point: PointAxial<I>) -> Option<&mut T>

Returns a mutable reference to a value, or None if the point is out of bounds.

pub fn get_mut(&mut self, point: Point<I>) -> Option<&mut T>

Returns a mutable reference to a value, or None if the point is out of bounds.

pub fn iter_axial(&self) -> IterAxial<T, I>

Returns an iterator that yields axial coordinates and references to corresponding values.

pub fn iter(&self) -> Iter<T, I>

Returns an iterator that yields cube coordinates and references to corresponding values.

pub fn iter_mut_axial(&mut self) -> IterMutAxial<T, I>

Returns an iterator that yields axial coordinates and mutable references to corresponding values.

pub fn iter_mut(&mut self) -> IterMut<T, I>

Returns an iterator that yields cube coordinates and mutable references to corresponding values.

Trait Implementations

impl<T: Clone, I: Clone> Clone for HexMap<T, I>

fn clone(&self) -> HexMap<T, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug, I: Debug> Debug for HexMap<T, I>

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

Formats the value using the given formatter.

impl<T> Default for HexMap<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Eq, I: Eq> Eq for HexMap<T, I>

impl<T, I: Subscript> Index<Point<I>> for HexMap<T, I>

type Output = T

The returned type after indexing.

fn index(&self, point: Point<I>) -> &T

Performs the indexing (container[index]) operation.

impl<T, I: Subscript> Index<PointAxial<I>> for HexMap<T, I>

type Output = T

The returned type after indexing.

fn index(&self, point: PointAxial<I>) -> &T

Performs the indexing (container[index]) operation.

impl<T, I: Subscript> IndexMut<Point<I>> for HexMap<T, I>

fn index_mut(&mut self, point: Point<I>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T, I: Subscript> IndexMut<PointAxial<I>> for HexMap<T, I>

fn index_mut(&mut self, point: PointAxial<I>) -> &mut T

Performs the mutable indexing (container[index]) operation.

impl<T: PartialEq, I: PartialEq> PartialEq<HexMap<T, I>> for HexMap<T, I>

fn eq(&self, other: &HexMap<T, I>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &HexMap<T, I>) -> bool

This method tests for !=.

impl<T, I> StructuralEq for HexMap<T, I>

impl<T, I> StructuralPartialEq for HexMap<T, I>