Struct fj_kernel::topology::Edge

pub struct Edge {
    pub curve: Handle<Curve>,
    pub vertices: Option<[Handle<Vertex>; 2]>,
}

An edge of a shape

Equality

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

Validation

An edge that is part of a Shape must be structurally sound. That means the curve and any vertices that it refers to, must be part of the same shape.

Fields

curve: Handle<Curve>

Access the curve that defines the edge’s geometry

The edge can be a segment of the curve that is bounded by two vertices, or if the curve is continuous (i.e. connects to itself), the edge could be defined by the whole curve, and have no bounding vertices.

vertices: Option<[Handle<Vertex>; 2]>

Access the vertices that bound the edge on the curve

If there are no such vertices, that means that both the curve and the edge are continuous (i.e. connected to themselves).

Implementation note

Since these vertices bound the edge, they must lie on the curve. This isn’t enforced at all, however. It would make sense to store 1D vertices here, and indeed, this was the case in the past.

It got in the way of some work, however, so it made sense to simplify it by storing 3D vertices. It will probably make sense to revert this and store 1D vertices again, at some point.

Implementations

impl Edge

pub fn builder(shape: &mut Shape) -> EdgeBuilder<'_>

Build an edge using the EdgeBuilder API

pub fn curve(&self) -> Curve

Access the curve that the edge refers to

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

pub fn vertices(&self) -> Option<[Vertex; 2]>

Access the vertices that the edge refers to

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

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Edge

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

Formats the value using the given formatter.

impl Hash for Edge

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 Edge

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

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

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

impl Object for Edge

impl StructuralEq for Edge