use-mesh 0.0.6

Mesh 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
63
64
65
66
67
68

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

/// A mesh vertex index.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct MeshVertexIndex(pub usize);

/// A mesh face index.
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct MeshFaceIndex(pub usize);

/// A lightweight mesh count summary.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Mesh {
    vertex_count: usize,
    edge_count: usize,
    face_count: usize,
}

impl Mesh {
    /// Creates a mesh summary with positive counts.
    #[must_use]
    pub const fn new(vertex_count: usize, edge_count: usize, face_count: usize) -> Option<Self> {
        if vertex_count > 0 && edge_count > 0 && face_count > 0 {
            Some(Self {
                vertex_count,
                edge_count,
                face_count,
            })
        } else {
            None
        }
    }

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

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

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

#[cfg(test)]
mod tests {
    use super::{Mesh, MeshFaceIndex, MeshVertexIndex};

    #[test]
    fn stores_mesh_counts_and_indices() {
        let mesh = Mesh::new(8, 12, 6).expect("valid mesh");

        assert_eq!(mesh.vertex_count(), 8);
        assert_eq!(mesh.edge_count(), 12);
        assert_eq!(mesh.face_count(), 6);
        assert_eq!(MeshVertexIndex(1).0, 1);
        assert_eq!(MeshFaceIndex(2).0, 2);
    }
}