use-tessellation 0.0.6

Tessellation primitives for the RustUse geometry workspace
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

#![forbid(unsafe_code)]
#![doc = include_str!("../README.md")]

/// Broad tessellation families.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum TessellationKind {
    /// Regular tessellation.
    Regular,
    /// Semi-regular tessellation.
    SemiRegular,
    /// Irregular tessellation.
    Irregular,
}

/// A tessellation summary.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Tessellation {
    kind: TessellationKind,
    tile_count: usize,
}

impl Tessellation {
    /// Creates a tessellation with at least one tile.
    #[must_use]
    pub const fn new(kind: TessellationKind, tile_count: usize) -> Option<Self> {
        if tile_count > 0 {
            Some(Self { kind, tile_count })
        } else {
            None
        }
    }

    /// Returns the tessellation kind.
    #[must_use]
    pub const fn kind(self) -> TessellationKind {
        self.kind
    }

    /// Returns the tile count.
    #[must_use]
    pub const fn tile_count(self) -> usize {
        self.tile_count
    }
}

/// A tessellation tile identifier.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TileId(pub usize);

#[cfg(test)]
mod tests {
    use super::{Tessellation, TessellationKind, TileId};

    #[test]
    fn stores_tessellation_counts() {
        let tessellation = Tessellation::new(TessellationKind::Regular, 12).expect("valid");

        assert_eq!(tessellation.kind(), TessellationKind::Regular);
        assert_eq!(tessellation.tile_count(), 12);
        assert_eq!(TileId(3).0, 3);
    }
}