Struct fj_core::objects::HalfEdge

pub struct HalfEdge { /* private fields */ }

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

Structure

A HalfEdge is defined by the Curve it is on, its boundary on the curve, and the Vertex instances that bound it on the curve. To keep the data structures simple (by avoiding redundancy), each HalfEdge only refers to its start vertex. The vertex where it ends is referred to by the next HalfEdge in the Cycle that the HalfEdge is a part of.

Validity

A valid HalfEdge must have a non-zero length, meaning its bounding vertices must not be coincident.

In a valid Shell, HalfEdges form coincident pairs, where the faces of the shell touch. The other HalfEdge in such a pair is called the sibling.

A HalfEdge and its sibling are equal but opposite. Specifically this means that both refer to the same curve; that the sibling has the same, but inverted, boundary; and that both are bound by the same vertices, though their start vertices are different.

Implementations

impl HalfEdge

pub fn new( path: SurfacePath, boundary: impl Into<CurveBoundary<Point<1>>>, curve: Handle<Curve>, start_vertex: Handle<Vertex> ) -> Self

Create an instance of Edge

pub fn path(&self) -> SurfacePath

Access the curve that defines the edge’s geometry

pub fn boundary(&self) -> CurveBoundary<Point<1>>

Access the boundary points of the edge on the curve

pub fn curve(&self) -> &Handle<Curve>

Access the curve of the edge

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

Access the vertex from where this edge starts

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

Compute the surface position where the edge starts

Trait Implementations

impl BoundingVolume<2> for HalfEdge

fn aabb(&self) -> Option<Aabb<2>>

Compute an axis-aligned bounding box (AABB)

impl BuildHalfEdge for HalfEdge

fn unjoined( path: SurfacePath, boundary: impl Into<CurveBoundary<Point<1>>>, services: &mut Services ) -> HalfEdge

Create a half-edge that is not joined to a sibling

fn from_sibling(sibling: &HalfEdge, start_vertex: Handle<Vertex>) -> HalfEdge

Create a half-edge from its sibling

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

Create an arc

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

Create a circle

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

Create a line segment

impl Clone for HalfEdge

fn clone(&self) -> HalfEdge

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HalfEdge

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

Formats the value using the given formatter.

impl From<HalfEdge> for Object<Bare>

fn from(object: HalfEdge) -> Self

Converts to this type from the input type.

impl Hash for HalfEdge

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Insert for HalfEdge

type Inserted = Handle<HalfEdge>

The type of Self, once it has been inserted

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

Insert the object into its respective store

impl Ord for HalfEdge

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for HalfEdge

fn eq(&self, other: &HalfEdge) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for HalfEdge

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

type BareObject = HalfEdge

The bare object type that this trait is implemented for

fn replace_curve( &self, original: &Handle<Curve>, replacement: Handle<Curve>, _: &mut Services ) -> ReplaceOutput<Self, Self::BareObject>

Replace the curve

impl ReplaceVertex for HalfEdge

type BareObject = HalfEdge

The bare object type that this trait is implemented for

fn replace_vertex( &self, original: &Handle<Vertex>, replacement: Handle<Vertex>, _: &mut Services ) -> ReplaceOutput<Self, Self::BareObject>

Replace the vertex

impl ReverseCurveCoordinateSystems for HalfEdge

fn reverse_curve_coordinate_systems(&self, _: &mut Services) -> Self

Reverse the direction of the curve coordinate systems within an object

impl SplitHalfEdge for HalfEdge

fn split_half_edge( &self, point: impl Into<Point<1>>, services: &mut Services ) -> [HalfEdge; 2]

Split the half-edge into two

impl SweepHalfEdge for HalfEdge

fn sweep_half_edge( &self, end_vertex: Handle<Vertex>, surface: &Surface, color: Option<Color>, path: impl Into<Vector<3>>, cache: &mut SweepCache, services: &mut Services ) -> (Face, Handle<HalfEdge>)

Sweep the HalfEdge

impl TransformObject for HalfEdge

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

Transform the object using the provided cache

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

Transform the object

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

Translate the object

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

Rotate the object

impl UpdateHalfEdge for HalfEdge

fn update_path(&self, update: impl FnOnce(SurfacePath) -> SurfacePath) -> Self

Update the path of the edge

fn update_boundary( &self, update: impl FnOnce(CurveBoundary<Point<1>>) -> CurveBoundary<Point<1>> ) -> Self

Update the boundary of the edge

fn update_curve( &self, update: impl FnOnce(&Handle<Curve>) -> Handle<Curve> ) -> Self

Update the curve of the edge

fn update_start_vertex( &self, update: impl FnOnce(&Handle<Vertex>) -> Handle<Vertex> ) -> Self

Update the start vertex of the edge

impl Validate for HalfEdge

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

Validate the object

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

Validate the object using default config and return on first error

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

Validate the object using default configuration

impl Eq for HalfEdge

impl StructuralEq for HalfEdge

impl StructuralPartialEq for HalfEdge