Struct fj_kernel::objects::Face

pub struct Face { /* private fields */ }

A face of a shape

A Face is a bounded area of a Surface, the Surface itself being an infinite 2-dimensional object in 3D space. Faces are bound by one exterior cycle, which defines the outer boundary, and an arbitrary number of interior cycles (i.e. holes).

Face has a defined orientation, a front and a back side. When faces are combined into Shells, the face orientation defines what is inside and outside of the shell. This stands in contrast to Surface, which has no defined orientation.

You can look at a Face from two directions: front and back. The winding of the exterior cycle will be clockwise or counter-clockwise, depending on your perspective. The front side of the face, is the side where from which the exterior cycle appear counter-clockwise.

Interior cycles must have the opposite winding of the exterior cycle, meaning on the front side of the face, they must appear clockwise. This means that all HalfEdges that bound a Face have the interior of the face on their left side (on the face’s front side).

Implementations

impl Face

pub fn builder(stores: &Stores, surface: Handle<Surface>) -> FaceBuilder<'_>

Build a Face using FaceBuilder

pub fn from_exterior(exterior: Cycle) -> Self

Construct a new instance of Face

Creates the face with no interiors and the default color. This can be overridden using the with_ methods.

pub fn with_interiors(self, interiors: impl IntoIterator<Item = Cycle>) -> Self

Add interior cycles to the face

Consumes the face and returns the updated instance.

Panics

Panics, if the added cycles are not defined in the face’s surface.

Panics, if the winding of the interior cycles is not opposite that of the exterior cycle.

pub fn with_color(self, color: Color) -> Self

Update the color of the face

Consumes the face and returns the updated instance.

pub fn surface(&self) -> &Handle<Surface>

Access this face’s surface

pub fn exterior(&self) -> &Cycle

Access the cycle that bounds the face on the outside

pub fn interiors(&self) -> impl Iterator<Item = &Cycle> + '_

Access the cycles that bound the face on the inside

Each of these cycles defines a hole in the face.

pub fn all_cycles(&self) -> impl Iterator<Item = &Cycle> + '_

Access all cycles of this face

pub fn color(&self) -> Color

Access the color of the face

pub fn coord_handedness(&self) -> Handedness

Determine handed-ness of the face’s front-side coordinate system

A face is defined on a surface, which has a coordinate system. Since surfaces aren’t considered to have an orientation, their coordinate system can be considered to be left-handed or right-handed, depending on which side of the surface you’re looking at.

Faces do have an orientation, meaning they have definite front and back sides. The front side is the side, where the face’s exterior cycle is wound counter-clockwise.

Trait Implementations

impl Approx for &Face

type Approximation = FaceApprox

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 Face

fn clone(&self) -> Face

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Face

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

Formats the value using the given formatter.

impl Extend<Face> for Faces

fn extend<T: IntoIterator<Item = Face>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Hash for Face

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,

Feeds a slice of this type into the given Hasher.

impl<'r> ObjectIters<'r> for Face

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

Return all objects that this one references

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

Iterate over all faces

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 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 HalfEdge>

Iterate over all half-edges

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

Iterate over all shells

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

Iterate over all sketches

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 Vertex>

Iterator over all vertices

impl Ord for Face

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<Face> for Face

fn eq(&self, other: &Face) -> 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<Face> for Face

fn partial_cmp(&self, other: &Face) -> 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 Reverse for Face

fn reverse(self) -> Self

Reverse the direction/orientation of the object

impl Sweep for Face

type Swept = Shell

The object that is created by sweeping the implementing object

fn sweep(self, path: impl Into<Vector<3>>, stores: &Stores) -> Self::Swept

Sweep the object along the given path

impl TransformObject for Face

fn transform(self, transform: &Transform, stores: &Stores) -> Self

Transform the object

fn translate(self, offset: impl Into<Vector<3>>, stores: &Stores) -> Self

Translate the object

fn rotate(self, axis_angle: impl Into<Vector<3>>, stores: &Stores) -> Self

Rotate the object

impl Eq for Face

impl StructuralEq for Face

impl StructuralPartialEq for Face