rei-mirrors/Fornjot
1
0
Fork 0
mirror of https://github.com/hannobraun/Fornjot synced 2025-02-27 01:25:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation of fj-operations

Browse Source
This commit is contained in:
Hanno Braun 2022-03-17 18:04:01 +01:00
parent b1c3b2c2a2
commit ef3bed51f0
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
fj-operations/src/lib.rs
View File

@ -1,3 +1,9 @@
//! Connection between the Fornjot kernel and Fornjot models
//!
//! Fornjot models use the [`fj`] crate to define a shape. This crate provides
//! the connection between [`fj`] and the Fornjot kernel. It translates those
//! operations into terms the kernel can understand.
mod circle; mod circle;
mod difference_2d; mod difference_2d;
mod group; mod group;
@ -9,7 +15,7 @@ use fj_debug::DebugInfo;
use fj_kernel::shape::Shape; use fj_kernel::shape::Shape;
use fj_math::{Aabb, Scalar}; use fj_math::{Aabb, Scalar};
/// Implemented by all shapes /// Implemented for all operations from the [`fj`] crate
pub trait ToShape { pub trait ToShape {
/// Compute the boundary representation of the shape /// Compute the boundary representation of the shape
fn to_shape(&self, tolerance: Scalar, debug: &mut DebugInfo) -> Shape; fn to_shape(&self, tolerance: Scalar, debug: &mut DebugInfo) -> Shape;