1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
use crate::Hex;
/// Hexagonal bounds utils, represented as a center and radius.
/// This type can be defined manually or from a [`Hex`] iterator.
///
/// # Example
///
/// ```rust
/// # use hexx::*;
///
/// 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
///
/// ```rust
/// # use hexx::*;
///
/// 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));
/// ```
///
/// [wraparound]: https://www.redblobgames.com/grids/hexagons/#wraparound
#[derive(Debug, Copy, Clone)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "bevy_reflect", derive(bevy_reflect::Reflect))]
pub struct HexBounds {
/// bounds center
pub center: Hex,
/// bounds radius
pub radius: u32,
}
impl HexBounds {
/// Instantiates new bounds from a `center` and `radius`
#[inline]
#[must_use]
pub const fn new(center: Hex, radius: u32) -> Self {
Self { center, radius }
}
/// Instantiates new bounds from a `radius` at [`Hex::ZERO`]
#[inline]
#[must_use]
pub const fn from_radius(radius: u32) -> Self {
Self {
center: Hex::ZERO,
radius,
}
}
/// Computes the bounds `min` and `max`
#[inline]
#[must_use]
pub fn from_min_max(min: Hex, max: Hex) -> Self {
let center = (min + max) / 2;
let radius = center.unsigned_distance_to(max) / 2;
Self { center, radius }
}
#[inline]
#[must_use]
/// Checks if `rhs` is in bounds
pub const fn is_in_bounds(&self, rhs: Hex) -> bool {
self.center.unsigned_distance_to(rhs) <= self.radius
}
#[must_use]
#[inline]
#[doc(alias = "coords_count")]
#[doc(alias = "len")]
/// Returns the number of hexagons in bounds
pub const fn hex_count(&self) -> usize {
Hex::range_count(self.radius) as usize
}
#[doc(alias = "all_items")]
#[must_use]
/// Returns an iterator with all the coordinates in bounds
pub fn all_coords(&self) -> impl ExactSizeIterator<Item = Hex> {
self.center.range(self.radius)
}
/// Computes all coordinates in the intersection between `self` and `rhs`
pub fn intersecting_with(self, rhs: Self) -> impl Iterator<Item = Hex> {
let [start, end] = if self.radius > rhs.radius {
[rhs, self]
} else {
[self, rhs]
};
start.all_coords().filter(move |h| end.is_in_bounds(*h))
}
/// 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
///
/// [article]: https://www.redblobgames.com/grids/hexagons/#wraparound
#[must_use]
pub fn wrap_local(&self, coord: Hex) -> Hex {
let coord = coord - self.center;
coord.wrap_in_range(self.radius)
}
/// 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
///
/// [article]: https://www.redblobgames.com/grids/hexagons/#wraparound
#[must_use]
pub fn wrap(&self, coord: Hex) -> Hex {
self.wrap_local(coord) + self.center
}
}
impl FromIterator<Hex> for HexBounds {
fn from_iter<T: IntoIterator<Item = Hex>>(iter: T) -> Self {
let mut min = Hex::new(i32::MAX, i32::MAX);
let mut max = Hex::new(i32::MIN, i32::MIN);
for hex in iter {
min.x = min.x.min(hex.x);
max.x = max.x.max(hex.x);
min.y = min.y.min(hex.y);
max.y = max.y.max(hex.y);
}
Self::from_min_max(min, max)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn in_bounds_work() {
let bounds = HexBounds::new(Hex::new(-4, 23), 34);
for h in bounds.all_coords() {
assert!(bounds.is_in_bounds(h));
}
}
#[test]
fn intersecting_with() {
let ba = HexBounds::new(Hex::ZERO, 3);
let bb = HexBounds::new(Hex::new(4, 0), 3);
let intersection = ba.intersecting_with(bb);
assert_eq!(intersection.count(), 9);
}
#[test]
fn wrapping_works() {
let map = HexBounds::from_radius(3);
assert_eq!(map.wrap(Hex::new(0, 4)), Hex::new(-3, 0));
assert_eq!(map.wrap(Hex::new(4, 0)), Hex::new(-3, 3));
assert_eq!(map.wrap(Hex::new(4, -4)), Hex::new(0, 3));
}
#[test]
fn wrapping_outside_works() {
let map = HexBounds::from_radius(2);
assert_eq!(map.wrap(Hex::new(3, 0)), Hex::new(-2, 2));
assert_eq!(map.wrap(Hex::new(5, 0)), Hex::new(0, 2));
assert_eq!(map.wrap(Hex::new(6, 0)), Hex::new(-1, -1));
assert_eq!(map.wrap(Hex::new(2, 3)), Hex::new(0, 0)); // mirror
assert_eq!(map.wrap(Hex::new(4, 6)), Hex::new(0, 0));
}
}