fj-kernel 0.19.0

Early-stage, next-generation, code-first CAD application. Because the world needs another CAD program.
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

use crate::{
    builder::SketchBuilder,
    stores::{Handle, Stores},
};

use super::{face::Faces, Face, Surface};

/// A 2-dimensional shape
///
/// # Implementation Note
///
/// The faces that make up the sketch must be in the same surface. This is not
/// currently validated.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct Sketch {
    faces: Faces,
}

impl Sketch {
    /// Build a `Sketch` using [`SketchBuilder`]
    pub fn builder(stores: &Stores, surface: Handle<Surface>) -> SketchBuilder {
        SketchBuilder { stores, surface }
    }

    /// Construct an empty instance of `Sketch`
    pub fn new() -> Self {
        Self {
            faces: Faces::new(),
        }
    }

    /// Add faces to the sketch
    ///
    /// Consumes the sketch and returns the updated instance.
    pub fn with_faces(
        mut self,
        faces: impl IntoIterator<Item = impl Into<Face>>,
    ) -> Self {
        let faces = faces.into_iter().map(Into::into);
        self.faces.extend(faces);
        self
    }

    /// Access the sketch's faces
    pub fn faces(&self) -> &Faces {
        &self.faces
    }

    /// Convert the sketch into a list of faces
    pub fn into_faces(self) -> Faces {
        self.faces
    }
}

impl Default for Sketch {
    fn default() -> Self {
        Self::new()
    }
}