Enum fj_kernel::objects::Face

pub enum Face {
    Face(FaceBRep),
    Triangles(Vec<(Triangle<3>, Color)>),
}

A face of a shape

Variants

Face(FaceBRep)

A face of a shape

A face is defined by a surface, and is bounded by edges that lie in that surface.

Triangles(Vec<(Triangle<3>, Color)>)

The triangles of the face

Representing faces as a collection of triangles is a temporary state. The plan is to eventually represent faces as a geometric surface, bounded by edges. While the transition is being made, this variant is still required.

Implementations

impl Face

pub fn new(
    surface: Surface,
    exteriors: impl IntoIterator<Item = Cycle>,
    interiors: impl IntoIterator<Item = Cycle>,
    color: [u8; 4]
) -> Self

Construct a new instance of Face

pub fn builder(surface: Surface) -> FaceBuilder

Build a face using the FaceBuilder API

pub fn brep(&self) -> &FaceBRep

Access the boundary representation of the face

pub fn surface(&self) -> Surface

Access this face’s surface

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

Access this face’s exterior cycles

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

Access this face’s interior cycles

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) -> [u8; 4]

Access the color of the face

Trait Implementations

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 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 ObjectIters for Face

fn curve_iter(&self) -> Iter<Curve<3>>

Iterate over all curves

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

Iterate over all cycles

fn edge_iter(&self) -> Iter<Edge>

Iterate over all edges

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

Iterate over all faces

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

Iterate over all global vertices

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

Iterate over all sketches

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

Iterate over all solids

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

Iterate over all surfaces

fn vertex_iter(&self) -> Iter<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

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: &Face) -> bool

This method tests for !=.

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