fish-cannard/border-wars
fish-cannard/border-wars
5
3
Fork 0
generated from tipragot/rust
Code Issues 10 Pull requests 3 Actions Packages Projects Releases Wiki Activity

Remake utils for hexagon grids #55

Merged
CoCo_Sol merged 10 commits from remake-utile into main 2024-02-16 21:17:15 +00:00
Conversation 0 Commits 10 Files changed 3 -155
1 changed files with 0 additions and 155 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit 8d7010c0c8 - Show all commits

155
crates/border-wars/src/map/hex_save.rs
View file

@ -1,155 +0,0 @@
//! All functions related to calculations in a hexagonal grid.
use std::collections::HashSet;
use std::hash::Hash;
use std::ops::{Add, AddAssign, Sub, SubAssign};
use num::cast::AsPrimitive;
use num::{FromPrimitive, Signed};
use partial_min_max::{max, min};
/// Represents a number that can be used in a hexagonal grid.
pub trait HexNumber: Signed + PartialEq + Copy + PartialOrd + FromPrimitive {}
impl<T: Signed + PartialEq + Copy + PartialOrd + FromPrimitive> HexNumber for T {}
/// Represents a position in a hexagonal grid.
/// We use the axial coordinate system explained in this
/// [documentation](https://www.redblobgames.com/grids/hexagons/#coordinates).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct HexPosition<T: HexNumber> {
/// Q coordinate.
pub q: T,
/// R coordinate.
pub r: T,
}
impl<T: HexNumber + AsPrimitive<f32>> HexPosition<T> {
/// Returns the distance between two [HexPosition]s.
///
/// # How it works
///
/// In the hexagonal grid, using the
/// [cube coordinate system](https://www.redblobgames.com/grids/hexagons/#coordinates),
/// it's akin to a cube in 3D space.
/// The Manhattan distance between two positions is equal to half of
/// the sum of abs(dx) + abs(dy) + abs(dz).
/// However, in hexagonal grids, z is defined as -q - r.
///
/// # Example
///
/// ```no_run
/// use border_wars::map::hex::HexPosition;
///
/// let a = HexPosition { q: 0, r: 0 };
/// let b = HexPosition { q: 1, r: 1 };
///
/// assert_eq!(a.distance_to(&b), 2);
/// ```
pub fn distance_to(&self, other: &Self) -> T {
// Calculate the difference between the q and r coordinates.
let dq = (self.q - other.q).abs();
let dr = (self.r - other.r).abs();
let ds = dq + dr;
// Manhattan distance = (abs(dq) + abs(dr) + abs(ds)) / 2
(dq + dr + ds) / (T::one() + T::one())
}
/// Converts the current [HexPosition] into a pixel coordinate.
/// Input: The size of the hexagon in pixels (witdh, height).
///
/// If you want to learn more about pixel coordinates conversion,
/// you can check the
/// [documentation](https://www.redblobgames.com/grids/hexagons/#hex-to-pixel).
///
/// # Example
///
/// ```no_run
/// use border_wars::map::hex::HexPosition;
///
/// let position = HexPosition { q: 1, r: 0 };
/// assert_eq!(
/// position.to_pixel_coordinates((1.0, 1.0)),
/// (3f32.sqrt(), 0.0)
/// );
/// ```
pub fn to_pixel_coordinates(&self, size: (f32, f32)) -> (f32, f32) {
(
size.0
* 3f32
.sqrt()
.mul_add(self.q.as_(), 3f32.sqrt() / 2.0 * (self.r.as_())),
size.1 * (3.0 / 2.0 * self.r.as_()),
)
}
}
impl<T: HexNumber + Eq + Hash + std::cmp::PartialOrd + num::ToPrimitive> HexPosition<T> {
/// Returns all positions within a given `range` from the current
/// `HexPosition`.
///
/// This function iterates over the possible q and r values within the
/// specified range.
/// Note that the original position is also returned.
///
/// For more details, refer to: https://www.redblobgames.com/grids/hexagons/#range
///
/// # Example
///
/// ```
/// use border_wars::map::hex::HexPosition;
///
/// let position = HexPosition { q: 0, r: 0 };
///
/// let positions = position.range(1);
///
/// assert_eq!(positions.len(), 7);
/// ```
pub fn range(&self, range: T) -> HashSet<Self> {
let mut result_positions = HashSet::new();
for q in num::range_inclusive(-range, range) {
for r in num::range_inclusive(max(-range, -q - range), min(range, -q + range)) {
result_positions.insert(Self { q, r });
}
}
result_positions
}
}
impl<T: HexNumber> Add<Self> for HexPosition<T> {
type Output = Self;
fn add(self, other: Self) -> Self::Output {
Self {
q: self.q + other.q,
r: self.r + other.r,
}
}
}
impl<T: HexNumber + AddAssign> AddAssign<Self> for HexPosition<T> {
fn add_assign(&mut self, other: Self) {
self.q += other.q;
self.r += other.r;
}
}
impl<T: HexNumber> Sub<Self> for HexPosition<T> {
type Output = Self;
fn sub(self, other: Self) -> Self {
Self {
q: self.q - other.q,
r: self.r - other.r,
}
}
}
impl<T: HexNumber + SubAssign> SubAssign<Self> for HexPosition<T> {
fn sub_assign(&mut self, other: Self) {
self.q -= other.q;
self.r -= other.r;
}
}