@woosh/meep-engine 2.48.22 → 2.48.23

package/editor/ecs/component/editors/three/BufferGeometryEditor.js

@@ -2,7 +2,7 @@ import { TypeEditor } from "../../TypeEditor.js";
 import { Sampler2D } from "../../../../../src/engine/graphics/texture/sampler/Sampler2D.js";
 import { renderObjectToSampler2D } from "../../../../../src/engine/graphics/util/renderObjectToSampler2D.js";
 import { Mesh, MeshPhongMaterial } from "three";
-import AABB2 from "../../../../../src/core/geom/AABB2.js";
+import AABB2 from "../../../../../src/core/geom/2d/aabb/AABB2.js";
 import { CanvasView } from "../../../../../src/view/elements/CanvasView.js";
 import sampler2D2Canvas from "../../../../../src/engine/graphics/texture/sampler/Sampler2D2Canvas.js";
 

package/editor/ecs/component/editors/three/MeshEditor.js

@@ -1,7 +1,7 @@
 import { TypeEditor } from "../../TypeEditor.js";
 import { Sampler2D } from "../../../../../src/engine/graphics/texture/sampler/Sampler2D.js";
 import { renderObjectToSampler2D } from "../../../../../src/engine/graphics/util/renderObjectToSampler2D.js";
-import AABB2 from "../../../../../src/core/geom/AABB2.js";
+import AABB2 from "../../../../../src/core/geom/2d/aabb/AABB2.js";
 import { CanvasView } from "../../../../../src/view/elements/CanvasView.js";
 import sampler2D2Canvas from "../../../../../src/engine/graphics/texture/sampler/Sampler2D2Canvas.js";
 import { threeUpdateTransform } from "../../../../../src/engine/graphics/util/threeUpdateTransform.js";

package/editor/tools/SelectionTool.js

@@ -5,7 +5,7 @@
 
 import Tool from './engine/Tool.js';
 import Vector2 from '../../src/core/geom/Vector2.js';
-import AABB2 from '../../src/core/geom/AABB2.js';
+import AABB2 from '../../src/core/geom/2d/aabb/AABB2.js';
 import { Camera } from '../../src/engine/graphics/ecs/camera/Camera.js';
 import View from '../../src/view/View.js';
 

package/editor/view/library/MeshLibraryView.js

@@ -4,7 +4,7 @@ import Vector2 from "../../../src/core/geom/Vector2.js";
 import domify from "../../../src/view/DOM.js";
 import LabelView from "../../../src/view/common/LabelView.js";
 import List from "../../../src/core/collection/list/List.js";
-import AABB2 from "../../../src/core/geom/AABB2.js";
+import AABB2 from "../../../src/core/geom/2d/aabb/AABB2.js";
 import { DragEvents } from "../../../src/engine/input/devices/events/DragEvents.js";
 import { MouseEvents } from "../../../src/engine/input/devices/events/MouseEvents.js";
 import { TouchEvents } from "../../../src/engine/input/devices/events/TouchEvents.js";

package/package.json

@@ -5,7 +5,7 @@
   "description": "Fully featured ECS game engine written in JavaScript",
   "type": "module",
   "author": "Alexander Goldring",
-  "version": "2.48.22",
+  "version": "2.48.23",
   "main": "build/meep.module.js",
   "module": "build/meep.module.js",
   "exports": {

package/src/core/binary/32BitEncoder.js

@@ -2,7 +2,7 @@ import { FunctionCompiler } from "../function/FunctionCompiler.js";
 import { assert } from "../assert.js";
 
 /**
- *
+ * Builds an encoder/decoder to simplify process of reading/writing various parts of a 32 bit field
  * @param {number[]} bitCounts
  * @returns {{encode: function(...number):number, decode: function(value:number, result:number[]):void}}
  */

package/src/core/bvh2/LeafNode.js

@@ -2,8 +2,8 @@
  * Created by Alex on 17/11/2014.
  */
 import { Node } from "./Node.js";
-import { serializeAABB3 } from "./aabb3/serializeAABB3.js";
-import { deserializeAABB3 } from "./aabb3/deserializeAABB3.js";
+import { serializeAABB3 } from "../geom/3d/aabb/serializeAABB3.js";
+import { deserializeAABB3 } from "../geom/3d/aabb/deserializeAABB3.js";
 
 
 /**

package/src/core/bvh2/Node.d.ts

@@ -1,4 +1,4 @@
-import {AABB3} from "./aabb3/AABB3";
+import {AABB3} from "../geom/3d/aabb/AABB3";
 import {BinaryNode} from "./BinaryNode";
 
 export class Node<T> extends AABB3 {

package/src/core/bvh2/Node.js

@@ -2,7 +2,7 @@
  * Created by Alex on 17/11/2014.
  */
 import computeMortonCode from "../geom/3d/morton/Morton.js";
-import { AABB3 } from "./aabb3/AABB3.js";
+import { AABB3 } from "../geom/3d/aabb/AABB3.js";
 
 
 export class Node extends AABB3 {

package/src/core/bvh2/NodeValidator.js

@@ -4,7 +4,7 @@ import { buildShortStringPath } from "./Node.js";
 
 /**
  *
- * @param {NodeDescription} node
+ * @param {Node} node
  * @param {ViolationType} type
  * @param {String} message
  * @constructor

package/src/core/bvh2/serialization/deserializeBinaryNode.js

@@ -1,6 +1,6 @@
 import { BinaryNode } from "../BinaryNode.js";
 import { deserializeLeafNode, LeafNode } from "../LeafNode.js";
-import { deserializeAABB3 } from "../aabb3/deserializeAABB3.js";
+import { deserializeAABB3 } from "../../geom/3d/aabb/deserializeAABB3.js";
 
 /**
  *

package/src/core/bvh2/serialization/deserializeBinaryNodeFromBinaryBuffer.js

@@ -1,7 +1,7 @@
 import { BinaryNode } from "../BinaryNode.js";
 import { LeafNode } from "../LeafNode.js";
-import { deserializeAABB3Encoded_v0 } from "../aabb3/deserializeAABB3Encoded_v0.js";
-import { deserializeAABB3 } from "../aabb3/deserializeAABB3.js";
+import { deserializeAABB3Encoded_v0 } from "../../geom/3d/aabb/deserializeAABB3Encoded_v0.js";
+import { deserializeAABB3 } from "../../geom/3d/aabb/deserializeAABB3.js";
 
 /**
  *

package/src/core/bvh2/serialization/serializeBinaryNode.js

@@ -1,5 +1,5 @@
 import { isLeaf, serializeLeafNode } from "../LeafNode.js";
-import { serializeAABB3 } from "../aabb3/serializeAABB3.js";
+import { serializeAABB3 } from "../../geom/3d/aabb/serializeAABB3.js";
 
 /**
  *

package/src/core/bvh2/serialization/serializeBinaryNodeToBinaryBuffer.js

@@ -1,5 +1,5 @@
-import { serializeAABB3 } from "../aabb3/serializeAABB3.js";
-import { serializeAABB3Encoded_v0 } from "../aabb3/serializeAABB3Encoded_v0.js";
+import { serializeAABB3 } from "../../geom/3d/aabb/serializeAABB3.js";
+import { serializeAABB3Encoded_v0 } from "../../geom/3d/aabb/serializeAABB3Encoded_v0.js";
 
 /**
  *

package/src/core/cache/Cache.js

@@ -6,6 +6,7 @@ import { CacheElement } from "./CacheElement.js";
 import { collectIteratorValueToArray } from "../collection/IteratorUtils.js";
 
 /**
+ * Hash-based cache, uses LRU (least-recently-used) eviction policy
  * TODO validate hashes of held elements to keep them up to date. Keys are assumed to be immutable, but this assumption may be broken by users
  * @template Key, Value
  * @extends Map<Key,Value>
@@ -108,7 +109,8 @@ export class Cache {
     }
 
     /**
-     *
+     * Marks element as recently used
+     * Moves element to the end of the eviction queue
      * @param {CacheElement<Key,Value>} element
      * @private
      */
@@ -426,7 +428,7 @@ export class Cache {
          */
         const keys = [];
 
-        collectIteratorValueToArray(keys,this.data.keys());
+        collectIteratorValueToArray(keys, this.data.keys());
 
         const n = keys.length;
         for (let i = 0; i < n; i++) {

package/src/core/codegen/LineBuilder.js

@@ -16,6 +16,9 @@ class Line {
     }
 }
 
+/**
+ * Useful for creating formatted snippets of code
+ */
 class LineBuilder {
 
     /**

package/src/core/collection/HashMap.js

@@ -81,22 +81,28 @@ export class HashMap {
         assert.isNonNegativeInteger(capacity, 'capacity');
 
         assert.isNumber(loadFactor, 'loadFactor');
+        assert.notNaN(loadFactor, 'loadFactor');
         assert.greaterThan(loadFactor, 0, 'loadFactor must be > 0');
 
         /**
          *
          * @type {function(K): number}
+         * @readonly
+         * @private
          */
         this.keyHashFunction = keyHashFunction;
         /**
          *
          * @type {function(K, K): boolean}
+         * @readonly
+         * @private
          */
         this.keyEqualityFunction = keyEqualityFunction;
 
         /**
          * Sparse array of map entries
          * @type {MapEntry[][]}
+         * @private
          */
         this.records = [];
 

package/src/core/collection/heap/Uint32Heap.js

@@ -49,6 +49,7 @@ function HEAP_RIGHT(i) {
 
 /**
  * Binary Heap implementation that stores uin32 ID along with a floating point score value
+ * Very fast and compact
  * Inspired by Blender's heap implementation found here: https://github.com/blender/blender/blob/594f47ecd2d5367ca936cf6fc6ec8168c2b360d0/source/blender/blenlib/intern/BLI_heap.c
  */
 export class Uint32Heap {

package/src/core/events/signal/Signal.js

@@ -41,6 +41,7 @@ export class Signal {
      * @returns {boolean}
      */
     get dispatching() {
+        console.warn('deprecated, use .isDispatching instead');
         return this.getFlag(SignalFlags.Dispatching);
     }
 
@@ -49,6 +50,7 @@ export class Signal {
      * @param {boolean} v
      */
     set dispatching(v) {
+        console.warn('deprecated, flag should not be written to from outside of the signal');
         this.writeFlag(SignalFlags.Dispatching, v);
     }
 
@@ -147,7 +149,7 @@ export class Signal {
      * @param {*} [context]
      */
     addOne(h, context) {
-        assert.isFunction( h,  "handler");
+        assert.isFunction(h, "handler");
 
         const handler = new SignalHandler(h, context);
 
@@ -209,12 +211,12 @@ export class Signal {
         }
 
         //mark dispatch process
-        this.dispatching = true;
+        this.setFlag(SignalFlags.Dispatching);
 
         dispatchViaProxy(this.handlers, args);
 
         //mark end of dispatch process
-        this.dispatching = false;
+        this.clearFlag(SignalFlags.Dispatching);
     }
 
     /**
@@ -588,11 +590,11 @@ export class Signal {
     }
 
     /**
-     *
+     * @deprecated do not use
      * @returns {boolean}
      */
     isDispatching() {
-        return this.dispatching;
+        return this.getFlag(SignalFlags.Dispatching);
     }
 
     /**

package/src/core/events/signal/SignalBinding.js

@@ -4,73 +4,75 @@
  */
 
 
-/**
- *
- * @param {Signal} signal
- * @param {function} handler
- * @param {*} [context]
- * @constructor
- */
-function SignalBinding(signal, handler, context) {
-    if (typeof handler !== "function") {
-        throw new TypeError(`handler must be a function, instead was ${handler}`);
-    }
+export class SignalBinding {
+    /**
+     *
+     * @param {Signal} signal
+     * @param {function} handler
+     * @param {*} [context]
+     * @constructor
+     */
+    constructor(signal, handler, context) {
+        if (typeof handler !== "function") {
+            throw new TypeError(`handler must be a function, instead was ${handler}`);
+        }
 
-    if (typeof signal !== "object") {
-        throw new TypeError(`signal must be of an object, instead was ${signal}`)
-    }
+        if (typeof signal !== "object") {
+            throw new TypeError(`signal must be of an object, instead was ${signal}`)
+        }
 
-    if (typeof signal.add !== "function") {
-        throw new TypeError(`signal.add must be a function, instead was ${signal.add}`);
-    }
+        if (typeof signal.add !== "function") {
+            throw new TypeError(`signal.add must be a function, instead was ${signal.add}`);
+        }
 
-    /**
-     * Binding signal
-     * @type {Signal}
-     */
-    this.signal = signal;
+        /**
+         * Binding signal
+         * @type {Signal}
+         */
+        this.signal = signal;
 
-    /**
-     * Signal handler to be attached to the signal
-     * @type {Function}
-     */
-    this.handler = handler;
+        /**
+         * Signal handler to be attached to the signal
+         * @type {Function}
+         */
+        this.handler = handler;
 
-    /**
-     *
-     * @type {*}
-     */
-    this.context = context;
+        /**
+         *
+         * @type {*}
+         */
+        this.context = context;
+
+        /**
+         * State flag
+         * @type {boolean}
+         */
+        this.linked = false;
+    }
 
     /**
-     * State flag
-     * @type {boolean}
+     * Attaches handler to the signal
+     * Idempotent
      */
-    this.linked = false;
-}
+    link() {
+        if (this.linked) {
+            return;
+        }
 
-/**
- * Attaches handler to the signal
- * Idempotent
- */
-SignalBinding.prototype.link = function () {
-    if (!this.linked) {
         this.linked = true;
         this.signal.add(this.handler, this.context);
     }
-};
 
-/**
- * Detaches handler from the signal
- * Idempotent
- */
-SignalBinding.prototype.unlink = function () {
-    if (this.linked) {
+    /**
+     * Detaches handler from the signal
+     * Idempotent
+     */
+    unlink() {
+        if (!this.linked) {
+            return;
+        }
+
         this.linked = false;
         this.signal.remove(this.handler, this.context);
     }
-};
-
-export {
-    SignalBinding
-};
+}

package/src/core/events/signal/SignalFlags.js

@@ -1,4 +1,11 @@
 export const SignalFlags = {
+    /**
+     * If set - signal will not invoke handlers when dispatched
+     */
     Silent: 1,
+    /**
+     * Is set at the start of the dispatch and cleared at the end
+     * @deprecated
+     */
     Dispatching: 2
 }

package/src/core/function/Functions.js

@@ -6,7 +6,7 @@
 
 /**
  * No-operation function. Does nothing. Useful when a callback is required to avoid checks for a missing function.
- * @param {*..} arguments
+ * @param {*} arguments
  */
 export function noop() {
 }

package/src/core/geom/{Rectangle.js → 2d/Rectangle.js}

@@ -1,11 +1,11 @@
 /**
  * Created by Alex on 14/03/2016.
  */
-import { max2 } from "../math/max2.js";
-import { min2 } from "../math/min2.js";
-import Vector2 from "./Vector2.js";
-import { intersects1D } from "../math/interval/intersects1D.js";
-import { overlap1D } from "../math/interval/overlap1D.js";
+import { max2 } from "../../math/max2.js";
+import { min2 } from "../../math/min2.js";
+import Vector2 from "../Vector2.js";
+import { intersects1D } from "../../math/interval/intersects1D.js";
+import { overlap1D } from "../../math/interval/overlap1D.js";
 
 
 class Rectangle {

package/src/core/geom/{AABB2.js → 2d/aabb/AABB2.js}

@@ -4,13 +4,14 @@
  */
 
 
-import { assert } from "../assert.js";
-import { clamp } from "../math/clamp.js";
-import { max2 } from "../math/max2.js";
-import { min2 } from "../math/min2.js";
-import LineSegment2 from "./LineSegment2.js";
-import Vector2 from "./Vector2.js";
-import { overlap1D } from "../math/interval/overlap1D.js";
+import { assert } from "../../../assert.js";
+import { clamp } from "../../../math/clamp.js";
+import { max2 } from "../../../math/max2.js";
+import { min2 } from "../../../math/min2.js";
+import LineSegment2 from "../LineSegment2.js";
+import Vector2 from "../../Vector2.js";
+import { aabb2_compute_overlap } from "./aabb2_compute_overlap.js";
+import { aabb2_overlap_exists } from "./aabb2_overlap_exists.js";
 
 /**
  *
@@ -137,7 +138,7 @@ class AABB2 {
         const bx1 = other.x1;
         const by1 = other.y1;
 
-        return computeOverlap(ax0, ay0, ax1, ay1, bx0, by0, bx1, by1, result);
+        return aabb2_compute_overlap(ax0, ay0, ax1, ay1, bx0, by0, bx1, by1, result);
     }
 
     /**
@@ -156,7 +157,7 @@ class AABB2 {
         const bx1 = other.x1;
         const by1 = other.y1;
 
-        return aabb2_overlapExists(ax0, ay0, ax1, ay1, bx0, by0, bx1, by1);
+        return aabb2_overlap_exists(ax0, ay0, ax1, ay1, bx0, by0, bx1, by1);
     }
 
     /**
@@ -583,74 +584,5 @@ AABB2.zero = Object.freeze(new AABB2(0, 0, 0, 0));
  */
 AABB2.unit = Object.freeze(new AABB2(0, 0, 1, 1));
 
-/**
- *
- * @param {number} ax0
- * @param {number} ay0
- * @param {number} ax1
- * @param {number} ay1
- * @param {number} bx0
- * @param {number} by0
- * @param {number} bx1
- * @param {number} by1
- * @returns {boolean} true if overlap exists, false if no overlap
- */
-export function aabb2_overlapExists(ax0, ay0, ax1, ay1, bx0, by0, bx1, by1) {
-    return overlap1D(ax0, ax1, bx0, bx1)
-        && overlap1D(ay0, ay1, by0, by1);
-}
-
-/**
- *
- * @param {number} bounds_x0
- * @param {number} bounds_y0
- * @param {number} bounds_x1
- * @param {number} bounds_y1
- * @param {number} x0
- * @param {number} y0
- * @param {number} x1
- * @param {number} y1
- * @return {boolean}
- */
-export function aabb2_contains(bounds_x0, bounds_y0, bounds_x1, bounds_y1, x0, y0, x1, y1) {
-
-    return x0 >= bounds_x0 && x1 <= bounds_x1 && y0 >= bounds_y0 && y1 <= bounds_y1;
-}
-
-/**
- *
- * @param {number} ax0
- * @param {number} ay0
- * @param {number} ax1
- * @param {number} ay1
- * @param {number} bx0
- * @param {number} by0
- * @param {number} bx1
- * @param {number} by1
- * @param {AABB2} result
- * @returns {boolean} true if overlap exists, false if no overlap
- */
-function computeOverlap(ax0, ay0, ax1, ay1, bx0, by0, bx1, by1, result) {
-    const x0 = max2(ax0, bx0);
-    const x1 = min2(ax1, bx1);
-
-    if (x0 >= x1) {
-        //no overlap
-        return false;
-    }
-
-    const y0 = max2(ay0, by0);
-    const y1 = min2(ay1, by1);
-
-    if (y0 >= y1) {
-        //no overlap
-        return false;
-    }
-
-    result.set(x0, y0, x1, y1);
-
-    return true;
-}
-
 
 export default AABB2;

package/src/core/geom/{AABB2.spec.js → 2d/aabb/AABB2.spec.js}

@@ -1,4 +1,4 @@
-import AABB2 from "./AABB2.js";
+import AABB2 from "./AABB2.d.ts";
 
 test('copy', () => {
     const a = new AABB2(1, 2, 5, 11);

package/src/core/geom/2d/aabb/aabb2_compute_overlap.js

@@ -0,0 +1,42 @@
+import { max2 } from "../../../math/max2.js";
+import { min2 } from "../../../math/min2.js";
+
+/**
+ *
+ * @param {number} ax0
+ * @param {number} ay0
+ * @param {number} ax1
+ * @param {number} ay1
+ * @param {number} bx0
+ * @param {number} by0
+ * @param {number} bx1
+ * @param {number} by1
+ * @param {AABB2} result
+ * @returns {boolean} true if overlap exists, false if no overlap
+ */
+export function aabb2_compute_overlap(
+    ax0, ay0, ax1, ay1,
+    bx0, by0, bx1, by1,
+    result
+) {
+
+    const x0 = max2(ax0, bx0);
+    const x1 = min2(ax1, bx1);
+
+    if (x0 >= x1) {
+        //no overlap
+        return false;
+    }
+
+    const y0 = max2(ay0, by0);
+    const y1 = min2(ay1, by1);
+
+    if (y0 >= y1) {
+        //no overlap
+        return false;
+    }
+
+    result.set(x0, y0, x1, y1);
+
+    return true;
+}

package/src/core/geom/2d/aabb/aabb2_contains.js

@@ -0,0 +1,23 @@
+/**
+ *
+ * @param {number} bounds_x0
+ * @param {number} bounds_y0
+ * @param {number} bounds_x1
+ * @param {number} bounds_y1
+ * @param {number} x0
+ * @param {number} y0
+ * @param {number} x1
+ * @param {number} y1
+ * @return {boolean}
+ */
+export function aabb2_contains(
+    bounds_x0, bounds_y0, bounds_x1, bounds_y1,
+    x0, y0, x1, y1
+) {
+
+    return x0 >= bounds_x0
+        && x1 <= bounds_x1
+        && y0 >= bounds_y0
+        && y1 <= bounds_y1
+        ;
+}

package/src/core/geom/2d/aabb/aabb2_distance_sqr_to_point.js

@@ -0,0 +1,25 @@
+import { max3 } from "../../../math/max3.js";
+
+/**
+ * NOTE: The result is not a signed distance, any degree of penetration will produce 0 distance as a result
+ * @param {number} x0
+ * @param {number} y0
+ * @param {number} x1
+ * @param {number} y1
+ * @param {number} px
+ * @param {number} py
+ * @returns {number}
+ */
+export function aabb2_distance_sqr_to_point(x0, y0, x1, y1, px, py) {
+
+    const dx0 = x0 - px;
+    const dx1 = px - x1;
+
+    const dy0 = y0 - py;
+    const dy1 = py - y1;
+
+    const dx = max3(0, dx0, dx1);
+    const dy = max3(0, dy0, dy1);
+
+    return dx * dx + dy * dy;
+}