From dbae52a8116473bdc071ad6399de919f78e542df Mon Sep 17 00:00:00 2001 From: Hanno Braun Date: Wed, 16 Mar 2022 15:31:27 +0100 Subject: [PATCH] Update documentation of `fj::Group` --- fj/src/shape_3d.rs | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/fj/src/shape_3d.rs b/fj/src/shape_3d.rs index 83bb52dc4..27397d96f 100644 --- a/fj/src/shape_3d.rs +++ b/fj/src/shape_3d.rs @@ -98,20 +98,14 @@ impl From 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: -/// +/// Whether the shapes in the group touch or overlap is not currently checked. #[derive(Clone, Debug)] #[repr(C)] pub struct Group {