@woosh/meep-engine 2.110.1 → 2.110.4

package/build/meep.module.js

@@ -97938,71 +97938,89 @@ class ImmutableObjectPool {
     }
 }
 
+/**
+ * Object Pool pattern implementation.
+ * Reuse objects instead of relying on garbage collector. Useful in cases where creating or destroying an object is costly, and objects are relatively short-lived
+ * @template T
+ */
 class ObjectPoolFactory {
     /**
-     * @template T
+     * @private
+     * @type {Array<T>}
+     */
+    pool = [];
+
+    /**
+     * @type {number}
+     */
+    maxSize = 256;
+
+    /**
      * @param {function():T} creator
      * @param {function(T)} destroyer
      * @param {function(T)} resetter
-     * @constructor
      */
-    constructor(creator, destroyer, resetter) {
+    constructor(
+        creator,
+        destroyer = noop,
+        resetter = noop
+    ) {
+
         /**
          * @private
          * @type {function(): T}
          */
         this.creator = creator;
+
         /**
          * @private
          * @type {function(T)}
          */
         this.destroyer = destroyer;
+
         /**
          * @private
          * @type {function(T)}
          */
         this.resetter = resetter;
 
-        /**
-         * @private
-         * @type {Array<T>}
-         */
-        this.pool = [];
-
-        /**
-         * @private
-         * @type {number}
-         */
-        this.maxSize = 256;
     }
 
     /**
      *
      * @returns {T}
      */
-    create() {
-        if (this.pool.length > 0) {
-            const oldInstance = this.pool.pop();
+    get() {
+        const pool = this.pool;
+
+        if (pool.length > 0) {
+
+            const oldInstance = pool.pop();
 
             //reset the object
             this.resetter(oldInstance);
 
             return oldInstance;
+
         } else {
+
             const newInstance = this.creator();
 
             return newInstance;
+
         }
     }
 
     /**
      *
      * @param {T} object
-     * @returns {boolean}
+     * @returns {boolean} true if object was added back to the pool, false if pool was full and object was destroyed instead
      */
     release(object) {
 
-        if (this.pool.length >= this.maxSize) {
+        const pool = this.pool;
+
+        if (pool.length >= this.maxSize) {
             //pool is too large, destroy and discard the object
             if (this.destroyer !== noop) {
                 this.destroyer(object);
@@ -98012,11 +98030,18 @@ class ObjectPoolFactory {
         }
 
         //add it to the pool
-        this.pool.push(object);
+        pool.push(object);
 
         return true;
     }
-}
+}
+
+
+/**
+ * @deprecated use `get` instead
+ * @type {function(): T}
+ */
+ObjectPoolFactory.prototype.create = ObjectPoolFactory.prototype.get;
 
 /**
  * Will invoke A.equals(B) on members if such exists

package/package.json

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

package/src/core/model/object/ObjectPoolFactory.d.ts

@@ -1,12 +1,24 @@
-export class ObjectPoolFactory {
+/**
+ * Object Pool pattern implementation.
+ * Reuse objects instead of relying on garbage collector. Useful in cases where creating or destroying an object is costly, and objects are relatively short-lived
+ * @template T
+ */
+export class ObjectPoolFactory<T> {
     /**
-     * @template T
      * @param {function():T} creator
      * @param {function(T)} destroyer
      * @param {function(T)} resetter
-     * @constructor
      */
-    constructor(creator: () => T, destroyer: (arg0: T) => any, resetter: (arg0: T) => any);
+    constructor(creator: () => T, destroyer?: (arg0: T) => any, resetter?: (arg0: T) => any);
+    /**
+     * @private
+     * @type {Array<T>}
+     */
+    private pool;
+    /**
+     * @type {number}
+     */
+    maxSize: number;
     /**
      * @private
      * @type {function(): T}
@@ -22,26 +34,21 @@ export class ObjectPoolFactory {
      * @type {function(T)}
      */
     private resetter;
-    /**
-     * @private
-     * @type {Array<T>}
-     */
-    private pool;
-    /**
-     * @private
-     * @type {number}
-     */
-    private maxSize;
     /**
      *
      * @returns {T}
      */
-    create(): T;
+    get(): T;
     /**
      *
      * @param {T} object
-     * @returns {boolean}
+     * @returns {boolean} true if object was added back to the pool, false if pool was full and object was destroyed instead
      */
     release(object: T): boolean;
+    /**
+     * @deprecated use `get` instead
+     * @type {function(): T}
+     */
+    create: () => T;
 }
 //# sourceMappingURL=ObjectPoolFactory.d.ts.map

package/src/core/model/object/ObjectPoolFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ObjectPoolFactory.d.ts","sourceRoot":"","sources":["../../../../../src/core/model/object/ObjectPoolFactory.js"],"names":[],"mappings":"AAIA;IACI;;;;;;OAMG;IACH,uFA4BC;IA3BG;;;OAGG;IACH,gBAAsB;IACtB;;;OAGG;IACH,kBAA0B;IAC1B;;;OAGG;IACH,iBAAwB;IAExB;;;OAGG;IACH,aAAc;IAEd;;;OAGG;IACH,gBAAkB;IAGtB;;;OAGG;IACH,YAoBC;IAED;;;;OAIG;IACH,oBAFa,OAAO,CAqBnB;CACJ"}
+{"version":3,"file":"ObjectPoolFactory.d.ts","sourceRoot":"","sources":["../../../../../src/core/model/object/ObjectPoolFactory.js"],"names":[],"mappings":"AAIA;;;;GAIG;AACH;IAYI;;;;OAIG;IACH,2BAJsB,CAAC,qBACH,CAAC,4BACD,CAAC,UA6BpB;IA3CD;;;OAGG;IACH,aAAU;IAEV;;OAEG;IACH,SAFU,MAAM,CAEF;IAgBV;;;OAGG;IACH,gBAAsB;IAEtB;;;OAGG;IACH,kBAA0B;IAE1B;;;OAGG;IACH,iBAAwB;IAI5B;;;OAGG;IACH,OAFa,CAAC,CA2Bb;IAED;;;;OAIG;IACH,gBAHW,CAAC,GACC,OAAO,CAuBnB;IAIL;;;OAGG;IACH,cAFsB,CAAC,CAEW;CAPjC"}

package/src/core/model/object/ObjectPoolFactory.js

@@ -2,51 +2,67 @@ import { assert } from "../../assert.js";
 
 import { noop } from "../../function/noop.js";
 
+/**
+ * Object Pool pattern implementation.
+ * Reuse objects instead of relying on garbage collector. Useful in cases where creating or destroying an object is costly, and objects are relatively short-lived
+ * @template T
+ */
 export class ObjectPoolFactory {
     /**
-     * @template T
+     * @private
+     * @type {Array<T>}
+     */
+    pool = [];
+
+    /**
+     * @type {number}
+     */
+    maxSize = 256;
+
+    /**
      * @param {function():T} creator
      * @param {function(T)} destroyer
      * @param {function(T)} resetter
-     * @constructor
      */
-    constructor(creator, destroyer, resetter) {
+    constructor(
+        creator,
+        destroyer = noop,
+        resetter = noop
+    ) {
+        assert.isFunction(creator, 'creator');
+        assert.isFunction(destroyer, 'destroyer');
+        assert.isFunction(resetter, 'resetter');
+
         /**
          * @private
          * @type {function(): T}
          */
         this.creator = creator;
+
         /**
          * @private
          * @type {function(T)}
          */
         this.destroyer = destroyer;
+
         /**
          * @private
          * @type {function(T)}
          */
         this.resetter = resetter;
 
-        /**
-         * @private
-         * @type {Array<T>}
-         */
-        this.pool = [];
-
-        /**
-         * @private
-         * @type {number}
-         */
-        this.maxSize = 256;
     }
 
     /**
      *
      * @returns {T}
      */
-    create() {
-        if (this.pool.length > 0) {
-            const oldInstance = this.pool.pop();
+    get() {
+        const pool = this.pool;
+
+        if (pool.length > 0) {
+
+            const oldInstance = pool.pop();
 
             //reset the object
             this.resetter(oldInstance);
@@ -55,29 +71,33 @@ export class ObjectPoolFactory {
             assert.defined(oldInstance, 'oldInstance');
 
             return oldInstance;
+
         } else {
-            const newInstance = this.creator();
 
+            const newInstance = this.creator();
 
             assert.notNull(newInstance, 'newInstance');
             assert.defined(newInstance, 'newInstance');
 
             return newInstance;
+
         }
     }
 
     /**
      *
      * @param {T} object
-     * @returns {boolean}
+     * @returns {boolean} true if object was added back to the pool, false if pool was full and object was destroyed instead
      */
     release(object) {
         assert.notNull(object, 'object');
         assert.defined(object, 'object');
 
-        assert.arrayHasNo(this.pool, object, `Pool already contains object that is being attempted to be release`);
+        const pool = this.pool;
 
-        if (this.pool.length >= this.maxSize) {
+        assert.arrayHasNo(pool, object, `Pool already contains object that is being attempted to be release`);
+
+        if (pool.length >= this.maxSize) {
             //pool is too large, destroy and discard the object
             if (this.destroyer !== noop) {
                 this.destroyer(object);
@@ -87,8 +107,15 @@ export class ObjectPoolFactory {
         }
 
         //add it to the pool
-        this.pool.push(object);
+        pool.push(object);
 
         return true;
     }
 }
+
+
+/**
+ * @deprecated use `get` instead
+ * @type {function(): T}
+ */
+ObjectPoolFactory.prototype.create = ObjectPoolFactory.prototype.get

package/src/engine/ecs/ik/IKProblem.d.ts

@@ -16,6 +16,7 @@ export class IKProblem {
     terrain: Terrain;
 }
 export namespace IKProblem {
-    let pool: any;
+    let pool: ObjectPoolFactory<IKProblem>;
 }
+import { ObjectPoolFactory } from "../../../core/model/object/ObjectPoolFactory.js";
 //# sourceMappingURL=IKProblem.d.ts.map

package/src/engine/ecs/ik/IKProblem.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"IKProblem.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/ik/IKProblem.js"],"names":[],"mappings":"AAGA;IAEI;;;OAGG;IACH,yBAAkB;IAClB;;;OAGG;IACH,mBAAgB;IAChB;;;OAGG;IACH,iBAAe;CAElB"}
+{"version":3,"file":"IKProblem.d.ts","sourceRoot":"","sources":["../../../../../src/engine/ecs/ik/IKProblem.js"],"names":[],"mappings":"AAGA;IAEI;;;OAGG;IACH,yBAAkB;IAClB;;;OAGG;IACH,mBAAgB;IAChB;;;OAGG;IACH,iBAAe;CAElB;;cAIS,kBAAkB,SAAS,CAAC;;kCAxBJ,iDAAiD"}

package/src/engine/simulation/Ticker.d.ts

@@ -11,4 +11,13 @@ export default class Ticker {
 
     resume(): void
 
+    /**
+     * @deprecated
+     */
+    subscribe(callback: Function, thisArg?: any): void
+
+    /**
+     * @deprecated
+     */
+    unsubscribe(callback: Function, thisArg?: any): void
 }

package/src/core/model/object/SimpleObjectPoolFactory.d.ts

@@ -1,25 +0,0 @@
-/**
- * @template T
- */
-export class SimpleObjectPoolFactory<T> {
-    /**
-     * @template T
-     * @param {Function|Class<T>} type
-     * @param {number} size
-     */
-    constructor({ type, size }: Function | Class<T_1>);
-    Type: any;
-    /**
-     * @private
-     * @type {T}
-     */
-    private pool;
-    /**
-     * @private
-     * @type {number}
-     */
-    private maxSize;
-    get(): any;
-    release(o: any): void;
-}
-//# sourceMappingURL=SimpleObjectPoolFactory.d.ts.map

package/src/core/model/object/SimpleObjectPoolFactory.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"SimpleObjectPoolFactory.d.ts","sourceRoot":"","sources":["../../../../../src/core/model/object/SimpleObjectPoolFactory.js"],"names":[],"mappings":"AAAA;;GAEG;AACH;IACI;;;;OAIG;IACH,4BAHW,qBAAiB,EAkB3B;IAbG,UAAgB;IAEhB;;;OAGG;IACH,aAAc;IAEd;;;OAGG;IACH,gBAAmB;IAGvB,WAMC;IAED,sBAMC;CACJ"}

package/src/core/model/object/SimpleObjectPoolFactory.js

@@ -1,42 +0,0 @@
-/**
- * @template T
- */
-export class SimpleObjectPoolFactory {
-    /**
-     * @template T
-     * @param {Function|Class<T>} type
-     * @param {number} size
-     */
-    constructor({ type, size = 256 }) {
-
-        this.Type = type;
-
-        /**
-         * @private
-         * @type {T}
-         */
-        this.pool = [];
-
-        /**
-         * @private
-         * @type {number}
-         */
-        this.maxSize = size;
-    }
-
-    get() {
-        if (this.pool.length > 0) {
-            return this.pool.pop();
-        } else {
-            return new this.Type();
-        }
-    }
-
-    release(o) {
-        if (this.pool.length < this.maxSize) {
-            this.pool.push(o);
-        } else {
-            // do nothing, just skip
-        }
-    }
-}