bestagon 0.6.0

An engine for discrete stuff in hexagonal grids
Documentation 
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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201

use crate::{division::*, hex::*, neighbours::*, node::Node, node::NodeAx};
#[cfg(feature = "bevy")]
use bevy_ecs::prelude::Component;
#[cfg(feature = "bevy")]
use bevy_reflect::Reflect;
#[cfg(feature = "serde")]
use serde::{Deserialize, Serialize};
use std::{collections::HashSet, hash::Hash};

/// A struct can be considered and Edge if it implements a number of other
/// traits and this traits provides default implementations for some behaviour.
pub trait Edge: Into<EdgeAx> + From<EdgeAx> + Neighbour + Hash + Eq + Copy {
  /// Returns the edge that borders the two given hexes.
  fn between<T>(a: &T, b: &T) -> Self
  where
    T: Hex,
  {
    if a.dist(b) > 1 {
      panic!("Cannot have edge between non-neighbouring hexes.");
    } else {
      let (a_ax, b_ax): (HexAx, HexAx) = ((*a).into(), (*b).into());
      EdgeAx::new(a_ax.q + b_ax.q, a_ax.r + b_ax.r).into()
    }
  }

  /// Returns the hexes of which this edge is the border.
  fn hexes<T>(&self) -> HashSet<T>
  where
    T: Hex,
  {
    let self_ax: EdgeAx = (*self).into();
    let mut result = HashSet::new();
    result.insert(HexAx::new(self_ax.q.my_div_floor(2), self_ax.r.my_div_ceil(2)).into());
    result.insert(HexAx::new(self_ax.q.my_div_ceil(2), self_ax.r.my_div_floor(2)).into());
    result
  }

  /// Returns the nodes at the ends of this edge.
  fn nodes<T>(&self) -> HashSet<T>
  where
    T: Node,
  {
    let self_ax: EdgeAx = (*self).into();

    let mut result = HashSet::new();

    if self_ax.q % 2 == 0 {
      // X doesn't change when passing edge: at top/bottom (in flat orientation)
      result.insert(NodeAx::new((self_ax.q * 3 - 2) / 2, (self_ax.r * 3 + 1) / 2).into());
      result.insert(NodeAx::new((self_ax.q * 3 + 2) / 2, (self_ax.r * 3 - 1) / 2).into());
    } else if self_ax.r % 2 == 0 {
      // Y doesn't change when passing edge: at bottom-left/top-right
      // (in flat orientation)
      result.insert(NodeAx::new((self_ax.q * 3 + 1) / 2, (self_ax.r * 3 - 2) / 2).into());
      result.insert(NodeAx::new((self_ax.q * 3 - 1) / 2, (self_ax.r * 3 + 2) / 2).into());
    } else {
      assert_eq!((-self_ax.q - self_ax.r) % 2, 0);
      // Z doesn't change when passing edge: at top-left/bottom-right
      // (in flat orientation)
      result.insert(NodeAx::new((self_ax.q * 3 - 1) / 2, (self_ax.r * 3 - 1) / 2).into());
      result.insert(NodeAx::new((self_ax.q * 3 + 1) / 2, (self_ax.r * 3 + 1) / 2).into());
    }

    result
  }
}

/// An edge represents the edge between two hex faces. To get the coordinates
/// for an edge, you would want to use the average of the coordinates of the two
/// hexes that touch it. Since we use integers, we cannot use the average so
/// instead just use the sum (in this case the average times 2).
#[derive(Eq, PartialEq, Debug, Copy, Clone, Hash, Default)]
#[cfg_attr(feature = "bevy", derive(Reflect, Component))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct EdgeAx {
  pub q: isize,
  pub r: isize,
}

impl EdgeAx {
  pub fn new(q: isize, r: isize) -> Self {
    EdgeAx { q, r }
  }
}

impl Edge for EdgeAx {}

impl Neighbour for EdgeAx {
  fn get_neighbour(&self, n: u8) -> Option<Self> {
    if self.q % 2 == 0 {
      // X doesn't change when passing edge: at top/bottom (in flat orientation)
      match n {
        0 => Some(EdgeAx::new(self.q - 1, self.r + 1)), // top left
        1 => Some(EdgeAx::new(self.q - 1, self.r)),     // bottom left
        2 => Some(EdgeAx::new(self.q + 1, self.r - 1)), // bottom right
        3 => Some(EdgeAx::new(self.q + 1, self.r)),     // top right
        _ => None,
      }
    } else if self.r % 2 == 0 {
      // Y doesn't change when passing edge: at bottom-left/top-right
      // (in flat orientation)
      match n {
        0 => Some(EdgeAx::new(self.q, self.r - 1)),     // bottom
        1 => Some(EdgeAx::new(self.q + 1, self.r - 1)), // right
        2 => Some(EdgeAx::new(self.q, self.r + 1)),     // top
        3 => Some(EdgeAx::new(self.q - 1, self.r + 1)), // left
        _ => None,
      }
    } else {
      assert_eq!((-self.q - self.r) % 2, 0);
      // Z doesn't change when passing edge: at top-left/bottom-right
      // (in flat orientation)
      match n {
        0 => Some(EdgeAx::new(self.q - 1, self.r)), // left
        1 => Some(EdgeAx::new(self.q, self.r - 1)), // bottom
        2 => Some(EdgeAx::new(self.q + 1, self.r)), // right
        3 => Some(EdgeAx::new(self.q, self.r + 1)), // top
        _ => None,
      }
    }
  }
}

#[derive(PartialEq, Debug, Copy, Clone, Default)]
#[cfg_attr(feature = "bevy", derive(Reflect, Component))]
#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
pub struct FEdgeAx {
  pub q: f32,
  pub r: f32,
}

impl FEdgeAx {
  pub fn new(q: f32, r: f32) -> Self {
    FEdgeAx { q, r }
  }
}

#[cfg(test)]
mod test {
  use std::collections::HashSet;

  use super::*;
  use crate::{hex_range::*, neighbours::Neighbours};

  #[test]
  fn edges_are_reversible_cases() {
    for c in HexRange::sphere(&HexCb::new(0, 0, 0), 5).compute() {
      check_edge_reversibility(c);
    }
  }

  fn check_edge_reversibility(center: HexAx) {
    for n in center.neighbours() {
      let e = EdgeAx::between(&center, &n);
      let hexes: HashSet<HexAx> = e.hexes();
      assert_eq!(hexes.len(), 2);
      assert!(hexes.contains(&center));
      assert!(hexes.contains(&n));
    }
  }

  #[test]
  fn face_has_6_edges() {
    assert_eq!(HexAx::new(0, 0).edges::<EdgeAx>().len(), 6);
  }

  #[test]
  fn sphere_r_1_has_30_edges() {
    assert_eq!(
      HexRange::sphere(&HexAx::new(0, 0), 1)
        .compute::<HexAx>()
        .iter()
        .flat_map(|hf| hf.edges().into_iter())
        .collect::<HashSet<EdgeAx>>()
        .len(),
      30
    );
  }

  #[test]
  fn sphere_r_2_has_72_edges() {
    assert_eq!(
      HexRange::sphere(&HexCb::new(0, 0, 0), 2)
        .compute::<HexAx>()
        .iter()
        .flat_map(|hf| hf.edges().into_iter())
        .collect::<HashSet<EdgeAx>>()
        .len(),
      72
    );
  }

  #[test]
  fn edge_neighbours_touch_4_hexes() {
    let x = HexAx::new(1, 2);
    for e in x.edges::<EdgeAx>() {
      let hs: HashSet<HexAx> = e.neighbours().flat_map(|en| en.hexes()).collect();
      assert_eq!(hs.len(), 4);
    }
  }
}