Enum fj_kernel::topology::Face

pub enum Face {
    Face {
        surface: Handle<Surface>,
        exteriors: Vec<Handle<Cycle>>,
        interiors: Vec<Handle<Cycle>>,
        color: [u8; 4],
    },
    Triangles(Vec<(Triangle<3>, Color)>),
}

A face of a shape

Equality

Please refer to [crate::kernel::topology] for documentation on the equality of topological objects.

Validation

A face that is part of a Shape must be structurally sound. That means the surface and any cycles it refers to, must be part of the same shape.

Variants

Face

Fields

surface: Handle<Surface>

The surface that defines this face

exteriors: Vec<Handle<Cycle>>

The cycles that bound the face on the outside

Implementation Note

Since these cycles bound the face, the edges they consist of must lie in the surface. The data we’re using here is 3-dimensional though, so no such limitation is enforced.

It might be less error-prone to specify the edges in surface coordinates.

interiors: Vec<Handle<Cycle>>

The cycles that bound the face on the inside

Each of these cycles defines a hole in the face.

Implementation note

See note on exterior field.

color: [u8; 4]

The color of the face

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 builder(surface: Surface, shape: &mut Shape) -> FaceBuilder<'_>

Build a face using the [FaceBuilder] API

pub fn surface(&self) -> Surface

Access the surface that the face refers to

This is a convenience method that saves the caller from dealing with the Handle.

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

Access the exterior cycles that the face refers to

This is a convenience method that saves the caller from dealing with the Handles.

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

Access the interior cycles that the face refers to

This is a convenience method that saves the caller from dealing with the Handles.

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

Access all cycles that the face refers to

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

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 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: &Self) -> 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 !=.

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

impl Object for Face

impl StructuralEq for Face