@woosh/meep-engine 2.100.2 → 2.101.0

package/src/engine/graphics/FrameRunner.js

@@ -1,9 +1,25 @@
+/**
+ *
+ * @type {number}
+ */
 let global_count = 0;
 
 /**
- *
+ * Fires a given function every frame. Typical usage is to create an instance, invoke {@link #startup} and once no longer required - invoke {@link #shutdown}
+ * Wraps {@link requestAnimationFrame}
  */
 export class FrameRunner {
+    /**
+     *
+     * @type {boolean}
+     */
+    #running = false;
+    /**
+     *
+     * @type {number}
+     */
+    #animationFrameId = -1;
+
     /**
      *
      * @param {function} action
@@ -14,66 +30,56 @@ export class FrameRunner {
          * @type {Function}
          */
         this.action = action;
-        /**
-         *
-         * @type {boolean}
-         */
-        this.running = false;
-        /**
-         *
-         * @type {number}
-         */
-        this.animationFrameId = -1;
     }
 
     /**
-     *
+     * Begins animation loop. Does nothing and returns false if already running.
      * @returns {boolean}
      */
     startup() {
-        if (this.running) {
+        if (this.#running) {
             return false;
         }
 
-        console.warn(`FrameFunner.started[${global_count}]`);
+        // console.warn(`FrameFunner.started[${global_count}]`);
 
         global_count++;
 
-        this.running = true;
+        this.#running = true;
 
         const cycle = () => {
-            if (!this.running) {
+            if (!this.#running) {
                 //not supposed to be running, bail
                 return;
             }
 
             this.action();
 
-            this.animationFrameId = requestAnimationFrame(cycle);
+            this.#animationFrameId = requestAnimationFrame(cycle);
         }
 
-        this.animationFrameId = requestAnimationFrame(cycle);
+        this.#animationFrameId = requestAnimationFrame(cycle);
 
         return true;
     }
 
     /**
-     *
+     * Stops animation loop. Does nothing and returns false if not currently running.
      * @returns {boolean}
      */
     shutdown() {
-        if (!this.running) {
+        if (!this.#running) {
             return false;
         }
 
         global_count--;
 
-        console.warn(`FrameFunner.stopped[${global_count}]`);
+        // console.warn(`FrameFunner.stopped[${global_count}]`);
 
-        this.running = false;
-        cancelAnimationFrame(this.animationFrameId);
+        this.#running = false;
+        cancelAnimationFrame(this.#animationFrameId);
 
-        this.animationFrameId = -1;
+        this.#animationFrameId = -1;
 
         return true;
     }
@@ -83,6 +89,6 @@ export class FrameRunner {
      * @returns {boolean}
      */
     isRunning() {
-        return this.running;
+        return this.#running;
     }
 }

package/src/engine/graphics/texture/sampler/HarmonicDiffusionGrid.d.ts

@@ -22,7 +22,7 @@ export class HarmonicDiffusionGrid {
      */
     height: number;
     /**
-     * Maps which indices are assigned with values
+     * Maps which indices are assigned with values. Assigned cells retain their original values
      * @type {BitSet}
      */
     assignment: BitSet;

package/src/engine/graphics/texture/sampler/HarmonicDiffusionGrid.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HarmonicDiffusionGrid.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/texture/sampler/HarmonicDiffusionGrid.js"],"names":[],"mappings":"AAGA;IACI;;;;;OAKG;IACH,kBAJW,MAAM,EAAE,GAAC,YAAY,GAAC,YAAY,SAClC,MAAM,UACN,MAAM,EA6BhB;IArBG;;;OAGG;IACH,MAFU,MAAM,EAAE,GAAC,YAAY,GAAC,YAAY,CAE5B;IAChB;;;OAGG;IACH,OAFU,MAAM,CAEE;IAClB;;;OAGG;IACH,QAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,YAFU,MAAM,CAEc;IAGlC;;OAEG;IACH,cAGC;IAED;;;;;OAKG;IACH,UAJW,MAAM,KACN,MAAM,SACN,MAAM,QAyBhB;IAED;;OAEG;IACH,aA8DC;CACJ;uBAhJsB,mCAAmC"}
+{"version":3,"file":"HarmonicDiffusionGrid.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/texture/sampler/HarmonicDiffusionGrid.js"],"names":[],"mappings":"AAGA;IACI;;;;;OAKG;IACH,kBAJW,MAAM,EAAE,GAAC,YAAY,GAAC,YAAY,SAClC,MAAM,UACN,MAAM,EA6BhB;IArBG;;;OAGG;IACH,MAFU,MAAM,EAAE,GAAC,YAAY,GAAC,YAAY,CAE5B;IAChB;;;OAGG;IACH,OAFU,MAAM,CAEE;IAClB;;;OAGG;IACH,QAFU,MAAM,CAEI;IAEpB;;;OAGG;IACH,YAFU,MAAM,CAEc;IAGlC;;OAEG;IACH,cAGC;IAED;;;;;OAKG;IACH,UAJW,MAAM,KACN,MAAM,SACN,MAAM,QAyBhB;IAED;;OAEG;IACH,aA8DC;CACJ;uBA/IsB,mCAAmC"}

package/src/engine/graphics/texture/sampler/HarmonicDiffusionGrid.js

@@ -1,5 +1,5 @@
-import { BitSet } from "../../../../core/binary/BitSet.js";
 import { assert } from "../../../../core/assert.js";
+import { BitSet } from "../../../../core/binary/BitSet.js";
 
 export class HarmonicDiffusionGrid {
     /**
@@ -9,8 +9,8 @@ export class HarmonicDiffusionGrid {
      * @param {number} height
      */
     constructor(data, width, height) {
-        assert.typeOf(width, 'number', 'width');
-        assert.typeOf(height, 'number', 'height');
+        assert.isNonNegativeInteger(width, 'width');
+        assert.isNonNegativeInteger(height, 'height');
 
         assert.equal(data.length, width * height, `data.length(=${data.length}) is not equal to product of width(=${width})*height(=${height})`);
 
@@ -31,7 +31,7 @@ export class HarmonicDiffusionGrid {
         this.height = height;
 
         /**
-         * Maps which indices are assigned with values
+         * Maps which indices are assigned with values. Assigned cells retain their original values
          * @type {BitSet}
          */
         this.assignment = new BitSet();

package/src/engine/graphics/texture/sampler/Sampler2D2Canvas.d.ts

@@ -5,9 +5,8 @@ export default convertSampler2D2Canvas;
  * @param {Number} [scale]
  * @param {Number} [offset]
  * @param {HTMLCanvasElement} [canvas] if no canvas is supplied, a new one will be created
- * @param {function(index:int, array:ArrayLike<number>, x:int, y:int)} [fillDD] allows you to supply mapping function, if none is given - one will be created from sampler
  * @returns {HTMLCanvasElement} canvas
  */
-declare function convertSampler2D2Canvas(sampler: Sampler2D, scale?: number, offset?: number, canvas?: HTMLCanvasElement, fillDD: any): HTMLCanvasElement;
+declare function convertSampler2D2Canvas(sampler: Sampler2D, scale?: number, offset?: number, canvas?: HTMLCanvasElement): HTMLCanvasElement;
 import { Sampler2D } from "./Sampler2D.js";
 //# sourceMappingURL=Sampler2D2Canvas.d.ts.map

package/src/engine/graphics/texture/sampler/Sampler2D2Canvas.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Sampler2D2Canvas.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/texture/sampler/Sampler2D2Canvas.js"],"names":[],"mappings":";AAQA;;;;;;;;GAQG;AACH,kDAPW,SAAS,4CAGT,iBAAiB,gBAEf,iBAAiB,CA2E7B;0BArFyB,gBAAgB"}
+{"version":3,"file":"Sampler2D2Canvas.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/texture/sampler/Sampler2D2Canvas.js"],"names":[],"mappings":";AAQA;;;;;;;GAOG;AACH,kDANW,SAAS,4CAGT,iBAAiB,GACf,iBAAiB,CA2E7B;0BApFyB,gBAAgB"}

package/src/engine/graphics/texture/sampler/Sampler2D2Canvas.js

@@ -12,10 +12,9 @@ import { sampler2d_write_to_canvas_raw } from "./sampler2d_write_to_canvas_raw.j
  * @param {Number} [scale]
  * @param {Number} [offset]
  * @param {HTMLCanvasElement} [canvas] if no canvas is supplied, a new one will be created
- * @param {function(index:int, array:ArrayLike<number>, x:int, y:int)} [fillDD] allows you to supply mapping function, if none is given - one will be created from sampler
  * @returns {HTMLCanvasElement} canvas
  */
-function convertSampler2D2Canvas(sampler, scale = 255, offset = 0, canvas, fillDD) {
+function convertSampler2D2Canvas(sampler, scale = 255, offset = 0, canvas) {
     const source_data = sampler.data;
 
     //generate canvas

package/src/engine/graphics/texture/sampler/sampler2d_to_uint8_RGBA.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"sampler2d_to_uint8_RGBA.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/texture/sampler/sampler2d_to_uint8_RGBA.js"],"names":[],"mappings":"AAsCA;;;;GAIG;AACH,mFAqDC"}
+{"version":3,"file":"sampler2d_to_uint8_RGBA.d.ts","sourceRoot":"","sources":["../../../../../../src/engine/graphics/texture/sampler/sampler2d_to_uint8_RGBA.js"],"names":[],"mappings":"AAsCA;;;;GAIG;AACH,mFA6DC"}

package/src/engine/graphics/texture/sampler/sampler2d_to_uint8_RGBA.js

@@ -65,6 +65,8 @@ export function sampler2d_to_uint8_RGBA(output, input) {
 
     if (source_item_size === 1) {
 
+        // grayscale
+
         sampler2d_channel_linear_transform(output, input, 0, 0, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 1, 0, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 2, 0, gradient, intercept);
@@ -73,6 +75,8 @@ export function sampler2d_to_uint8_RGBA(output, input) {
 
     } else if (source_item_size === 2) {
 
+        // grayscale with alpha
+
         sampler2d_channel_linear_transform(output, input, 0, 0, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 1, 0, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 2, 0, gradient, intercept);
@@ -80,6 +84,8 @@ export function sampler2d_to_uint8_RGBA(output, input) {
 
     } else if (source_item_size === 3) {
 
+        // RGB
+
         sampler2d_channel_linear_transform(output, input, 0, 0, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 1, 1, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 2, 2, gradient, intercept);
@@ -88,6 +94,8 @@ export function sampler2d_to_uint8_RGBA(output, input) {
 
     } else if (source_item_size === 4) {
 
+        // RGBA
+
         sampler2d_channel_linear_transform(output, input, 0, 0, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 1, 1, gradient, intercept);
         sampler2d_channel_linear_transform(output, input, 2, 2, gradient, intercept);