Struct fj_kernel::objects::Sketch

pub struct Sketch { /* private fields */ }

A 2-dimensional shape

Implementation Note

The faces that make up the sketch must be in the same surface. This is not currently validated.

Implementations

impl Sketch

pub fn new(faces: impl IntoIterator<Item = Handle<Face>>) -> Self

Construct an empty instance of Sketch

Examples found in repository

src/partial/objects/sketch.rs (line 29)

    fn build(self, objects: &mut Service<Objects>) -> Self::Full {
        let faces = self.faces.into_iter().map(|face| face.build(objects));
        Sketch::new(faces)
    }

src/algorithms/transform/sketch.rs (line 22)

    fn transform_with_cache(
        self,
        transform: &Transform,
        objects: &mut Service<Objects>,
        cache: &mut TransformCache,
    ) -> Self {
        let faces =
            self.faces().into_iter().cloned().map(|face| {
                face.transform_with_cache(transform, objects, cache)
            });

        Self::new(faces)
    }

pub fn faces(&self) -> &FaceSet

Access the faces of the sketch

Examples found in repository

src/algorithms/approx/sketch.rs (line 18)

    fn approx_with_cache(
        self,
        tolerance: impl Into<Tolerance>,
        cache: &mut Self::Cache,
    ) -> Self::Approximation {
        self.faces().approx_with_cache(tolerance, cache)
    }

src/iter.rs (line 241)

    fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters> {
        let mut objects = Vec::new();

        for face in self.faces() {
            objects.push(face as &dyn ObjectIters);
        }

        objects
    }

src/partial/objects/sketch.rs (line 20)

    fn from_full(sketch: &Self::Full, cache: &mut FullToPartialCache) -> Self {
        Self {
            faces: sketch
                .faces()
                .into_iter()
                .map(|face| Partial::from_full(face.clone(), cache))
                .collect(),
        }
    }

src/algorithms/transform/sketch.rs (line 18)

    fn transform_with_cache(
        self,
        transform: &Transform,
        objects: &mut Service<Objects>,
        cache: &mut TransformCache,
    ) -> Self {
        let faces =
            self.faces().into_iter().cloned().map(|face| {
                face.transform_with_cache(transform, objects, cache)
            });

        Self::new(faces)
    }

src/algorithms/sweep/sketch.rs (line 25)

    fn sweep_with_cache(
        self,
        path: impl Into<Vector<3>>,
        cache: &mut SweepCache,
        objects: &mut Service<Objects>,
    ) -> Self::Swept {
        let path = path.into();

        let mut shells = Vec::new();
        for face in self.faces().clone() {
            let shell = face.sweep_with_cache(path, cache, objects);
            shells.push(shell);
        }

        let shells = shells.into_iter().map(Partial::from).collect();
        PartialSolid { shells }.build(objects).insert(objects)
    }

Trait Implementations

impl Approx for &Sketch

type Approximation = BTreeSet<FaceApprox, Global>

The approximation of the object

type Cache = CurveCache

The cache used to cache approximation results

fn approx_with_cache(
    self,
    tolerance: impl Into<Tolerance>,
    cache: &mut Self::Cache
) -> Self::Approximation

Approximate the object, using the provided cache

fn approx(self, tolerance: impl Into<Tolerance>) -> Self::Approximation

Approximate the object

impl Clone for Sketch

fn clone(&self) -> Sketch

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Sketch

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<Sketch> for Object<Bare>

fn from(object: Sketch) -> Self

Converts to this type from the input type.

impl HasPartial for Sketch

type Partial = PartialSketch

The type representing the partial variant of this object

impl Hash for Sketch

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Insert for Sketch

fn insert(self, objects: &mut Service<Objects>) -> Handle<Self>

Insert the object into its respective store

impl<'r> ObjectIters<'r> for Sketch

fn referenced_objects(&'r self) -> Vec<&'r dyn ObjectIters<'_>>

Return all objects that this one references

fn sketch_iter(&'r self) -> Iter<&'r Sketch>

Iterate over all sketches

fn curve_iter(&'r self) -> Iter<&'r Curve>

Iterate over all curves

fn cycle_iter(&'r self) -> Iter<&'r Cycle>

Iterate over all cycles

fn face_iter(&'r self) -> Iter<&'r Face>

Iterate over all faces

fn global_curve_iter(&'r self) -> Iter<&'r Handle<GlobalCurve>>

Iterate over all global curves

fn global_vertex_iter(&'r self) -> Iter<&'r GlobalVertex>

Iterate over all global vertices

fn half_edge_iter(&'r self) -> Iter<&'r Handle<HalfEdge>>

Iterate over all half-edges

fn shell_iter(&'r self) -> Iter<&'r Shell>

Iterate over all shells

fn solid_iter(&'r self) -> Iter<&'r Solid>

Iterate over all solids

fn surface_iter(&'r self) -> Iter<&'r Surface>

Iterate over all surfaces

fn vertex_iter(&'r self) -> Iter<&'r Handle<Vertex>>

Iterator over all vertices

impl Ord for Sketch

fn cmp(&self, other: &Sketch) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Sketch> for Sketch

fn eq(&self, other: &Sketch) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<Sketch> for Sketch

fn partial_cmp(&self, other: &Sketch) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl TransformObject for Sketch

fn transform_with_cache(
    self,
    transform: &Transform,
    objects: &mut Service<Objects>,
    cache: &mut TransformCache
) -> Self

Transform the object using the provided cache

fn transform(self, transform: &Transform, objects: &mut Service<Objects>) -> Self

Transform the object

fn translate(
    self,
    offset: impl Into<Vector<3>>,
    objects: &mut Service<Objects>
) -> Self

Translate the object

fn rotate(
    self,
    axis_angle: impl Into<Vector<3>>,
    objects: &mut Service<Objects>
) -> Self

Rotate the object

impl Validate for Sketch

type Error = Infallible

The error that validation of the implementing type can result in

fn validate_with_config(&self, _: &ValidationConfig) -> Result<(), Self::Error>

Validate the object

fn validate(&self) -> Result<(), Self::Error>

Validate the object using default configuration

impl Eq for Sketch

impl StructuralEq for Sketch

impl StructuralPartialEq for Sketch