rei-mirrors/Fornjot
1
0
Fork 0
mirror of https://github.com/hannobraun/Fornjot synced 2025-05-05 18:38:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document expected order add_joined_edges

Browse Source
This commit is contained in:
Hanno Braun 2024-08-12 20:37:40 +02:00
parent 5bb617f87d
commit 379cd35a89
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
crates/fj-core/src/operations/join/cycle.rs
View File

@ -22,9 +22,13 @@ pub trait JoinCycle {
/// joins the new half-edge to the provided one, and adds the new half-edge
/// to the cycle.
///
/// The geometry for each new half-edge needs to be provided as well.
/// Expects the provided half-edges to be in an unnatural order:
///
/// Also requires the surface that the cycle is defined in.
/// - This is the opposite order that they would appear in, in a cycle.
/// - Meaning each half-edge ends where the _previous_ one starts.
///
/// The geometry for each new half-edge needs to be provided as well. Also
/// requires the surface that the cycle is defined in.
#[must_use]
fn add_joined_edges<Es>(
&self,