@forgeax/engine-math 0.0.0-dev.8d955ade1c79

package/src/noise.ts

@@ -0,0 +1,78 @@
+// noise.ts — noise-function namespace (solo round 20260716-212942)
+//
+// 1-function surface: perlin1d — 1D Perlin noise returning [-1, 1]. The growable home for
+// further noise variants (2D Perlin, simplex, Worley, etc.).
+//
+// The permutation table is the canonical 256-entry table from Bevy's 2d_screen_shake example.
+// The fade function is the smootherstep polynomial (6t⁵−15t⁴+10t³), matching the Perlin
+// reference implementation — forgeax's own easing.smootherstep is the same polynomial but we
+// inline it here to keep the noise namespace self-contained (no cross-namespace dependency).
+
+// Canonical Perlin permutation table — a random sequence of 0-255.
+const PERM: Readonly<Uint8Array> = new Uint8Array([
+  0x97, 0xa0, 0x89, 0x5b, 0x5a, 0x0f, 0x83, 0x0d, 0xc9, 0x5f, 0x60, 0x35, 0xc2, 0xe9, 0x07, 0xe1,
+  0x8c, 0x24, 0x67, 0x1e, 0x45, 0x8e, 0x08, 0x63, 0x25, 0xf0, 0x15, 0x0a, 0x17, 0xbe, 0x06, 0x94,
+  0xf7, 0x78, 0xea, 0x4b, 0x00, 0x1a, 0xc5, 0x3e, 0x5e, 0xfc, 0xdb, 0xcb, 0x75, 0x23, 0x0b, 0x20,
+  0x39, 0xb1, 0x21, 0x58, 0xed, 0x95, 0x38, 0x57, 0xae, 0x14, 0x7d, 0x88, 0xab, 0xa8, 0x44, 0xaf,
+  0x4a, 0xa5, 0x47, 0x86, 0x8b, 0x30, 0x1b, 0xa6, 0x4d, 0x92, 0x9e, 0xe7, 0x53, 0x6f, 0xe5, 0x7a,
+  0x3c, 0xd3, 0x85, 0xe6, 0xdc, 0x69, 0x5c, 0x29, 0x37, 0x2e, 0xf5, 0x28, 0xf4, 0x66, 0x8f, 0x36,
+  0x41, 0x19, 0x3f, 0xa1, 0x01, 0xd8, 0x50, 0x49, 0xd1, 0x4c, 0x84, 0xbb, 0xd0, 0x59, 0x12, 0xa9,
+  0xc8, 0xc4, 0x87, 0x82, 0x74, 0xbc, 0x9f, 0x56, 0xa4, 0x64, 0x6d, 0xc6, 0xad, 0xba, 0x03, 0x40,
+  0x34, 0xd9, 0xe2, 0xfa, 0x7c, 0x7b, 0x05, 0xca, 0x26, 0x93, 0x76, 0x7e, 0xff, 0x52, 0x55, 0xd4,
+  0xcf, 0xce, 0x3b, 0xe3, 0x2f, 0x10, 0x3a, 0x11, 0xb6, 0xbd, 0x1c, 0x2a, 0xdf, 0xb7, 0xaa, 0xd5,
+  0x77, 0xf8, 0x98, 0x02, 0x2c, 0x9a, 0xa3, 0x46, 0xdd, 0x99, 0x65, 0x9b, 0xa7, 0x2b, 0xac, 0x09,
+  0x81, 0x16, 0x27, 0xfd, 0x13, 0x62, 0x6c, 0x6e, 0x4f, 0x71, 0xe0, 0xe8, 0xb2, 0xb9, 0x70, 0x68,
+  0xda, 0xf6, 0x61, 0xe4, 0xfb, 0x22, 0xf2, 0xc1, 0xee, 0xd2, 0x90, 0x0c, 0xbf, 0xb3, 0xa2, 0xf1,
+  0x51, 0x33, 0x91, 0xeb, 0xf9, 0x0e, 0xef, 0x6b, 0x31, 0xc0, 0xd6, 0x1f, 0xb5, 0xc7, 0x6a, 0x9d,
+  0xb8, 0x54, 0xcc, 0xb0, 0x73, 0x79, 0x32, 0x2d, 0x7f, 0x04, 0x96, 0xfe, 0x8a, 0xec, 0xcd, 0x5d,
+  0xde, 0x72, 0x43, 0x1d, 0x18, 0x48, 0xf3, 0x8d, 0x80, 0xc3, 0x4e, 0x42, 0xd7, 0x3d, 0x9c, 0xb4,
+]);
+
+/**
+ * Perlin smootherstep fade curve: `6t⁵ − 15t⁴ + 10t³`. The canonical Perlin fade — same
+ * polynomial as {@link easing!smootherstep} but inlined so the noise namespace stays
+ * self-contained. Input expected in [0, 1]; output is the smoothed value.
+ */
+function fade(t: number): number {
+  return t * t * t * (t * (t * 6.0 - 15.0) + 10.0);
+}
+
+/**
+ * Dot product of a 1D gradient with the distance vector. The gradient is +1 or -1 based on
+ * the lowest bit of the hash; the distance is the fractional offset from the integer lattice
+ * point.
+ */
+function dotGrad(hash: number, xf: number): number {
+  return hash & 0x1 ? xf : -xf;
+}
+
+/**
+ * 1D Perlin noise. Returns a value in [-1, 1] that varies smoothly with the input `x` —
+ * small changes in `x` produce small changes in output (no wild jumps). Three separate calls
+ * with different `x` offsets (e.g. `perlin1d(t)`, `perlin1d(t + 100)`, `perlin1d(t + 200)`)
+ * produce three independent but individually smooth noise channels.
+ *
+ * This is the canonical Perlin noise algorithm with the 256-entry permutation table from
+ * Bevy's `2d_screen_shake` example. Use for camera shake, procedural terrain, organic
+ * motion, and any effect that needs smooth pseudo-random variation.
+ */
+export function perlin1d(x: number): number {
+  const xFloor = Math.floor(x);
+  const xi0 = xFloor & 0xff;
+  const xi1 = (xFloor + 1) & 0xff;
+
+  const xf0 = x - xFloor;
+  const xf1 = xf0 - 1.0;
+
+  const t = fade(xf0);
+
+  const h0 = PERM[xi0] ?? 0;
+  const h1 = PERM[xi1] ?? 0;
+
+  const a = dotGrad(h0, xf0);
+  const b = dotGrad(h1, xf1);
+
+  // Linear interpolation between the two gradient dots.
+  // Using the standard lerp: a + t * (b - a) where t is the faded xf0.
+  return a + t * (b - a);
+}