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

Update documentation of Approximation

Browse Source
This commit is contained in:
Hanno Braun 2022-03-22 15:31:25 +01:00
parent 3437463070
commit ce6f080424
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
fj-kernel/src/algorithms/approximation.rs
View File

@ -4,7 +4,7 @@ use fj_math::{Point, Scalar, Segment};
use crate::topology::{Cycle, Face, Vertex}; use crate::topology::{Cycle, Face, Vertex};
/// An approximation of an edge, multiple edges, or a face /// The approximation of a face
#[derive(Debug, PartialEq)] #[derive(Debug, PartialEq)]
pub struct Approximation { pub struct Approximation {
/// All points that make up the approximation /// All points that make up the approximation
@ -24,10 +24,10 @@ pub struct Approximation {
} }
impl Approximation { impl Approximation {
/// Compute an approximation for a face /// Compute the approximation of a face
/// ///
/// `tolerance` defines how far the approximation is allowed to deviate from /// `tolerance` defines how far the approximation is allowed to deviate from
/// the actual edges. /// the actual face.
pub fn new(face: &Face, tolerance: Scalar) -> Self { pub fn new(face: &Face, tolerance: Scalar) -> Self {
// Curved faces whose curvature is not fully defined by their edges // Curved faces whose curvature is not fully defined by their edges
// are not supported yet. For that reason, we can fully ignore `face`'s // are not supported yet. For that reason, we can fully ignore `face`'s