v0.103

* add `dist()`
* remove `wave()` (moved to @litecanvas/utils)

Author: luizbills

package.json

@@ -1,6 +1,6 @@
 {
     "name": "litecanvas",
-    "version": "0.102.3",
+    "version": "0.103.0",
     "description": "Lightweight HTML5 canvas 2D game engine suitable for small projects and creative coding. Inspired by PICO-8 and p5.js/Processing.",
     "license": "MIT",
     "author": "Luiz Bills <luizbills@pm.me>",

src/index.js

@@ -217,6 +217,24 @@ export default function litecanvas(settings = {}) {
             return value
         },
 
+        /**
+         * Calculates the distance between a point (x1, y1) to another (x2, y2).
+         *
+         * @param {number} x1
+         * @param {number} y1
+         * @param {number} x2
+         * @param {number} y2
+         * @returns {number}
+         */
+        dist: (x1, y1, x2, y2) => {
+            DEV: assert(isNumber(x1), '[litecanvas] dist() 1st param must be a number')
+            DEV: assert(isNumber(y1), '[litecanvas] dist() 2nd param must be a number')
+            DEV: assert(isNumber(x2), '[litecanvas] dist() 3rd param must be a number')
+            DEV: assert(isNumber(y2), '[litecanvas] dist() 4th param must be a number')
+
+            return math.hypot(x2 - x1, y2 - y1)
+        },
+
         /**
          * Wraps a number between `min` (inclusive) and `max` (exclusive).
          *
@@ -286,25 +304,6 @@ export default function litecanvas(settings = {}) {
             return instance.map(value, start, stop, 0, 1)
         },
 
-        /**
-         * Interpolate between 2 values using a periodic function.
-         *
-         * @param {number} from - the lower bound
-         * @param {number} to - the higher bound
-         * @param {number} t - value passed to the periodic function
-         * @param {(n: number) => number} [fn] - the periodic function (which default to `Math.sin`)
-         */
-        wave: (from, to, t, fn = Math.sin) => {
-            DEV: assert(isNumber(from), '[litecanvas] wave() 1st param must be a number')
-            DEV: assert(isNumber(to), '[litecanvas] wave() 2nd param must be a number')
-            DEV: assert(isNumber(t), '[litecanvas] wave() 3rd param must be a number')
-            DEV: assert(
-                'function' === typeof fn,
-                '[litecanvas] wave() 4rd param must be a function (n: number) => number'
-            )
-            return from + ((fn(t) + 1) / 2) * (to - from)
-        },
-
         /** RNG API */
         /**
          * Generates a pseudorandom float between min (inclusive) and max (exclusive)

src/version.js

@@ -11,6 +11,8 @@ test.before(() => {
     local = litecanvas({
         global: false,
     })
+
+    local.listen('init', () => local.pause())
 })
 
 test.after(() => {
@@ -83,21 +85,8 @@ test('round', async (t) => {
     t.is(local.round(n, 5), 9.87654)
 })
 
-test('wave', async (t) => {
-    {
-        // interpolate from 0 to 100 using Math.sin (default)
-        const amount = 0
-        const expected = 50
-        const actual = local.wave(0, 100, amount)
-        t.is(actual, expected)
-    }
-
-    {
-        // interpolate from 0 to 100 using a custom periodic function
-        const amount = 0
-        const fn = (x) => -Math.cos(x)
-        const expected = 0
-        const actual = local.wave(0, 100, amount, fn)
-        t.is(actual, expected)
-    }
+test('dist', async (t) => {
+    const expected = 100
+    const actual = local.dist(0, 0, 0, 100)
+    t.is(actual, expected)
 })

tests/math.js

@@ -116,14 +116,15 @@ declare global {
      */
     function norm(value: number, start: number, stop: number): number
     /**
-     * Interpolate between 2 values using a periodic function.
+     * Calculates the distance between a point (x1, y1) to another (x2, y2).
      *
-     * @param from - the lower bound
-     * @param to - the higher bound
-     * @param t - the value passed to the periodic function
-     * @param fn= - the periodic function (which default to `Math.sin`)
+     * @param x1
+     * @param y1
+     * @param x2
+     * @param y2
+     * @returns the distance
      */
-    function wave(from: number, to: number, t: number, fn?: (n: number) => number): number
+    function dist(x1: number, y1: number, x2: number, y2: number): number
     /**
      * Returns the sine of a number in radians
      */

types/global.d.ts

@@ -110,14 +110,15 @@ type LitecanvasInstance = {
      */
     norm(value: number, start: number, stop: number): number
     /**
-     * Interpolate between 2 values using a periodic function.
+     * Calculates the distance between a point (x1, y1) to another (x2, y2).
      *
-     * @param from - the lower bound
-     * @param to - the higher bound
-     * @param t - the value passed to the periodic function
-     * @param fn - the periodic function (which default to `Math.sin`)
+     * @param x1
+     * @param y1
+     * @param x2
+     * @param y2
+     * @returns the distance
      */
-    wave(from: number, to: number, t: number, fn?: (n: number) => number): number
+    dist(x1: number, y1: number, x2: number, y2: number): number
     /**
      * Returns the sine of a number in radians
      */