civ_map_generator 0.1.6

A civilization map generator
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

//! Direction enum for hexagonal and square grids.
//!
//! Represents the 8 cardinal and intercardinal directions used in grid navigation.
//!
//! # Direction Layout
//!
//! ```txt
//!         North
//!           ↑
//!     NW ←  |  → NE
//!           |
//! West ←----+----→ East
//!           |
//!     SW ←  |  → SE
//!           ↓
//!         South
//! ```
//!

#[repr(u8)]
#[derive(Eq, PartialEq, Clone, Copy, Debug)]
pub enum Direction {
    North,
    NorthEast,
    East,
    SouthEast,
    South,
    SouthWest,
    West,
    NorthWest,
}

impl Direction {
    /// Returns the opposite direction of the current direction.
    pub const fn opposite(self) -> Self {
        match self {
            Direction::North => Direction::South,
            Direction::NorthEast => Direction::SouthWest,
            Direction::East => Direction::West,
            Direction::SouthEast => Direction::NorthWest,
            Direction::South => Direction::North,
            Direction::SouthWest => Direction::NorthEast,
            Direction::West => Direction::East,
            Direction::NorthWest => Direction::SouthEast,
        }
    }
}