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

Document convenient syntax of fj::Sweep

Browse Source
This commit is contained in:
Hanno Braun 2022-10-11 14:50:55 +02:00
parent 8a231eee91
commit 7f1bba7e98
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
crates/fj/src/sweep.rs
View File

@ -1,6 +1,18 @@
use crate::{Shape, Shape2d}; use crate::{Shape, Shape2d};
/// A sweep of a 2-dimensional shape along straight path /// A sweep of a 2-dimensional shape along straight path
///
/// # Examples
///
/// Convenient syntax for this operation is available through [`crate::syntax`].
///
/// ``` rust
/// # let shape = fj::Sketch::from_points(vec![[0., 0.], [1., 0.], [0., 1.]]);
/// use fj::syntax::*;
///
/// // `shape` can be anything that converts to `fj::Shape2d`
/// let group = shape.sweep([0., 0., 1.]);
/// ```
#[derive(Clone, Debug, PartialEq)] #[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))] #[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
#[repr(C)] #[repr(C)]