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

Add utils for hexagonal grild #50

Merged
tipragot merged 23 commits from hex-utils into main 2024-02-14 17:49:08 +00:00
Conversation 0 Commits 23 Files changed 4 +24 -22
1 changed files with 24 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files
Showing only changes of commit b6f7a202b4 - Show all commits

46
crates/border-wars/src/hex.rs
View file

@ -16,21 +16,22 @@ pub struct HexPosition {
CoCo_Sol marked this conversation as resolved Outdated
tipragot commented 2024-02-14 11:51:37 +00:00
Outdated
Review
Copy link

I think we should be more generic over the type used. You can use the num crate to do so. And you could still make a specific type using the type keyword.

I think we should be more generic over the type used. You can use the [num](https://crates.io/crates/num) crate to do so. And you could still make a specific type using the `type` keyword.
impl HexPosition {
/// Returns the distance between two [HexPosition]
///
///
/// # How does it work ?
///
/// Hexagonal grid using the [cube](https://www.redblobgames.com/grids/hexagons/#coordinates) coordinate system,
/// is like a cube in 2D space.
/// The Manhattan distance between two positions is equal to: the half of the sum of abs(dx) + abs(dy) + abs(dz)
///
///
/// Hexagonal grid using the [cube](https://www.redblobgames.com/grids/hexagons/#coordinates) coordinate system,
/// is like a cube in 2D space.
/// The Manhattan distance between two positions is equal to: the half of
/// the sum of abs(dx) + abs(dy) + abs(dz)
///
/// # Example:
///
///
/// ```no_run
/// use border_wars::hex::HexPosition;
///
///
/// let a = HexPosition { q: 0, r: 0 };
/// let b = HexPosition { q: 1, r: 1 };
///
///
/// assert_eq!(a.distance_to(&b), 2.0);
/// ```
pub fn distance_to(&self, other: &HexPosition) -> f32 {
@ -43,27 +44,29 @@ impl HexPosition {
// dz = |z1 - z2| and z = -q - r
let ds = self.q + self.r - other.q - other.r;
// Manhattan distance = (abs(dq) + abs(dr) + abs(ds)) / 2
// Manhattan distance = (abs(dq) + abs(dr) + abs(ds)) / 2
(dq.abs() + dr.abs() + ds.abs()) as f32 / 2.
}
/// Returns all positions within a given `range` from the current HexPosition.
/// 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 and inserts HexPositions into a HashSet, ensuring
/// that each generated position is within the given range from the
CoCo_Sol marked this conversation as resolved Outdated
tipragot commented 2024-02-14 16:28:25 +00:00
Outdated
Review
Copy link

dz = -dq - dr

dz = -dq - dr
/// current position.
///
/// This function iterates over the possible q and r values within the specified range
/// and inserts HexPositions into a HashSet, ensuring that each generated position
/// is within the given range from the current position.
///
/// for more details: https://www.redblobgames.com/grids/hexagons/#range
///
///
/// # Example:
///
///
/// ```no_run
/// use border_wars::hex::HexPosition;
///
///
/// let position = HexPosition { q: 0, r: 0 };
///
///
/// let positions = position.range(1);
///
///
/// assert_eq!(positions.len(), 7);
/// ```
pub fn range(&self, range: i32) -> HashSet<HexPosition> {
@ -75,9 +78,8 @@ impl HexPosition {
}
result_positions
}
}
impl ops::Add<HexPosition> for HexPosition {
type Output = HexPosition;