use-face 0.0.6

Face 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

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

/// A face boundary represented by vertex indices.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Face {
    vertices: Vec<usize>,
}

impl Face {
    /// Creates a face with at least three vertex indices.
    #[must_use]
    pub fn new(vertices: Vec<usize>) -> Option<Self> {
        if vertices.len() >= 3 {
            Some(Self { vertices })
        } else {
            None
        }
    }

    /// Returns the vertex indices.
    #[must_use]
    pub fn vertices(&self) -> &[usize] {
        &self.vertices
    }

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

#[cfg(test)]
mod tests {
    use super::Face;

    #[test]
    fn validates_face_boundaries() {
        let face = Face::new(vec![0, 1, 2]).expect("valid face");

        assert_eq!(face.vertices(), &[0, 1, 2]);
        assert_eq!(face.edge_count(), 3);
        assert_eq!(Face::new(vec![0, 1]), None);
    }
}