@woosh/meep-engine 2.120.2 → 2.120.3

package/README.md

@@ -13,7 +13,7 @@ To help get you started, various samples are provided under `/samples` folder. F
 
 ## Quality
 
-Meep is covered by 2,458 unit tests
+Meep is covered by 2,508 unit tests
 
 The aim is not to have 100% coverage, [but to ensure quality](https://about.codecov.io/blog/the-case-against-100-code-coverage/). As a result, the tests are written to cover complex code first and to exhaustively validate critical algorithms.
 Most of the test code is significantly larger than the code that is being tested.

package/editor/process/symbolic/makeGridPositionSymbolDisplay.js

@@ -7,7 +7,8 @@ import { ProcessState } from "../../../src/core/process/ProcessState.js";
 import Task from "../../../src/core/process/task/Task.js";
 import { TaskSignal } from "../../../src/core/process/task/TaskSignal.js";
 import Entity from "../../../src/engine/ecs/Entity.js";
-import { EventType } from "../../../src/engine/ecs/EntityManager.js";
+
+import { EventType } from "../../../src/engine/ecs/EventType.js";
 import Renderable from "../../../src/engine/ecs/renderable/Renderable.js";
 import { obtainTerrain } from "../../../src/engine/ecs/terrain/util/obtainTerrain.js";
 import { Transform } from "../../../src/engine/ecs/transform/Transform.js";

package/editor/view/ecs/EntityEditor.js

@@ -1,7 +1,8 @@
 import List from '../../../src/core/collection/list/List.js';
 import ObservedValue from '../../../src/core/model/ObservedValue.js';
 import { isDefined } from "../../../src/core/process/matcher/isDefined.js";
-import { EntityManager, EventType } from "../../../src/engine/ecs/EntityManager.js";
+import { EntityManager } from "../../../src/engine/ecs/EntityManager.js";
+import { EventType } from "../../../src/engine/ecs/EventType.js";
 import LabelView from '../../../src/view/common/LabelView.js';
 import dom from "../../../src/view/DOM.js";
 import ButtonView from '../../../src/view/elements/button/ButtonView.js';

package/editor/view/makeEntityDecorators.js

@@ -1,12 +1,12 @@
 import { Tag } from "../../src/engine/ecs/components/Tag.js";
-import EmptyView from "../../src/view/elements/EmptyView.js";
-import LabelView from "../../src/view/common/LabelView.js";
+import { EventType } from "../../src/engine/ecs/EventType.js";
+import { Camera } from "../../src/engine/graphics/ecs/camera/Camera.js";
+import { Light } from "../../src/engine/graphics/ecs/light/Light.js";
 import Mesh from "../../src/engine/graphics/ecs/mesh/Mesh.js";
 import { ParticleEmitter } from "../../src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.js";
-import { Light } from "../../src/engine/graphics/ecs/light/Light.js";
-import { Camera } from "../../src/engine/graphics/ecs/camera/Camera.js";
+import LabelView from "../../src/view/common/LabelView.js";
+import EmptyView from "../../src/view/elements/EmptyView.js";
 import ImageView from "../../src/view/elements/image/ImageView.js";
-import { EventType } from "../../src/engine/ecs/EntityManager.js";
 
 /**
  *

package/package.json

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

package/src/core/binary/BitSet.d.ts

@@ -1,3 +1,7 @@
+/**
+ * A dynamically resizable bitset (bit array) implementation.
+ * The bitset automatically grows and shrinks as bits are set and cleared.
+ */
 export class BitSet {
     /**
      *
@@ -6,19 +10,19 @@ export class BitSet {
      */
     static fixedSize(x: number): BitSet;
     /**
-     * Dynamically sized bit field
      * @constructor
      * @param {number} [initial_capacity]
      */
     constructor(initial_capacity?: number);
     /**
-     * Number of bits currently in use
+     * Number of bits currently in use (highest set bit + 1).
      * @private
      * @type {number}
      */
     private __length;
     /**
      * Current capacity in bits, this is at least equal to length
+     * Always a multiple of 32.
      * @private
      * @type {number}
      */
@@ -30,90 +34,107 @@ export class BitSet {
      */
     private __data_uint32;
     /**
+     * The fraction of capacity at which to trigger a shrink operation.
      * @type {number}
      */
     __shrinkFactor: number;
+    /**
+     * Prevents the BitSet from shrinking automatically.
+     * Useful for fixed-size bitsets.
+     * @returns {void}
+     */
     preventShrink(): void;
     /**
      *
-     * @param {number} x
+     * @param {number} x The new shrink factor (must be between 0 and 1, inclusive of 0, exclusive of 1).
      */
     setShrinkFactor(x: number): void;
     /**
-     *
-     * @param {number} bit_count
+     * Sets the capacity of the bitset, ensuring enough space.
+     * Does NOT change set bits.
+     * @param {number} bit_count The new capacity, in bits.
+     * @throws {Error} If the requested capacity is smaller than the current {@link size}.
+     * @returns {void}
      */
     setCapacity(bit_count: number): void;
     /**
-     * Number of bits currently used for flags.
-     * @returns {number}
+     * Returns the number of bits currently "used" by the BitSet.
+     * This is equivalent to the index of the highest set bit plus one.
+     * @returns {number} The size of the BitSet (in bits).
      */
     size(): number;
     /**
-     * Number of bits reserved for the field, note that not all of these bits are typically being used.
-     * @returns {number}
+     * Returns the current capacity (allocated bits) of the BitSet.
+     * This is always a multiple of 32.
+     * @returns {number} The capacity of the BitSet (in bits).
      */
     capacity(): number;
     /**
-     *
-     * @param {int} bitCapacity
+     * Resizes the internal Uint32Array to the specified capacity.
+     * @param {number} bitCapacity New capacity in bits.
      * @private
      */
     private __resize;
-    __updateLength(): void;
     /**
-     *
-     * @param {int} new_length
+     * Updates the internal length of the bitset after clearing bits.
+     * @private
+     */
+    private __updateLength;
+    /**
+     * Sets the internal length of the BitSet and manages capacity.
+     * Grows or shrinks if necessary
+     * @param {number} new_length The new length of the BitSet.
      * @private
      */
     private __setLength;
     /**
      * Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index
-     * @param {int} fromIndex
-     * @returns {int} Index of previous set bit, or -1 if no set bit found
+     * @param {number} from_index The index to start searching from (inclusive).
+     * @returns {number} Index of previous set bit, or -1 if no set bit found
      */
-    previousSetBit(fromIndex: int): int;
+    previousSetBit(from_index: number): number;
     /**
      * Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
-     * @param {int} fromIndex
+     * @param {number} from_index The index to start searching from (inclusive).
      * @returns {number} index of the next set bit, or -1 if no bits are set beyond supplied index
      */
-    nextSetBit(fromIndex: int): number;
+    nextSetBit(from_index: number): number;
     /**
      * Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
-     * @param {int} fromIndex
-     * @returns {number}
+     * @param {number} from_index The index to start searching from (inclusive).
+     * @returns {number} Index of the next clear bit (bit set to false), or the current length of BitSet if all the bits are set.
      */
-    nextClearBit(fromIndex: int): number;
+    nextClearBit(from_index: number): number;
     /**
-     *
-     * @param {int} bit_index
-     * @param {boolean} value
+     * Sets the bit at the specified index to the specified value.
+     * @param {number} bit_index The index of the bit to set.
+     * @param {boolean} value The value to set the bit to (true for 1, false for 0).
+     * @returns {void}
      */
-    set(bit_index: int, value: boolean): void;
+    set(bit_index: number, value: boolean): void;
     /**
-     * Sets the bit specified by the index to false.
-     * @param {int} bitIndex
+     * Sets the bit specified by the index to false (0).
+     * @param {number} bit_index The index of the bit to clear.
      */
-    clear(bitIndex: int): void;
+    clear(bit_index: number): void;
     /**
      * Set all bits in a given range
-     * @param {number} startIndex first bit to be set
-     * @param {number} endIndex last bit to be set
+     * @param {number} start_index first bit to be set (inclusive)
+     * @param {number} end_index last bit to be set (inclusive)
      */
-    setRange(startIndex: number, endIndex: number): void;
+    setRange(start_index: number, end_index: number): void;
     /**
      * Clears bit values in a given (inclusive) range
-     * @param {number} startIndex first bit to be cleared
-     * @param {number} endIndex clear up to here, excluding this position
+     * @param {number} start_index first bit to be cleared (inclusive)
+     * @param {number} end_index clear up to here, excluding this position
      */
-    clearRange(startIndex: number, endIndex: number): void;
+    clearRange(start_index: number, end_index: number): void;
     /**
      * Returns the value of the bit with the specified index.
-     * @param {int} bitIndex
-     * @returns {boolean}
+     * @param {int} bit_index The index of the bit to get.
+     * @returns {boolean} The value of the bit (true for 1, false for 0).  Returns `false` if `bitIndex` is out of bounds.
      */
-    get(bitIndex: int): boolean;
+    get(bit_index: int): boolean;
     /**
      * Set a bit at the specified index and return its previous value
      * @param {number} index

package/src/core/binary/BitSet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BitSet.d.ts","sourceRoot":"","sources":["../../../../src/core/binary/BitSet.js"],"names":[],"mappings":"AAgCA;IAiiBI;;;;OAIG;IACH,oBAHW,MAAM,GACJ,MAAM,CAQlB;IA3iBD;;;;OAIG;IACH,+BAFW,MAAM,EA8BhB;IAzBG;;;;OAIG;IACH,iBAAiB;IAEjB;;;;OAIG;IACH,mBAA4C;IAE5C;;;;OAIG;IACH,sBAA0D;IAE1D;;OAEG;IACH,gBAFU,MAAM,CAE2B;IAG/C,sBAEC;IAED;;;OAGG;IACH,mBAFW,MAAM,QAOhB;IAED;;;OAGG;IACH,uBAFW,MAAM,QAUhB;IAED;;;OAGG;IACH,QAFa,MAAM,CAIlB;IAED;;;OAGG;IACH,YAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,iBAsBC;IAED,uBAMC;IAED;;;;OAIG;IACH,oBAyBC;IAED;;;;OAIG;IACH,0BAHW,GAAG,GACD,GAAG,CAuCf;IAED;;;;OAIG;IACH,sBAHW,GAAG,GACD,MAAM,CAuDlB;IAED;;;;OAIG;IACH,wBAHW,GAAG,GACD,MAAM,CAkDlB;IAED;;;;OAIG;IACH,eAHW,GAAG,SACH,OAAO,QAmCjB;IAED;;;OAGG;IACH,gBAFW,GAAG,QAIb;IAED;;;;OAIG;IACH,qBAHW,MAAM,YACN,MAAM,QAWhB;IAED;;;;OAIG;IACH,uBAHW,MAAM,YACN,MAAM,QAShB;IAED;;;;OAIG;IACH,cAHW,GAAG,GACD,OAAO,CAkBnB;IAED;;;;OAIG;IACH,iBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;;;OAIG;IACH,mBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,eACN,MAAM,aACN,MAAM,QAShB;IAED;;;;;OAKG;IACH,qBAJW,MAAM,eACN,MAAM,aACN,MAAM,QAShB;IAED;;;;;OAKG;IACH,gBAJW,MAAM,eACN,MAAM,aACN,MAAM,QAQhB;IAED;;OAEG;IACH,cAgBC;IAED;;;OAGG;IACH,YAFW,MAAM,QAoChB;CAcJ"}
+{"version":3,"file":"BitSet.d.ts","sourceRoot":"","sources":["../../../../src/core/binary/BitSet.js"],"names":[],"mappings":"AAgCA;;;GAGG;AACH;IAkjBI;;;;OAIG;IACH,oBAHW,MAAM,GACJ,MAAM,CAQlB;IA3jBD;;;OAGG;IACH,+BAFW,MAAM,EAgChB;IA3BG;;;;OAIG;IACH,iBAAiB;IAEjB;;;;;OAKG;IACH,mBAA4C;IAE5C;;;;OAIG;IACH,sBAA0D;IAE1D;;;OAGG;IACH,gBAFU,MAAM,CAE2B;IAG/C;;;;OAIG;IACH,iBAFa,IAAI,CAIhB;IAED;;;OAGG;IACH,mBAFW,MAAM,QAOhB;IACD;;;;;;OAMG;IACH,uBAJW,MAAM,GAEJ,IAAI,CAUhB;IAED;;;;OAIG;IACH,QAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,YAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,iBAsBC;IAED;;;OAGG;IACH,uBAMC;IAED;;;;;OAKG;IACH,oBAyBC;IAED;;;;OAIG;IACH,2BAHW,MAAM,GACJ,MAAM,CAuClB;IAED;;;;OAIG;IACH,uBAHW,MAAM,GACJ,MAAM,CAuDlB;IAED;;;;OAIG;IACH,yBAHW,MAAM,GACJ,MAAM,CAkDlB;IAED;;;;;OAKG;IACH,eAJW,MAAM,SACN,OAAO,GACL,IAAI,CAmChB;IAED;;;OAGG;IACH,iBAFW,MAAM,QAIhB;IAED;;;;OAIG;IACH,sBAHW,MAAM,aACN,MAAM,QAWhB;IAED;;;;OAIG;IACH,wBAHW,MAAM,aACN,MAAM,QAShB;IAED;;;;OAIG;IACH,eAHW,GAAG,GACD,OAAO,CAkBnB;IAED;;;;OAIG;IACH,iBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;;;OAIG;IACH,mBAHW,MAAM,GACJ,OAAO,CAUnB;IAED;;;;;OAKG;IACH,sBAJW,MAAM,eACN,MAAM,aACN,MAAM,QAShB;IAED;;;;;OAKG;IACH,qBAJW,MAAM,eACN,MAAM,aACN,MAAM,QAShB;IAED;;;;;OAKG;IACH,gBAJW,MAAM,eACN,MAAM,aACN,MAAM,QAQhB;IAED;;OAEG;IACH,cAgBC;IAED;;;OAGG;IACH,YAFW,MAAM,QAoChB;CAcJ"}

package/src/core/binary/BitSet.js

@@ -30,9 +30,13 @@ const RESIZE_COUNT_THRESHOLD = 128;
  */
 const DEFAULT_INITIAL_CAPACITY = 64;
 
+/**
+ * A dynamically resizable bitset (bit array) implementation.
+ * The bitset automatically grows and shrinks as bits are set and cleared.
+ */
 export class BitSet {
+
     /**
-     * Dynamically sized bit field
      * @constructor
      * @param {number} [initial_capacity]
      */
@@ -40,7 +44,7 @@ export class BitSet {
         assert.isNonNegativeInteger(initial_capacity, 'initial_capacity');
 
         /**
-         * Number of bits currently in use
+         * Number of bits currently in use (highest set bit + 1).
          * @private
          * @type {number}
          */
@@ -48,6 +52,7 @@ export class BitSet {
 
         /**
          * Current capacity in bits, this is at least equal to length
+         * Always a multiple of 32.
          * @private
          * @type {number}
          */
@@ -61,18 +66,24 @@ export class BitSet {
         this.__data_uint32 = new Uint32Array(this.__capacity >> 5);
 
         /**
+         * The fraction of capacity at which to trigger a shrink operation.
          * @type {number}
          */
         this.__shrinkFactor = DEFAULT_SHRINK_FACTOR;
     }
 
+    /**
+     * Prevents the BitSet from shrinking automatically.
+     * Useful for fixed-size bitsets.
+     * @returns {void}
+     */
     preventShrink() {
         this.setShrinkFactor(0);
     }
 
     /**
      *
-     * @param {number} x
+     * @param {number} x The new shrink factor (must be between 0 and 1, inclusive of 0, exclusive of 1).
      */
     setShrinkFactor(x) {
         assert.greaterThanOrEqual(x, 0, 'x >= 0');
@@ -80,10 +91,12 @@ export class BitSet {
 
         this.__shrinkFactor = x;
     }
-
     /**
-     *
-     * @param {number} bit_count
+     * Sets the capacity of the bitset, ensuring enough space.
+     * Does NOT change set bits.
+     * @param {number} bit_count The new capacity, in bits.
+     * @throws {Error} If the requested capacity is smaller than the current {@link size}.
+     * @returns {void}
      */
     setCapacity(bit_count) {
         assert.isNonNegativeInteger(bit_count, "bit_count");
@@ -96,24 +109,26 @@ export class BitSet {
     }
 
     /**
-     * Number of bits currently used for flags.
-     * @returns {number}
+     * Returns the number of bits currently "used" by the BitSet.
+     * This is equivalent to the index of the highest set bit plus one.
+     * @returns {number} The size of the BitSet (in bits).
      */
     size() {
         return this.__length;
     }
 
     /**
-     * Number of bits reserved for the field, note that not all of these bits are typically being used.
-     * @returns {number}
+     * Returns the current capacity (allocated bits) of the BitSet.
+     * This is always a multiple of 32.
+     * @returns {number} The capacity of the BitSet (in bits).
      */
     capacity() {
         return this.__capacity;
     }
 
     /**
-     *
-     * @param {int} bitCapacity
+     * Resizes the internal Uint32Array to the specified capacity.
+     * @param {number} bitCapacity New capacity in bits.
      * @private
      */
     __resize(bitCapacity) {
@@ -140,6 +155,10 @@ export class BitSet {
         this.__capacity = uint32_capacity * 32;
     }
 
+    /**
+     * Updates the internal length of the bitset after clearing bits.
+     * @private
+     */
     __updateLength() {
         const found_length = this.previousSetBit(this.__length) + 1;
 
@@ -149,8 +168,9 @@ export class BitSet {
     }
 
     /**
-     *
-     * @param {int} new_length
+     * Sets the internal length of the BitSet and manages capacity.
+     * Grows or shrinks if necessary
+     * @param {number} new_length The new length of the BitSet.
      * @private
      */
     __setLength(new_length) {
@@ -182,13 +202,13 @@ export class BitSet {
 
     /**
      * Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index
-     * @param {int} fromIndex
-     * @returns {int} Index of previous set bit, or -1 if no set bit found
+     * @param {number} from_index The index to start searching from (inclusive).
+     * @returns {number} Index of previous set bit, or -1 if no set bit found
      */
-    previousSetBit(fromIndex) {
-        assert.isNonNegativeInteger(fromIndex, `fromIndex`);
+    previousSetBit(from_index) {
+        assert.isNonNegativeInteger(from_index, `fromIndex`);
 
-        const index = min2(fromIndex, this.__length - 1);
+        const index = min2(from_index, this.__length - 1);
 
         let word_index = index >> 5;
         let bit_index = index & 31; // modulo operation is slow, bitwise and is fast, this is the same as %8
@@ -226,26 +246,26 @@ export class BitSet {
 
     /**
      * Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
-     * @param {int} fromIndex
+     * @param {number} from_index The index to start searching from (inclusive).
      * @returns {number} index of the next set bit, or -1 if no bits are set beyond supplied index
      */
-    nextSetBit(fromIndex) {
+    nextSetBit(from_index) {
         // assert.ok(fromIndex >= 0, `fromIndex must be greater or equal to 0, instead was ${fromIndex}`);
         // assert.ok(Number.isInteger(fromIndex), `fromIndex must be an integer, instead was ${fromIndex}`);
 
         const bit_length = this.__length;
-        if (fromIndex >= bit_length) {
+        if (from_index >= bit_length) {
             //index is out of bounds, return -1
             return -1;
         }
 
         const data = this.__data_uint32;
 
-        let word_index = fromIndex >> 5;
+        let word_index = from_index >> 5;
         let word;
         let bit_address;
 
-        let bit_index = fromIndex & 31;
+        let bit_index = from_index & 31;
 
         if (bit_index !== 0) {
             // bit offset boundary in inside the word, we need to mask part of the word
@@ -286,19 +306,19 @@ export class BitSet {
 
     /**
      * Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
-     * @param {int} fromIndex
-     * @returns {number}
+     * @param {number} from_index The index to start searching from (inclusive).
+     * @returns {number} Index of the next clear bit (bit set to false), or the current length of BitSet if all the bits are set.
      */
-    nextClearBit(fromIndex) {
+    nextClearBit(from_index) {
         //assert.ok(fromIndex >= 0, `fromIndex must be greater or equal to 0, instead was ${fromIndex}`);
         //assert.ok(Number.isInteger(fromIndex), `fromIndex must be an integer, instead was ${fromIndex}`);
 
-        let word_index = fromIndex >> 5;
+        let word_index = from_index >> 5;
 
         let word;
 
         // treat first word specially, as we may need to mask out portion of a word to skip certain number of bits
-        let bit_index = fromIndex & 31;
+        let bit_index = from_index & 31;
 
         const data = this.__data_uint32;
 
@@ -340,9 +360,10 @@ export class BitSet {
     }
 
     /**
-     *
-     * @param {int} bit_index
-     * @param {boolean} value
+     * Sets the bit at the specified index to the specified value.
+     * @param {number} bit_index The index of the bit to set.
+     * @param {boolean} value The value to set the bit to (true for 1, false for 0).
+     * @returns {void}
      */
     set(bit_index, value) {
         assert.isNonNegativeInteger(bit_index, 'bit_index');
@@ -380,24 +401,24 @@ export class BitSet {
     }
 
     /**
-     * Sets the bit specified by the index to false.
-     * @param {int} bitIndex
+     * Sets the bit specified by the index to false (0).
+     * @param {number} bit_index The index of the bit to clear.
      */
-    clear(bitIndex) {
-        this.set(bitIndex, false);
+    clear(bit_index) {
+        this.set(bit_index, false);
     }
 
     /**
      * Set all bits in a given range
-     * @param {number} startIndex first bit to be set
-     * @param {number} endIndex last bit to be set
+     * @param {number} start_index first bit to be set (inclusive)
+     * @param {number} end_index last bit to be set (inclusive)
      */
-    setRange(startIndex, endIndex) {
-        assert.greaterThanOrEqual(startIndex, 0, "invalid start index");
-        assert.greaterThanOrEqual(endIndex, 0, "invalid end index");
+    setRange(start_index, end_index) {
+        assert.greaterThanOrEqual(start_index, 0, "invalid start index");
+        assert.greaterThanOrEqual(end_index, 0, "invalid end index");
 
 
-        for (let i = startIndex; i <= endIndex; i++) {
+        for (let i = start_index; i <= end_index; i++) {
             this.set(i, true);
         }
 
@@ -405,33 +426,33 @@ export class BitSet {
 
     /**
      * Clears bit values in a given (inclusive) range
-     * @param {number} startIndex first bit to be cleared
-     * @param {number} endIndex clear up to here, excluding this position
+     * @param {number} start_index first bit to be cleared (inclusive)
+     * @param {number} end_index clear up to here, excluding this position
      */
-    clearRange(startIndex, endIndex) {
-        assert.greaterThanOrEqual(startIndex, 0, "invalid start index");
-        assert.greaterThanOrEqual(endIndex, 0, "invalid end index");
+    clearRange(start_index, end_index) {
+        assert.greaterThanOrEqual(start_index, 0, "invalid start index");
+        assert.greaterThanOrEqual(end_index, 0, "invalid end index");
 
-        for (let i = startIndex; i < endIndex; i++) {
+        for (let i = start_index; i < end_index; i++) {
             this.set(i, false);
         }
     }
 
     /**
      * Returns the value of the bit with the specified index.
-     * @param {int} bitIndex
-     * @returns {boolean}
+     * @param {int} bit_index The index of the bit to get.
+     * @returns {boolean} The value of the bit (true for 1, false for 0).  Returns `false` if `bitIndex` is out of bounds.
      */
-    get(bitIndex) {
-        assert.isNonNegativeInteger(bitIndex, "bitIndex");
+    get(bit_index) {
+        assert.isNonNegativeInteger(bit_index, "bitIndex");
 
-        if (bitIndex >= this.__length) {
+        if (bit_index >= this.__length) {
             //bit is outside the recorded region
             return false;
         }
 
-        const byteOffset = bitIndex >> 5;
-        const bitOffset = bitIndex & 31;
+        const byteOffset = bit_index >> 5;
+        const bitOffset = bit_index & 31;
 
         const word = this.__data_uint32[byteOffset];
 

package/src/core/function/noop.d.ts

@@ -1,6 +1,9 @@
 /**
- * No-operation function. Does nothing. Useful when a callback is required to avoid checks for a missing function.
+ * No-operation function.
+ * Does nothing.
+ * Useful when a callback is required to avoid checks for a missing function.
  * @param {*} arguments
+ * @return {void}
  */
 export function noop(): void;
 //# sourceMappingURL=noop.d.ts.map

package/src/core/function/noop.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"noop.d.ts","sourceRoot":"","sources":["../../../../src/core/function/noop.js"],"names":[],"mappings":"AAAA;;;GAGG;AACH,6BACC"}
+{"version":3,"file":"noop.d.ts","sourceRoot":"","sources":["../../../../src/core/function/noop.js"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,wBAFY,IAAI,CAGf"}

package/src/core/function/noop.js

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

package/src/core/geom/Vector4.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Vector4.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector4.js"],"names":[],"mappings":";AAMA;IA2YI;;;;;;OAMG;IACH,gBALW,OAAO,MACP,OAAO,qBAEP,OAAO,QASjB;IAxZD;;;;;;;;OAQG;IACH,4DAOC;IANG,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IAEV,eAA6B;IAOjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAcD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAcD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAcD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAVD,SAMW,MAAM,CAJhB;IAUD;;;;OAIG;IACH,qBAHW,MAAM,EAAE,WACR,MAAM,QAShB;IAED;;;;OAIG;IACH,oBAHW,MAAM,EAAE,WACR,MAAM,QAOhB;IAED;;;;;;;OAOG;IACH,iDAFa,OAAO,CAkCnB;IAED;;;OAGG;IACH,oBAFW,OAAO,QAQjB;IAED;;;;OAIG;IACH,+BAFa,OAAO,CAOnB;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAlBW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,OAAO,CAoBnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,SAHW,OAAO,GAAC,OAAO,GACb,OAAO,CASnB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,OAAO,CAUnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,SAFa,OAAO,CAQnB;IAED;;;OAGG;IACH,mBAFW,UAAU,QAyBpB;IAED;;;;OAIG;IACH,aAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,QAFY,MAAM,CASjB;IAED;;;;OAIG;IACH,gBAJW,OAAO,MACP,OAAO,mBAKjB;IAED;;;OAGG;IACH,gBAFW,MAAM,EAAE,QAOlB;IAED;;OAEG;IACH,WAFa,MAAM,EAAE,CAQpB;IAED;;;;OAIG;IACH,mBAHW,MAAM,EAAE,UACR,MAAM,QAIhB;IAED;;;;;MAOC;IAED,0BAEC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAStB;IAED,sDAOC;CAiBJ"}
+{"version":3,"file":"Vector4.d.ts","sourceRoot":"","sources":["../../../../src/core/geom/Vector4.js"],"names":[],"mappings":";AAMA;IAiaI;;;;;;OAMG;IACH,gBALW,OAAO,MACP,OAAO,qBAEP,OAAO,QASjB;IA9aD;;;;;;;;OAQG;IACH,gBAPW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,EAiBhB;IANG,UAAU;IACV,UAAU;IACV,UAAU;IACV,UAAU;IAEV,eAA6B;IAWjC;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAkBD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAkBD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAkBD;;;OAGG;IACH,SAFW,MAAM,EAIhB;IAdD;;;OAGG;IACH,SAFa,MAAM,CAIlB;IAUD;;;;OAIG;IACH,qBAHW,MAAM,EAAE,WACR,MAAM,QAShB;IAED;;;;OAIG;IACH,oBAHW,MAAM,EAAE,WACR,MAAM,QAOhB;IAED;;;;;;;OAOG;IACH,iDAFa,OAAO,CAkCnB;IAED;;;OAGG;IACH,oBAFW,OAAO,QAQjB;IAED;;;;OAIG;IACH,+BAFa,OAAO,CAOnB;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,kBAlBW,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,MACN,MAAM,GACJ,OAAO,CAoBnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,MAAM,CAIlB;IAED;;;;OAIG;IACH,SAHW,OAAO,GAAC,OAAO,GACb,OAAO,CASnB;IAED;;;;OAIG;IACH,qBAHW,OAAO,GACL,OAAO,CAUnB;IAED;;;;OAIG;IACH,WAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,SAFa,OAAO,CAQnB;IAED;;;OAGG;IACH,mBAFW,UAAU,QAyBpB;IAED;;;;OAIG;IACH,aAHW,OAAO,GACL,OAAO,CAInB;IAED;;;OAGG;IACH,QAFY,MAAM,CASjB;IAED;;;;OAIG;IACH,gBAJW,OAAO,MACP,OAAO,mBAKjB;IAED;;;OAGG;IACH,gBAFW,MAAM,EAAE,QAOlB;IAED;;OAEG;IACH,WAFa,MAAM,EAAE,CAQpB;IAED;;;;OAIG;IACH,mBAHW,MAAM,EAAE,UACR,MAAM,QAIhB;IAED;;;;;MAOC;IAED,0BAEC;IAED;;;OAGG;IACH,uBAFW,YAAY,QAOtB;IAED;;;OAGG;IACH,yBAFW,YAAY,QAStB;IAED,sDAOC;CAiBJ"}

package/src/core/geom/Vector4.js

@@ -7,14 +7,20 @@ import { computeHashFloat } from "../primitives/numbers/computeHashFloat.js";
 class Vector4 {
     /**
      *
-     * @param {Number} [x=0]
-     * @param {Number} [y=0]
-     * @param {Number} [z=0]
-     * @param {Number} [w=0]
+     * @param {number} [x=0]
+     * @param {number} [y=0]
+     * @param {number} [z=0]
+     * @param {number} [w=0]
      * @constructor
      * @class
      */
-    constructor(x = 0, y = 0, z = 0, w = 0) {
+    constructor(
+        x = 0,
+        y = 0,
+        z = 0,
+        w = 0
+    ) {
+
         this.x = x;
         this.y = y;
         this.z = z;
@@ -23,6 +29,10 @@ class Vector4 {
         this.onChanged = new Signal();
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 0() {
         return this.x;
     }
@@ -35,6 +45,10 @@ class Vector4 {
         this.x = v;
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 1() {
         return this.y;
     }
@@ -47,6 +61,10 @@ class Vector4 {
         this.y = v;
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 2() {
         return this.z;
     }
@@ -59,6 +77,10 @@ class Vector4 {
         this.z = v;
     }
 
+    /**
+     *
+     * @returns {number}
+     */
     get 3() {
         return this.w;
     }