Struct soft_edge::Face

pub struct Face { /* fields omitted */ }

A Face represents a combination of four triangles around a central vertex:

— |\2/| |3*1| |/0|

Where a * is a vertex and anything else is empty space. These four triangles make up the bulk of how we mesh two atoms together: combining two atoms’ adjacent faces is as simple as XORing the bits of their faces together. We immediately zero out any shared triangles.

A Face will only be non-empty if its corresponding atom has more than two vertices on its plane; its bits represent strictly filled spaces, not lines. a Face which does not actually have any triangles on its surface will not contain any set bits.

Faces are constructed in a right-handed coordinate system according to the axis of the face of the atom from which they were constructed; this means that for example, if we’re looking at the +X axis of an atom, then to the “right” ([FACE_POS_X]) will be -Z (atom vertices with unset [Z_AXIS] bits.)

Parallel faces share the same layout with respect to their other axes. For example, a face on the -Z axis will have all of its vertices parallel w/ a face on the Z axis; the vertices are stored in the same order.

Implementations

impl Face

pub fn new(vertices: VertexSet, axis: Axis) -> Self

Calculate an initial Face object from a vertex set and an axis corresponding to the face we want to construct on.

pub fn empty(axis: Axis) -> Self

Construct an empty face on a given axis.

Atoms can’t be empty, so this is useful if you need to just conjure an empty face out of nowhere.

pub fn axis(self) -> Axis

The axis which this face was constructed for.

pub fn join(&mut self, other: &mut Self)

Join two opposing faces. This mutually removes any triangles which are shared between the faces. Panicks if called on faces which are not made from opposing axes (where opposing axes are pairs like PosX vs NegX, etc.)

pub fn facets(self) -> impl Iterator<Item = HullFacet>

Iterate over the exactly one or two facets of this 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 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 Copy for Face

impl Eq for Face

impl StructuralEq for Face

impl StructuralPartialEq for Face