fj-kernel 0.19.0

Early-stage, next-generation, code-first CAD application. Because the world needs another CAD program.
Documentation
use crate::{builder::ShellBuilder, stores::Stores};

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

/// A 3-dimensional closed shell
///
/// # Implementation Note
///
/// The faces that make up a shell should be closed ("watertight"). This is not
/// currently validated.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct Shell {
    faces: Faces,
}

impl Shell {
    /// Build a `Shell` using [`ShellBuilder`]
    pub fn builder(stores: &Stores) -> ShellBuilder {
        ShellBuilder { stores }
    }

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

    /// Add faces to the shell
    ///
    /// Consumes the shell 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 shell's faces
    pub fn faces(&self) -> &Faces {
        &self.faces
    }

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

    /// Find the given face in this shell
    pub fn find_face(&self, face: &Face) -> Option<Face> {
        self.faces().find(face)
    }
}

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