Update documentation of Approximation

This commit is contained in:
Hanno Braun 2022-03-22 15:31:25 +01:00
parent 3437463070
commit ce6f080424

View File

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