@woosh/meep-engine 2.48.18 → 2.48.19

package/package.json

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

package/src/core/geom/Matrix4.js

@@ -4,6 +4,9 @@ const _z = new Vector3();
 const _x = new Vector3();
 const _y = new Vector3();
 
+/**
+ * @deprecated use arrays instead or mat4 from gl-matrix
+ */
 export class Matrix4 {
     /**
      *
@@ -197,7 +200,7 @@ export class Matrix4 {
         const sz = Math.hypot(this.c0, this.c1, this.c2);
 
         // if determine is negative, we need to invert one scale
-        const  det = this.determinant();
+        const det = this.determinant();
         if (det < 0) sx = -sx;
 
         position.set(

package/src/core/graph/Edge.js

@@ -26,8 +26,8 @@ export class Edge {
      * @constructor
      */
     constructor(a, b) {
-        assert.notEqual(a, undefined, 'a is undefined');
-        assert.notEqual(b, undefined, 'b is undefined');
+        assert.defined(a, 'a');
+        assert.defined(b, 'b');
 
         /**
          *
@@ -46,6 +46,11 @@ export class Edge {
         this.direction = EdgeDirectionType.Undirected;
     }
 
+    /**
+     *
+     * @param {N} node
+     * @return {boolean}
+     */
     contains(node) {
         return this.first === node || this.second === node;
     }
@@ -86,6 +91,8 @@ export class Edge {
      * @returns {number}
      */
     angle() {
+        console.error('method is deprecated, do not use');
+
         const delta = this.second.clone().sub(this.first);
         return Math.atan2(delta.y, delta.x);
     }
@@ -104,6 +111,8 @@ export class Edge {
      * @returns {number}
      */
     get length() {
+        console.error('method is deprecated, do not use');
+
         return this.first.distanceTo(this.second);
     }
 }

package/src/core/graph/v2/Graph.js

@@ -26,29 +26,31 @@ function construct_path(goal_node_container, cameFrom) {
 export class Graph {
 
     /**
-     * @template N
+     *
+     * @type {Map<N, NodeContainer<N>>}
+     * @private
+     */
+    __nodes = new Map();
+    /**
+     *
+     * @type {Set<Edge<N>>}
+     * @private
      */
-    constructor() {
+    __edges = new Set();
+
+    on = {
         /**
-         *
-         * @type {Map<N, NodeContainer<N>>}
-         * @private
+         * @type {Signal<N,this>}
          */
-        this.__nodes = new Map();
+        nodeAdded: new Signal(),
         /**
-         *
-         * @type {Set<Edge<N>>}
-         * @private
+         * @type {Signal<N,this>}
          */
-        this.__edges = new Set();
-
-        this.on = {
-            nodeAdded: new Signal(),
-            nodeRemoved: new Signal(),
-            edgeAdded: new Signal(),
-            edgeRemoved: new Signal()
-        };
-    }
+        nodeRemoved: new Signal(),
+        edgeAdded: new Signal(),
+        edgeRemoved: new Signal()
+    };
+
 
     /**
      *
@@ -115,6 +117,14 @@ export class Graph {
         return this.__nodes.size;
     }
 
+    /**
+     *
+     * @returns {number}
+     */
+    getNodeCount() {
+        return this.__nodes.size;
+    }
+
     /**
      *
      * @param {function(N):boolean} filter
@@ -169,14 +179,6 @@ export class Graph {
         return this.__nodes.keys();
     }
 
-    /**
-     *
-     * @returns {number}
-     */
-    getNodeCount() {
-        return this.__nodes.size;
-    }
-
     /**
      * Do not modify this set directly
      * @return {Set<Edge<N>>}
@@ -217,8 +219,10 @@ export class Graph {
         const context_0 = this.__nodes.get(edge.first);
         const context_1 = this.__nodes.get(edge.second);
 
-        if (context_0 === undefined || context_1 === undefined) {
-            throw new Error('One or more of the edge nodes are not part of the graph');
+        if (context_0 === undefined) {
+            throw new Error(`First node(=${edge.first}) of the edge is not part of the graph`);
+        } else if (context_1 === undefined) {
+            throw new Error(`Second node(=${edge.second}) of the edge is not part of the graph`);
         }
 
         context_0.addEdge(edge);
@@ -246,6 +250,7 @@ export class Graph {
         const context_1 = this.__nodes.get(edge.second);
 
         if (context_0 === undefined || context_1 === undefined) {
+            // this is a critical error, it should never happen as long as the API is used correctly
             throw new Error('One or both nodes of the edge are not present on the graph. This is a critical error');
         }
 
@@ -316,7 +321,7 @@ export class Graph {
         const context_a = this.__nodes.get(a);
 
         if (context_a === undefined) {
-            // a is not in the graph
+            // A is not in the graph
             return undefined;
         }
 
@@ -334,10 +339,10 @@ export class Graph {
      * @param {N} to
      * @returns {Edge<N>|undefined}
      */
-    getAnyDirectedEdge(from, to){
+    getAnyDirectedEdge(from, to) {
         const ctx_a = this.__nodes.get(from);
 
-        if(ctx_a === undefined){
+        if (ctx_a === undefined) {
             return undefined;
         }
 

package/src/core/graph/v2/Graph.spec.js

@@ -1,10 +1,89 @@
-import { Edge } from "../Edge.js";
+import { Edge, EdgeDirectionType } from "../Edge.js";
 import { Graph } from "./Graph.js";
+import { jest } from "@jest/globals";
 
 test("constructor doesn't throw", () => {
     expect(() => new Graph()).not.toThrow();
 });
 
+test("adding same node twice", () => {
+
+    const graph = new Graph();
+
+    expect(graph.addNode(1)).toBe(true);
+    expect(graph.addNode(1)).toBe(false); // node already added
+
+});
+
+test("adding node triggers nodeAdded signal", () => {
+
+    const graph = new Graph();
+
+    const callback = jest.fn();
+
+    graph.on.nodeAdded.add(callback);
+
+    graph.addNode(7);
+
+    expect(callback).toHaveBeenCalledTimes(1);
+    expect(callback).toHaveBeenCalledWith(7, graph);
+
+});
+
+test("removing node triggers nodeRemoved signal", () => {
+
+    const graph = new Graph();
+
+    const callback = jest.fn();
+
+    graph.on.nodeRemoved.add(callback);
+
+    graph.addNode(7);
+
+    expect(callback).not.toHaveBeenCalled();
+
+    graph.removeNode(1); // trying to remove non-existent node
+
+    expect(callback).not.toHaveBeenCalled();
+
+    graph.removeNode(7);
+
+    expect(callback).toHaveBeenCalledTimes(1);
+    expect(callback).toHaveBeenCalledWith(7, graph);
+
+    graph.removeNode(7); //node was already removed, so we expect nothing to happen
+
+    expect(callback).toHaveBeenCalledTimes(1);
+});
+
+test("check node existence", () => {
+
+    const graph = new Graph();
+
+    expect(graph.hasNode(1)).toBe(false);
+
+    graph.addNode(1);
+
+    expect(graph.hasNode(1)).toBe(true);
+
+});
+
+test("removing node that does not exist", () => {
+    const graph = new Graph();
+
+    expect(graph.removeNode(1)).toBe(false);
+
+});
+
+test("removing same node twice", () => {
+    const graph = new Graph();
+
+    graph.addNode(1);
+
+    expect(graph.removeNode(1)).toBe(true);
+    expect(graph.removeNode(1)).toBe(false);
+});
+
 test("nodeCount", () => {
     const g = new Graph();
 
@@ -19,6 +98,122 @@ test("nodeCount", () => {
     expect(g.nodeCount).toBe(0);
 });
 
+test("findNode on empty graph", () => {
+    const graph = new Graph();
+
+    expect(graph.findNode(n => n === 1)).toBe(undefined);
+});
+
+test("findNode that doesn't exist on graph with 1 node", () => {
+    const graph = new Graph();
+
+    graph.addNode(3);
+
+    expect(graph.findNode(n => n === 1)).toBe(undefined);
+});
+
+test("findNode amongst two", () => {
+    const graph = new Graph();
+
+    graph.addNode(1);
+    graph.addNode(3);
+
+    expect(graph.findNode(n => n === 3)).toBe(3);
+});
+
+test("getNodeDegree", () => {
+
+    const graph = new Graph();
+
+    expect(graph.getNodeDegree(1)).toBe(0);
+
+    graph.addNode(1);
+
+    expect(graph.getNodeDegree(1)).toBe(0);
+
+    graph.addNode(3);
+
+    expect(graph.getNodeDegree(1)).toBe(0);
+    expect(graph.getNodeDegree(3)).toBe(0);
+
+    graph.createEdge(1, 3, EdgeDirectionType.Forward);
+
+    expect(graph.getNodeDegree(1)).toBe(1);
+    expect(graph.getNodeDegree(3)).toBe(1);
+});
+
+test("createEdge", () => {
+    const graph = new Graph();
+
+    graph.addNode(1);
+    graph.addNode(2);
+
+    graph.createEdge(1, 2, EdgeDirectionType.Forward);
+
+    expect(graph.edgeCount).toBe(1);
+
+    expect(graph.edgeExistsBetween(1, 2)).toBe(true);
+});
+
+test("adding edge where one of the nodes is not part of the graph should throw and exception", () => {
+    const graph = new Graph();
+
+    expect(() => graph.addEdge(new Edge(1, 2))).toThrow();
+
+    graph.addNode(1);
+
+    expect(() => graph.addEdge(new Edge(1, 2))).toThrow();
+
+    graph.removeNode(1);
+    graph.addNode(2);
+
+    expect(() => graph.addEdge(new Edge(1, 2))).toThrow();
+});
+
+test("add one valid edge", () => {
+
+    const graph = new Graph();
+
+    graph.addNode(1);
+    graph.addNode(2);
+
+    const edge = new Edge(1, 2);
+    expect(graph.addEdge(edge)).toBe(true);
+
+    expect(graph.hasEdge(edge)).toBe(true);
+
+    expect(graph.edgeCount).toBe(1);
+});
+
+test("add same edge twice", () => {
+
+    const graph = new Graph();
+
+    graph.addNode(1);
+    graph.addNode(2);
+
+    const edge = new Edge(1, 2);
+
+    expect(graph.addEdge(edge)).toBe(true);
+    expect(graph.addEdge(edge)).toBe(false); //already exists
+
+    expect(graph.hasEdge(edge)).toBe(true);
+
+    expect(graph.edgeCount).toBe(1);
+});
+
+test("remove non-existing edge", () => {
+
+    const graph = new Graph();
+
+    graph.addNode(1);
+    graph.addNode(2);
+
+    const edge = new Edge(1, 2);
+
+    expect(graph.removeEdge(edge)).toBe(false);
+});
+
 test("edgeCount", () => {
     const g = new Graph();
 
@@ -54,3 +249,116 @@ test("after removing an edge, neighborhood is properly updated", () => {
     expect(g.getAttachedEdges(t, 1)).toBe(0);
     expect(g.getAttachedEdges(t, 2)).toBe(0);
 });
+
+test("edgeExistsBetween", () => {
+    const graph = new Graph();
+
+    expect(graph.edgeExistsBetween(1, 2)).toBe(false);
+    expect(graph.edgeExistsBetween(2, 1)).toBe(false);
+
+    graph.addNode(1);
+
+    expect(graph.edgeExistsBetween(1, 2)).toBe(false);
+    expect(graph.edgeExistsBetween(2, 1)).toBe(false);
+
+    graph.addNode(2);
+
+    expect(graph.edgeExistsBetween(1, 2)).toBe(false);
+    expect(graph.edgeExistsBetween(2, 1)).toBe(false);
+
+    graph.createEdge(1, 2, EdgeDirectionType.Forward);
+
+    expect(graph.edgeExistsBetween(1, 2)).toBe(true);
+    expect(graph.edgeExistsBetween(2, 1)).toBe(true);
+
+});
+
+test("nodeHasEdges", () => {
+    const graph = new Graph();
+
+    expect(graph.nodeHasEdges(1)).toBe(false);
+
+    graph.addNode(1);
+
+    expect(graph.nodeHasEdges(1)).toBe(false);
+
+    graph.addNode(2);
+
+    expect(graph.nodeHasEdges(1)).toBe(false);
+
+    graph.createEdge(1, 2, EdgeDirectionType.Forward);
+
+    expect(graph.nodeHasEdges(1)).toBe(true);
+    expect(graph.nodeHasEdges(2)).toBe(true);
+});
+
+test("getAnyEdgeBetween", () => {
+
+    const graph = new Graph();
+
+    expect(graph.getAnyEdgeBetween(1, 2)).toBe(undefined);
+    expect(graph.getAnyEdgeBetween(2, 1)).toBe(undefined);
+
+    graph.addNode(1);
+
+    expect(graph.getAnyEdgeBetween(1, 2)).toBe(undefined);
+    expect(graph.getAnyEdgeBetween(2, 1)).toBe(undefined);
+
+    graph.addNode(2);
+
+    expect(graph.getAnyEdgeBetween(1, 2)).toBe(undefined);
+    expect(graph.getAnyEdgeBetween(2, 1)).toBe(undefined);
+
+    const edge = graph.createEdge(1, 2, EdgeDirectionType.Forward);
+
+    expect(graph.getAnyEdgeBetween(1, 2)).toBe(edge);
+    expect(graph.getAnyEdgeBetween(2, 1)).toBe(edge);
+});
+
+test("find path from node to itself", () => {
+    const graph = new Graph();
+
+    graph.addNode(1);
+
+    const path = graph.findPath(1, 1);
+
+    expect(path).toEqual([1]);
+});
+
+test("find path with 2 hops", () => {
+    const graph = new Graph();
+
+    graph.addNode(1);
+    graph.addNode(2);
+    graph.addNode(3);
+
+    graph.createEdge(1, 2, EdgeDirectionType.Forward);
+    graph.createEdge(2, 3, EdgeDirectionType.Forward);
+
+    const path = graph.findPath(1, 3);
+
+    expect(path).toEqual([1, 2, 3]);
+});
+
+test("clear method removes all nodes", () => {
+    const graph = new Graph();
+
+    graph.addNode(1);
+
+    graph.clear();
+
+    expect(graph.nodeCount).toBe(0);
+});
+
+test("clear method removes all edges", () => {
+    const graph = new Graph();
+
+    graph.addNode(1);
+    graph.addNode(2);
+
+    graph.createEdge(1, 2, EdgeDirectionType.Forward);
+
+    graph.clear();
+
+    expect(graph.edgeCount).toBe(0);
+});