HalfEdge

Struct HalfEdge 

Source
pub struct HalfEdge { /* private fields */ }
Expand description

A directed edge, defined in a surface’s 2D space

The concept of an “edge” in Fornjot is represented by two structs, HalfEdge and GlobalEdge. HalfEdge has two attributes that make it distinct from GlobalEdge:

  • HalfEdge is directed, meaning it has a defined start and end vertex.
  • HalfEdge is defined in the 2-dimensional space of a surface.

When multiple faces, which are bound by edges, are combined to form a solid, the HalfEdges that bound the face on the surface are then coincident with the HalfEdges of other faces, where those faces touch. Those coincident HalfEdges are different representations of the same edge. This edge is represented by an instance of GlobalEdge.

There are some requirements that a HalfEdge needs to uphold to be valid:

  1. Coincident HalfEdges must refer to the same GlobalEdge.
  2. HalfEdges that are coincident, i.e. located in the same space, must always be congruent. This means they must coincide exactly. The overlap must be complete. None of the coincident HalfEdges must overlap with just a section of another.

That second requirement means that a HalfEdge might need to be split into multiple smaller HalfEdges that are each coincident with a HalfEdge in another face.

§Implementation Note

There is no validation code that verifies whether coincident HalfEdges refer to the same GlobalEdge or not: https://github.com/hannobraun/Fornjot/issues/1594

Conversely, there is no validation code to verify that coincident HalfEdges are congruent: https://github.com/hannobraun/Fornjot/issues/1608

Implementations§

Source§

impl HalfEdge

Source

pub fn new( curve: Curve, boundary: [Point<1>; 2], start_vertex: Handle<Vertex>, global_form: Handle<GlobalEdge>, ) -> Self

Create an instance of HalfEdge

Source

pub fn curve(&self) -> Curve

Access the curve that defines the half-edge’s geometry

Source

pub fn boundary(&self) -> [Point<1>; 2]

Access the boundary points of the half-edge on the curve

Source

pub fn start_position(&self) -> Point<2>

Compute the surface position where the half-edge starts

Source

pub fn start_vertex(&self) -> &Handle<Vertex>

Access the vertex from where this half-edge starts

Source

pub fn global_form(&self) -> &Handle<GlobalEdge>

Access the global form of the half-edge

Trait Implementations§

Source§

impl BuildHalfEdge for HalfEdge

Source§

fn unjoined( curve: Curve, boundary: [Point<1>; 2], services: &mut Services, ) -> HalfEdge

Create a half-edge that is not joined to another
Source§

fn arc( start: impl Into<Point<2>>, end: impl Into<Point<2>>, angle_rad: impl Into<Scalar>, services: &mut Services, ) -> HalfEdge

Create an arc Read more
Source§

fn circle(radius: impl Into<Scalar>, services: &mut Services) -> HalfEdge

Create a circle
Source§

fn line_segment( points_surface: [impl Into<Point<2>>; 2], boundary: Option<[Point<1>; 2]>, services: &mut Services, ) -> HalfEdge

Create a line segment
Source§

fn line_segment_from_global_points( points_global: [impl Into<Point<3>>; 2], surface: &Surface, boundary: Option<[Point<1>; 2]>, services: &mut Services, ) -> HalfEdge

Create a line segment from global points
Source§

impl Clone for HalfEdge

Source§

fn clone(&self) -> HalfEdge

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HalfEdge

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<HalfEdge> for Object<Bare>

Source§

fn from(object: HalfEdge) -> Self

Converts to this type from the input type.
Source§

impl Hash for HalfEdge

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Insert for HalfEdge

Source§

type Inserted = Handle<HalfEdge>

The type of Self, once it has been inserted Read more
Source§

fn insert(self, services: &mut Services) -> Self::Inserted

Insert the object into its respective store
Source§

impl Ord for HalfEdge

Source§

fn cmp(&self, other: &HalfEdge) -> Ordering

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

fn max(self, other: Self) -> Self
where Self: Sized,

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

fn min(self, other: Self) -> Self
where Self: Sized,

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

fn clamp(self, min: Self, max: Self) -> Self
where Self: Sized,

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for HalfEdge

Source§

fn eq(&self, other: &HalfEdge) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for HalfEdge

Source§

fn partial_cmp(&self, other: &HalfEdge) -> Option<Ordering>

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl TransformObject for HalfEdge

Source§

fn transform_with_cache( self, transform: &Transform, services: &mut Services, cache: &mut TransformCache, ) -> Self

Transform the object using the provided cache
Source§

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

Transform the object
Source§

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

Translate the object Read more
Source§

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

Rotate the object Read more
Source§

impl UpdateHalfEdge for HalfEdge

Source§

fn replace_start_vertex(&self, start_vertex: Handle<Vertex>) -> HalfEdge

Update the start vertex of the half-edge
Source§

fn replace_global_form(&self, global_form: Handle<GlobalEdge>) -> HalfEdge

Update the global form of the half-edge
Source§

impl Validate for HalfEdge

Source§

fn validate_with_config( &self, config: &ValidationConfig, errors: &mut Vec<ValidationError>, )

Validate the object
Source§

fn validate_and_return_first_error(&self) -> Result<(), ValidationError>

Validate the object using default config and return on first error
Source§

fn validate(&self, errors: &mut Vec<ValidationError>)

Validate the object using default configuration
Source§

impl Eq for HalfEdge

Source§

impl StructuralPartialEq for HalfEdge

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,