Struct HexagonalMap

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

Vec Based storage for hexagonal maps.

See this article

HexagonalMap is made for hexagonal large dense maps, utilizing some tricks to map Hex coordinate to a positive 2D array.

It can be used only if:

• The map is an hexagon shape
• The map is dense
• No coordinate will be added or removed from the map

If your use case doesn’t match all of the above, use a HashMap instead

Performance agains HashMap

This struct is uses less memory and the larger the map, the faster get operations are agains a hashmap, approximately 10x faster

But for iterating this storage is less performant than a hashmap approximately 3x slower

Implementations

impl<T> HexagonalMap<T>

pub fn new(center: Hex, radius: u32, values: impl FnMut(Hex) -> T) -> Self

Creates and fills a hexagon shaped map

Arguments

• center - The center coordinate of the hexagon
• radius - The radius of the map, around center
• values - Function called for each coordinate in the radius to fill the map

Example

let map = HexagonalMap::new(Hex::ZERO, 10, |coord| coord.length());
assert_eq!(map[hex(1, 0)], 1);

pub const fn bounds(&self) -> &HexBounds

Returns the associated coordinate bounds

pub const fn len(&self) -> usize

Map storage length

pub const fn is_empty(&self) -> bool

Returns true if len is zero

Trait Implementations

impl<T> Clone for HexagonalMap<T>

where T: Clone,

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Debug for HexagonalMap<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for HexagonalMap<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> FromReflect for HexagonalMap<T>

where HexagonalMap<T>: Any + Send + Sync, T: TypePath, Vec<Vec<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HexagonalMapMetadata: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl<T> GetTypeRegistration for HexagonalMap<T>

where HexagonalMap<T>: Any + Send + Sync, T: TypePath, Vec<Vec<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HexagonalMapMetadata: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl<T> HexStore<T> for HexagonalMap<T>

fn get(&self, hex: Hex) -> Option<&T>

Returns a reference the stored value associated with idx. Returns None if idx is out of bounds

fn get_mut(&mut self, hex: Hex) -> Option<&mut T>

Returns a mutable reference the stored value associated with idx. Returns None if idx is out of bounds

fn values<'s>(&'s self) -> impl ExactSizeIterator<Item = &'s T>

where T: 's,

An iterator visiting all values in arbitrary order. The iterator element type is &'s T.

fn values_mut<'s>(&'s mut self) -> impl ExactSizeIterator<Item = &'s mut T>

where T: 's,

An iterator visiting all values mutably in arbitrary order. The iterator element type is &'s mut T.

fn iter<'s>(&'s self) -> impl ExactSizeIterator<Item = (Hex, &'s T)>

where T: 's,

An iterator visiting all key-value pairs in arbitrary order. The iterator element type is (Hex, &'s T).

fn iter_mut<'s>(&'s mut self) -> impl ExactSizeIterator<Item = (Hex, &'s mut T)>

where T: 's,

An iterator visiting all key-value pairs in arbitrary order with mutable references to the values. The iterator element type is (Hex, &'s mut T).

impl<T> Index<&Hex> for HexagonalMap<T>

type Output = T

The returned type after indexing.

fn index(&self, index: &Hex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> Index<Hex> for HexagonalMap<T>

type Output = T

The returned type after indexing.

fn index(&self, index: Hex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<&Hex> for HexagonalMap<T>

fn index_mut(&mut self, index: &Hex) -> &mut Self::Output

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

impl<T> IndexMut<Hex> for HexagonalMap<T>

fn index_mut(&mut self, index: Hex) -> &mut Self::Output

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

impl<T> PartialReflect for HexagonalMap<T>

where HexagonalMap<T>: Any + Send + Sync, T: TypePath, Vec<Vec<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HexagonalMapMetadata: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply(&mut self, value: &dyn PartialReflect) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&dyn Reflect>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut dyn Reflect>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<Self>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

fn reflect_partial_eq(&self, value: &dyn PartialReflect) -> Option<bool>

Returns a “partial equality” comparison result.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn clone_value(&self) -> Box<dyn PartialReflect>

👎Deprecated since 0.16.0: to clone reflected values, prefer using reflect_clone. To convert reflected values to dynamic ones, use to_dynamic.

Clones Self into its dynamic representation.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl<T> Reflect for HexagonalMap<T>

where HexagonalMap<T>: Any + Send + Sync, T: TypePath, Vec<Vec<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HexagonalMapMetadata: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn into_any(self: Box<Self>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<Self>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl<T> Serialize for HexagonalMap<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Struct for HexagonalMap<T>

where HexagonalMap<T>: Any + Send + Sync, T: TypePath, Vec<Vec<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HexagonalMapMetadata: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn field(&self, name: &str) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut(&mut self, name: &str) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&dyn PartialReflect>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut(&mut self, index: usize) -> Option<&mut dyn PartialReflect>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

fn clone_dynamic(&self) -> DynamicStruct

👎Deprecated since 0.16.0: use to_dynamic_struct instead

Clones the struct into a DynamicStruct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl<T> TypePath for HexagonalMap<T>

where HexagonalMap<T>: Any + Send + Sync, T: TypePath,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl<T> Typed for HexagonalMap<T>

where HexagonalMap<T>: Any + Send + Sync, T: TypePath, Vec<Vec<T>>: FromReflect + TypePath + MaybeTyped + RegisterForReflection, HexagonalMapMetadata: FromReflect + TypePath + MaybeTyped + RegisterForReflection,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.