deprecate the SimplexNoise classes (#271)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 2787efd..98d5851 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -3,6 +3,8 @@
- `operator ==` overrides no longer take nullable arguments. This is only
visible for classes that implement the interfaces defined in this package
which no longer need to also widen the argument type.
+- Deprecate `SimplexNoise`; see https:github.com/google/vector_math.dart/issues/270
+ for more information.
## 2.1.2
diff --git a/README.md b/README.md
index 01cff7e..dc1dacb 100644
--- a/README.md
+++ b/README.md
@@ -163,4 +163,3 @@
```
~/src/vector_math/> dart tool/generate_vector_math_64.dart
```
-
diff --git a/lib/src/vector_math/third_party/noise.dart b/lib/src/vector_math/third_party/noise.dart
index 0e78bfb..32180be 100644
--- a/lib/src/vector_math/third_party/noise.dart
+++ b/lib/src/vector_math/third_party/noise.dart
@@ -26,6 +26,8 @@
* found at: http://webstaff.itn.liu.se/~stegu/simplexnoise/SimplexNoise.java
*/
+@Deprecated('This API will be removed '
+ '(see https:github.com/google/vector_math.dart/issues/270)')
class SimplexNoise {
static final List<List<double>> _grad3 = <List<double>>[
<double>[1.0, 1.0, 0.0],
diff --git a/lib/src/vector_math_64/third_party/noise.dart b/lib/src/vector_math_64/third_party/noise.dart
index dbbd5b5..1980dd3 100644
--- a/lib/src/vector_math_64/third_party/noise.dart
+++ b/lib/src/vector_math_64/third_party/noise.dart
@@ -25,7 +25,8 @@
* This is based on the implementation of Simplex Noise by Stefan Gustavson
* found at: http://webstaff.itn.liu.se/~stegu/simplexnoise/SimplexNoise.java
*/
-
+@Deprecated('This API will be removed '
+ '(see https:github.com/google/vector_math.dart/issues/270)')
class SimplexNoise {
static final List<List<double>> _grad3 = <List<double>>[
<double>[1.0, 1.0, 0.0],
diff --git a/lib/vector_math.dart b/lib/vector_math.dart
index 92ed0b5..dda25df 100644
--- a/lib/vector_math.dart
+++ b/lib/vector_math.dart
@@ -11,8 +11,8 @@
/// [Quad], [Ray], [Sphere] and [Triangle]).
///
/// In addition some utilities are available as color operations (See [Colors]
-/// class), noise generators ([SimplexNoise]) and common OpenGL operations
-/// (like [makeViewMatrix], [makePerspectiveMatrix], or [pickRay]).
+/// class) and common OpenGL operations (like [makeViewMatrix],
+/// [makePerspectiveMatrix], or [pickRay]).
library vector_math;
import 'dart:math' as math;
diff --git a/lib/vector_math_64.dart b/lib/vector_math_64.dart
index 74d6066..44fefdc 100644
--- a/lib/vector_math_64.dart
+++ b/lib/vector_math_64.dart
@@ -11,8 +11,8 @@
/// [Quad], [Ray], [Sphere] and [Triangle]).
///
/// In addition some utilities are available as color operations (See [Colors]
-/// class), noise generators ([SimplexNoise]) and common OpenGL operations
-/// (like [makeViewMatrix], [makePerspectiveMatrix], or [pickRay]).
+/// class) and common OpenGL operations (like [makeViewMatrix],
+/// [makePerspectiveMatrix], or [pickRay]).
library vector_math_64;
import 'dart:math' as math;
diff --git a/test/noise_test.dart b/test/noise_test.dart
index b6aba27..6368113 100644
--- a/test/noise_test.dart
+++ b/test/noise_test.dart
@@ -2,6 +2,8 @@
// All rights reserved. Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
+// ignore_for_file: deprecated_member_use_from_same_package
+
import 'package:test/test.dart';
import 'package:vector_math/vector_math.dart';
