Skip to content

Commit

Permalink
chore(release): version 3.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
andywiecko committed Jun 30, 2024
1 parent e189dd6 commit 3b3efd5
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 5 deletions.
27 changes: 27 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

For online version see [Github Releases].

## [3.0.0] – 2024-06-30

### Added

- **New** online documentation (including manual and scripting API): <https://andywiecko.github.io/BurstTriangulator/>
- `Verbose` option in triangulation settings.
- `Halfedges` for triangulation output.
- `AutoHolesAndBoundary` option in triangulation settings. This option allows for automatic hole detection, eliminating the need for the user to provide hole positions. Holes are calculated using constraint edges.
- Support for generic coordinates. Users can specify the type of coordinates used in the triangulation with `Triangulator<T2>`. The API for this class is the same as `Triangulator`, except the input/output is of type `T2`. Supported coordinate types: `float2`, `double2` (`int2` will be implemented in the future).

### Changed

- Increased performance for `constrainedHalfedges` generation.
- `Circle` based calculations now use `RadiusSq` instead of `Radius`. This results in increased performance in the refinement step, however, the final results may be slightly different.
- **Breaking change:** Moved most of the inner types (e.g., `Status`, `TriangulatorSettings`, etc.) to the global namespace. They can now be accessed directly using `using andywiecko.BurstTriangulator;`.
- **Breaking change:** The default coordinate type for `Triangulator` is now `double2` instead of `float2`.
- (Internal) Greatly simplified job logic replaced with steps. Overall triangulation logic is now easier to follow and read. Some internal structs were removed or hidden inside steps.

### Removed

- Obsolete settings: `BatchCount`, `MinimumAngle`, `MinimumArea`, `MaximumArea`, and `ConstrainEdges`.

### Fixed

- Run triangulator on the main thread using the `Run()` method.

## [2.5.0] – 2024-04-03

### Changed
Expand Down Expand Up @@ -171,6 +197,7 @@ options in the triangulation settings, aka `RestoreBoundary`.

[Github Releases]: https://github.com/andywiecko/BurstTriangulator/releases

[3.0.0]: https://github.com/andywiecko/BurstTriangulator/releases/tag/v3.0.0
[2.5.0]: https://github.com/andywiecko/BurstTriangulator/releases/tag/v2.5.0
[2.4.0]: https://github.com/andywiecko/BurstTriangulator/releases/tag/v2.4.0
[2.3.0]: https://github.com/andywiecko/BurstTriangulator/releases/tag/v2.3.0
Expand Down
2 changes: 1 addition & 1 deletion Documentation~/manual/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Then, in the dependencies section, provide the desired version of the package:

```json
"dependencies": {
"com.andywiecko.burst.triangulator": "2.5.0",
"com.andywiecko.burst.triangulator": "3.0.0",
...
```

Expand Down
2 changes: 1 addition & 1 deletion Documentation~/override/partials/breadcrumb.tmpl.partial
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@
<div class="container" style="
width: 80px;
line-height: 40px;
"><b>v2.5.0</b></div>
"><b>v3.0.0</b></div>
</div>
</div>
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,11 @@ A single-file package which provides Delaunay triangulation of the given set of
- **Constrained triangulation**
- **Mesh refinement** (angle and area parameters)
- **Restoring boundary**
- **Holes**
- **Holes** (manual and auto)
- **Support for `Unity.Jobs` pipeline**
- **Input preprocessors**
- **Input validation**
- **Generic coordinates**

To view the documentation for the manual and scripting API access it online [**here**][manual] or navigate to `Documentation~/` and build this using `docfx.json`.

Expand Down Expand Up @@ -53,7 +54,7 @@ using andywiecko.BurstTriangulator;
and to triangulate unit box $[(0, 0), (1, 0), (1, 1), (0, 1)]$:

```csharp
using var positions = new NativeArray<float2>(new[]
using var positions = new NativeArray<double2>(new[]
{
new(0, 0), new(1, 0), new(1, 1), new(0, 1)
}, Allocator.Persistent);
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "com.andywiecko.burst.triangulator",
"version": "2.5.0",
"version": "3.0.0",
"displayName": "Burst Triangulator",
"description": "A single-file package which provides Delaunay triangulation of the given set of points with constraints and mesh refinement.",
"unity": "2022.2",
Expand Down

0 comments on commit 3b3efd5

Please sign in to comment.