Struct fj_kernel::objects::Face

pub struct Face { /* private fields */ }

A face of a shape

Implementations

impl Face

pub fn build(surface: Surface) -> FaceBuilder

Build a face using FaceBuilder

pub fn new(surface: Surface) -> Self

Construct a new instance of Face

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

pub fn from_triangles(triangles: Vec<(Triangle<3>, Color)>) -> Self

Construct an instance that uses triangle representation

Triangle representation is obsolete, and only still present because there is one last place in the kernel code that uses it. Don’t add any more of those places!

See this issue for more context: https://github.com/hannobraun/Fornjot/issues/97

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

Add exterior 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.

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.

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) -> &Surface

Access this face’s surface

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

Access the cycles that bound 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

This is equivalent to chaining the iterators returned by Face::exteriors and Face::interiors.

pub fn color(&self) -> Color

Access the color of the face

pub fn triangles(&self) -> Option<&Vec<(Triangle<3>, Color)>>

Access triangles, if this face uses triangle representation

Only some faces still use triangle representation. At some point, none will. This method exists as a workaround, while the transition is still in progress.

Trait Implementations

impl Approx for Face

type Approximation = FaceApprox

The approximation of the object

fn approx(&self, tolerance: 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 From<FacePolygon> for Face

fn from(polygon: FacePolygon) -> Self

Converts to this type from the input type.

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 edge_iter(&'r self) -> Iter<&'r Edge>

Iterate over all edges

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

Iterate over all global curves

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

Iterate over all global vertices

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) -> Self where
    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 Sweep for Face

type Swept = Shell

The object that is created by sweeping the implementing object

fn sweep(
    self,
    path: impl Into<Path>,
    tolerance: impl Into<Tolerance>,
    color: Color
) -> Self::Swept

Sweep the object along the given path

impl TransformObject for Face

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

Transform the object

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

Translate the object

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

Rotate the object

impl Eq for Face

impl StructuralEq for Face

impl StructuralPartialEq for Face