commit 1bbb54155cad8f2e302a444f3049c95f8231b553
parent a786448ac0589cb29390fc4f888b2cb24aa27ab7
Author: Christophe Coustet <christophe.coustet@meso-star.com>
Date: Tue, 7 Jul 2020 10:00:21 +0200
Fix release notes for release 0.5
Diffstat:
1 file changed, 11 insertions(+), 7 deletions(-)
diff --git a/README.md b/README.md
@@ -9,11 +9,11 @@ geometry. An enclosure is a set of triangles enclosing a given volume.
The enclosure notion extends to open enclosures for which there is no
inside or outside. For every detected enclosure, the library provides
the set of involved triangle sides as well as the set of involved media
-and a few metrics (number of triangles, ...).
+and a few metrics (number of triangles, volume, area, ...).
-The library allows geometry to be added by subsets of triangles and
-manages vertices and triangles duplicates as long as the duplicate
-information is coherent, easing the scene definition process.
+From release 0.5, the geometry has to be provided at once, with no
+duplicates nor zero-area triangles. To help ensuring this constraints,
+one can rely on the star-geometry-3d library.
Also the convention regarding FRONT/BACK sides for input triangles as
well as the convention regarding normals' orientation for output
@@ -30,7 +30,7 @@ two more libraries are needed to build tests:
[Star-SP](https://gitlab.com/meso-star/star-sp/) and
[Star-3DUT](https://gitlab.com/meso-star/star-3dut/).
-First ensure that CMake and a C compiler that implements the OpenMP 1.2
+First ensure that CMake and a C compiler that implements the OpenMP 2.0 API
are installed on your system. Then install the RCMake package as well as
all the aforementioned prerequisites. Finally generate the project from
the `cmake/CMakeLists.txt` file by appending to the `CMAKE_PREFIX_PATH`
@@ -41,12 +41,16 @@ Release notes
### Version 0.5
+This release breaks the API as geometry cannot be provided through calls
+to an add-like call anymore. Instead the whole geometry must be provided
+at once, with no duplicates (either vertices or triangles) nor zero-area
+triangles.
+
- Compute volume and surface of enclosures.
- Report overlapping triangles.
Only triangles with a common edge are currently detected.
- Do not extract enclosures anymore when overlapping triangles are
- detected.
+ Do not extract enclosures when overlapping triangles are detected.
- Make enclosure IDs consistent across runs.
