rei-mirrors/Fornjot
1
0
Fork 0
mirror of https://github.com/hannobraun/Fornjot synced 2025-01-30 11:55:57 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation of GlobalEdge

Browse Source
This commit is contained in:
Hanno Braun 2023-02-22 13:23:03 +01:00
parent fd641dcd81
commit c00ac2eab8
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
crates/fj-kernel/src/objects/full/edge.rs
View File

@ -105,12 +105,15 @@ impl fmt::Display for HalfEdge {
}
}
/// An edge, defined in global (3D) coordinates
/// An undirected edge, defined in global (3D) coordinates
///
/// In contrast to [`HalfEdge`], `GlobalEdge` is undirected, meaning it has no
/// defined direction, and its vertices have no defined order. This means it can
/// be used to determine whether two [`HalfEdge`]s map to the same `GlobalEdge`,
/// regardless of their direction.
///
/// See [`HalfEdge`]'s documentation for more information on the relationship
/// between [`HalfEdge`] and `GlobalEdge`.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub struct GlobalEdge {
curve: HandleWrapper<GlobalCurve>,