rei-mirrors/Fornjot
1
0
Fork 0
mirror of https://github.com/hannobraun/Fornjot synced 2025-01-17 13:46:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Document convenient syntax for fj::Transform

Browse Source
This commit is contained in:
Hanno Braun 2022-10-11 14:55:46 +02:00
parent a9d5afdcbd
commit 0c0c6c155f
1 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
crates/fj/src/transform.rs
View File

@ -2,6 +2,19 @@ use crate::{Angle, Shape};
/// A transformed 3-dimensional shape
///
/// # 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::Shape`
/// let rotated = shape.rotate([0., 0., 1.], fj::Angle::from_rev(0.5));
/// let translated = shape.translate([1., 2., 3.]);
/// ```
///
/// # Limitations
///
/// Transformations are currently limited to a rotation, followed by a