hexx 0.24.0

Hexagonal utilities
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

use std::ops::Neg;

use crate::{Hex, VertexDirection};

use super::GridEdge;

/// Hexagonal grid orientated vertex representation.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[cfg_attr(not(target_arch = "spirv"), derive(Hash))]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[cfg_attr(feature = "facet", derive(facet::Facet))]
#[cfg_attr(feature = "bevy_reflect", derive(bevy_reflect::Reflect))]
pub struct GridVertex {
    /// The coordinate of the edge
    pub origin: Hex,
    /// The direction the vertex points towards
    pub direction: VertexDirection,
}

impl GridVertex {
    /// Checks if `self` and `rhs` are the same vertex, meaning either identical
    /// or shared between adjacent coordinates
    #[must_use]
    pub fn equivalent(&self, other: &Self) -> bool {
        let [cw, ccw] = [
            Self {
                origin: self.origin + self.direction.direction_cw(),
                direction: self.direction.rotate_ccw(2),
            },
            Self {
                origin: self.origin + self.direction.direction_ccw(),
                direction: self.direction.rotate_cw(2),
            },
        ];
        // identical
        (self.origin == other.origin && self.direction == other.direction)
            || (cw.origin == other.origin && cw.direction == other.direction)
            || (ccw.origin == other.origin && ccw.direction == other.direction)
    }

    #[inline]
    #[must_use]
    /// Returns the three connected coordinates in clockwise order
    pub const fn coordinates(&self) -> [Hex; 3] {
        [
            self.origin,
            self.origin.add_dir(self.direction.edge_ccw()),
            self.origin.add_dir(self.direction.edge_cw()),
        ]
    }
    #[inline]
    #[must_use]
    /// Returns the two destination coordinates in clockwise order
    pub const fn destinations(&self) -> [Hex; 2] {
        [
            self.origin.add_dir(self.direction.edge_ccw()),
            self.origin.add_dir(self.direction.edge_cw()),
        ]
    }

    #[inline]
    #[must_use]
    /// Return the two adjacent edges sharing the same coordinate origin.
    /// The edges are returned in clockwise order
    pub const fn side_edges(&self) -> [GridEdge; 2] {
        [
            GridEdge {
                origin: self.origin,
                direction: self.direction.edge_ccw(),
            },
            GridEdge {
                origin: self.origin,
                direction: self.direction.edge_cw(),
            },
        ]
    }

    #[inline]
    #[must_use]
    /// Inverts the vertex, now facing the opposite direction
    pub const fn const_neg(self) -> Self {
        Self {
            direction: self.direction.const_neg(),
            ..self
        }
    }

    #[inline]
    #[must_use]
    /// Returns the next vertex in clockwise order
    pub const fn clockwise(self) -> Self {
        Self {
            direction: self.direction.clockwise(),
            ..self
        }
    }

    #[inline]
    #[must_use]
    /// Returns the next vertex in counter clockwise order
    pub const fn counter_clockwise(self) -> Self {
        Self {
            direction: self.direction.counter_clockwise(),
            ..self
        }
    }

    #[inline]
    #[must_use]
    /// Rotates `self` clockwise by `offset` amount.
    pub const fn rotate_cw(self, offset: u8) -> Self {
        Self {
            direction: self.direction.rotate_cw(offset),
            ..self
        }
    }
    #[inline]
    #[must_use]
    /// Rotates `self` counter clockwise by `offset` amount.
    pub const fn rotate_ccw(self, offset: u8) -> Self {
        Self {
            direction: self.direction.rotate_ccw(offset),
            ..self
        }
    }
}

impl Hex {
    /// Returns all vertices of the given coordinate
    #[inline]
    #[must_use]
    pub fn all_vertices(self) -> [GridVertex; 6] {
        VertexDirection::ALL_DIRECTIONS.map(|direction| GridVertex {
            origin: self,
            direction,
        })
    }
}

impl Neg for GridVertex {
    type Output = Self;

    #[inline]
    fn neg(self) -> Self::Output {
        self.const_neg()
    }
}

impl From<VertexDirection> for GridVertex {
    fn from(direction: VertexDirection) -> Self {
        Self {
            origin: Hex::ZERO,
            direction,
        }
    }
}