Struct HexBounds 

pub struct HexBounds {
    pub center: Hex,
    pub radius: u32,
}

Hexagonal bounds utils, represented as a center and radius. This type can be defined manually or from a Hex iterator.

Example

let iter = Hex::ZERO.line_to(Hex::new(123, -456));
// You can compute the bounds of `iter`
let bounds: HexBounds = iter.collect();

Bounds have wraparound features, useful for seamless or repeating maps.

Example

let bounds = HexBounds::new(hex(1, 2), 10);
// Define a coordinate, even ouside of bounds
let point = Hex::new(100, 100);
assert!(!bounds.is_in_bounds(point));
// Retrieve the wrapped position in the map
let wrapped_point = bounds.wrap(point);
assert!(bounds.is_in_bounds(wrapped_point));

Fields

center: Hex

bounds center

radius: u32

bounds radius

Implementations

impl HexBounds

pub const fn new(center: Hex, radius: u32) -> Self

Instantiates new bounds from a center and radius

pub const fn from_radius(radius: u32) -> Self

Instantiates new bounds from a radius at Hex::ZERO

pub fn from_min_max(min: Hex, max: Hex) -> Self

Computes the bounds min and max

pub const fn positive_radius(radius: u32) -> Self

Computes the bounds for radius with all coordinates being positive.

This can be used for efficient map storage in a 2D vector disallowing negative coordinates

pub const fn is_in_bounds(&self, rhs: Hex) -> bool

Checks if rhs is in bounds

pub const fn hex_count(&self) -> usize

Returns the number of hexagons in bounds

pub fn all_coords(self) -> impl ExactSizeIterator<Item = Hex>

Returns an iterator with all the coordinates in bounds

pub fn intersecting_with(self, rhs: Self) -> impl Iterator<Item = Hex>

Computes all coordinates in the intersection between self and rhs

pub fn wrap_local(&self, coord: Hex) -> Hex

Wraps coord, returning a new local coodinate inside of the bounds, relative to the center.

This allows for seamless wraparound hexagonal maps. See this article for more information.

See also Self::wrap for global wrapping

pub fn wrap(&self, coord: Hex) -> Hex

Wraps coord, returning a new coodinate inside of the bounds.

This allows for seamless wraparound hexagonal maps. See this article for more information.

See also Self::wrap_local for local wrapping

pub fn corners(&self) -> [Hex; 6]

Returns the 6 corners of the hex bounds in EdgeDirection order

Trait Implementations

impl Clone for HexBounds

fn clone(&self) -> HexBounds

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HexBounds

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HexBounds

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<Hex> for HexBounds

fn from_iter<T: IntoIterator<Item = Hex>>(iter: T) -> Self

Creates a value from an iterator.

impl FromReflect for HexBounds

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 GetTypeRegistration for HexBounds

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 PartialEq for HexBounds

fn eq(&self, other: &HexBounds) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialReflect for HexBounds

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 to_dynamic(&self) -> Box<dyn PartialReflect>

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

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

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 Reflect for HexBounds

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 Serialize for HexBounds

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Struct for HexBounds

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

Creates a new DynamicStruct from this struct.

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

Will return None if TypeInfo is not available.

impl TypePath for HexBounds

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 Typed for HexBounds

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for HexBounds

impl Eq for HexBounds

impl StructuralPartialEq for HexBounds