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

Update documentation of fj::Group

Browse Source
This commit is contained in:
Hanno Braun 2022-03-16 15:31:27 +01:00
parent c9f7ee495e
commit dbae52a811
1 changed files with 5 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
fj/src/shape_3d.rs
View File

@ -98,20 +98,14 @@ impl From<Sweep> for Shape3d {
}
}
/// The union of two 3-dimensional shapes
/// A group of two 3-dimensional shapes
///
/// A group is a collection of disjoint shapes. It is not a union, in that the
/// shapes in the group are not allowed to touch or overlap.
///
/// # Limitations
///
/// Support for unions is somewhat limited right now. A union of 2 distinct
/// shapes doesn't really create a new shape, but just an aggregation of the
/// two original shapes.
///
/// This means, for example, that generating the triangle mesh of the union does
/// not result in a proper triangle mesh, but rather the two, possibly
/// intersecting, triangle meshes of the original shapes.
///
/// See issue:
/// <https://github.com/hannobraun/Fornjot/issues/42>
/// Whether the shapes in the group touch or overlap is not currently checked.
#[derive(Clone, Debug)]
#[repr(C)]
pub struct Group {