rei-mirrors/Fornjot
1
0
Fork 0
mirror of https://github.com/hannobraun/Fornjot synced 2025-08-31 14:36:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1899 from hannobraun/docs

Browse Source 
Make some improvements to the documentation
This commit is contained in:
Hanno Braun 2023-06-20 10:30:54 +02:00 committed by GitHub
commit 3ab39d5f8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 35 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
crates/fj-core/src/algorithms/approx/edge.rs
View File

@ -3,7 +3,7 @@
//! The approximation of a curve is its first vertex, combined with the //! The approximation of a curve is its first vertex, combined with the
//! approximation of its curve. The second vertex is left off, as edge //! approximation of its curve. The second vertex is left off, as edge
//! approximations are usually used to build cycle approximations, and this way, //! approximations are usually used to build cycle approximations, and this way,
//! the caller doesn't have to call with duplicate vertices. //! the caller doesn't have to deal with duplicate vertices.
use std::collections::BTreeMap; use std::collections::BTreeMap;

9
crates/fj-core/src/algorithms/mod.rs
View File

@ -1,7 +1,14 @@
//! Collection of algorithms that are used by the kernel //! Collection of algorithms that operate on geometry
//! //!
//! Algorithmic code is collected in this module, to keep other modules focused //! Algorithmic code is collected in this module, to keep other modules focused
//! on their respective purpose. //! on their respective purpose.
//!
//! # Implementation Note
//!
//! This module exists in a bit of an in-between state, as some of the things
//! that are still here are probably better places in the [`operations`] module.
//!
//! [`operations`]: crate::operations
pub mod approx; pub mod approx;
pub mod bounding_volume; pub mod bounding_volume;

4
crates/fj-core/src/lib.rs
View File

@ -14,8 +14,8 @@
//! explicitness**. This means that geometrical relationships must be expressed //! explicitness**. This means that geometrical relationships must be expressed
//! explicitly, or they are not accepted. //! explicitly, or they are not accepted.
//! //!
//! It is important to understand that this principle defines the destination of //! This principle is not fully implemented yet. There are quite a few
//! CAD kernel development. It does not reflect the current reality. //! validation checks that enforce part of it, but many are still missing.
//! //!
//! ### Motivation //! ### Motivation
//! //!

24
crates/fj-math/src/coordinates.rs
View File

@ -1,6 +1,14 @@
use super::Scalar; use super::Scalar;
/// 1-dimensional curve coordinates /// 1-dimensional curve coordinates
///
/// One-dimensional [`Point`]s and [`Vector`]s dereference to this type (via
/// [`Deref`]). This allows you to access the `t` field, even though [`Point`]
/// and [`Vector`] do not have such a field themselves.
///
/// [`Deref`]: std::ops::Deref
/// [`Point`]: crate::Point
/// [`Vector`]: crate::Vector
#[repr(C)] #[repr(C)]
pub struct T { pub struct T {
/// The single coordinate of the 1-dimensional curve coordinates /// The single coordinate of the 1-dimensional curve coordinates
@ -8,6 +16,14 @@ pub struct T {
} }
/// 2-dimensional surface coordinates /// 2-dimensional surface coordinates
///
/// Two-dimensional [`Point`]s and [`Vector`]s dereference to this type (via
/// [`Deref`]). This allows you to access the `u`/`v` fields, even though
/// [`Point`] and [`Vector`] do not have such fields themselves.
///
/// [`Deref`]: std::ops::Deref
/// [`Point`]: crate::Point
/// [`Vector`]: crate::Vector
#[repr(C)] #[repr(C)]
pub struct Uv { pub struct Uv {
/// The first coordinate of the 2-dimensional surface coordinates /// The first coordinate of the 2-dimensional surface coordinates
@ -18,6 +34,14 @@ pub struct Uv {
} }
/// 3-dimensional model coordinates /// 3-dimensional model coordinates
///
/// Three-dimensional [`Point`]s and [`Vector`]s dereference to this type (via
/// [`Deref`]). This allows you to access the `x`/`y`/`z` fields, even though
/// [`Point`] and [`Vector`] do not have such fields themselves.
///
/// [`Deref`]: std::ops::Deref
/// [`Point`]: crate::Point
/// [`Vector`]: crate::Vector
#[repr(C)] #[repr(C)]
pub struct Xyz { pub struct Xyz {
/// The first coordinate of the 3-dimensional model coordinates /// The first coordinate of the 3-dimensional model coordinates