@woosh/meep-engine 2.113.16 → 2.114.0

package/build/meep.cjs

@@ -106398,6 +106398,7 @@ function computeBinaryDataTypeByPrecision(type, precision) {
 const stack$1 = [];
 
 /**
+ * Quicksort implementation, instead of compare operator, uses scoring function
  * @template T
  * @param {T[]|ArrayLike<number>|Uint32Array} data
  * @param {function(T):number} score_function
@@ -106407,12 +106408,13 @@ const stack$1 = [];
  * @param {function(T[],number, number):*} [swap_operator]
  * @param {*} [swap_context]
  */
-function arrayQuickSort(
+function array_sort_quick(
     data,
     score_function, score_function_context,
     start = 0, end = data.length - 1,
     swap_operator = array_swap_one, swap_context = undefined
 ) {
+
     if (start >= end) {
         // section of 0 size, nothing to sort
         return;
@@ -111353,7 +111355,7 @@ class LightManager {
         array_copy(visible_light_set.elements, 0, sorted_lights, 0, visible_light_count);
         array_copy(visible_decal_set.elements, 0, sorted_lights, visible_light_count, visible_decal_count);
 
-        arrayQuickSort(sorted_lights, this.__sort_visible_light_score, this, 0, expected_sorted_size - 1);
+        array_sort_quick(sorted_lights, this.__sort_visible_light_score, this, 0, expected_sorted_size - 1);
     }
 
     __update_visible_bvh() {

package/build/meep.module.js

@@ -106396,6 +106396,7 @@ function computeBinaryDataTypeByPrecision(type, precision) {
 const stack$1 = [];
 
 /**
+ * Quicksort implementation, instead of compare operator, uses scoring function
  * @template T
  * @param {T[]|ArrayLike<number>|Uint32Array} data
  * @param {function(T):number} score_function
@@ -106405,12 +106406,13 @@ const stack$1 = [];
  * @param {function(T[],number, number):*} [swap_operator]
  * @param {*} [swap_context]
  */
-function arrayQuickSort(
+function array_sort_quick(
     data,
     score_function, score_function_context,
     start = 0, end = data.length - 1,
     swap_operator = array_swap_one, swap_context = undefined
 ) {
+
     if (start >= end) {
         // section of 0 size, nothing to sort
         return;
@@ -111351,7 +111353,7 @@ class LightManager {
         array_copy(visible_light_set.elements, 0, sorted_lights, 0, visible_light_count);
         array_copy(visible_decal_set.elements, 0, sorted_lights, visible_light_count, visible_decal_count);
 
-        arrayQuickSort(sorted_lights, this.__sort_visible_light_score, this, 0, expected_sorted_size - 1);
+        array_sort_quick(sorted_lights, this.__sort_visible_light_score, this, 0, expected_sorted_size - 1);
     }
 
     __update_visible_bvh() {

package/package.json

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

package/src/core/collection/array/array_filter_by_multiple.d.ts

@@ -1,4 +1,6 @@
 /**
+ * Similar to standard {@link Array.prototype.filter}, but allows multiple filters. They work as an "AND".
+ * Useful to save allocations when multiple filters need to be applied, as the {@link Array.prototype.filter} allocates a new array for each call
  * @template T
  * @param {T[]} input_items
  * @param {((T)=>boolean)[]} filters

package/src/core/collection/array/array_filter_by_multiple.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"array_filter_by_multiple.d.ts","sourceRoot":"","sources":["../../../../../src/core/collection/array/array_filter_by_multiple.js"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,oFAHiB,OAAO,UAgCvB"}
+{"version":3,"file":"array_filter_by_multiple.d.ts","sourceRoot":"","sources":["../../../../../src/core/collection/array/array_filter_by_multiple.js"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,oFAHiB,OAAO,UAqCvB"}

package/src/core/collection/array/array_filter_by_multiple.js

@@ -1,4 +1,6 @@
 /**
+ * Similar to standard {@link Array.prototype.filter}, but allows multiple filters. They work as an "AND".
+ * Useful to save allocations when multiple filters need to be applied, as the {@link Array.prototype.filter} allocates a new array for each call
  * @template T
  * @param {T[]} input_items
  * @param {((T)=>boolean)[]} filters
@@ -13,23 +15,28 @@ export function array_filter_by_multiple(input_items, filters) {
         return input_items;
     }
 
+    /**
+     *
+     * @type {T[]}
+     */
     const filtered = [];
 
     const input_item_count = input_items.length;
 
-
     main_loop:for (let i = 0; i < input_item_count; i++) {
-        const d = input_items[i];
+        const datum = input_items[i];
+
         for (let j = 0; j < filter_count; j++) {
             const filter = filters[j];
 
-            if (filter(d) === false) {
+            if (filter(datum) === false) {
+                // filter rejected, let's move onto next element
                 continue main_loop;
             }
         }
 
         // filters passed
-        filtered.push(d);
+        filtered.push(datum);
     }
 
     return filtered;

package/src/core/collection/array/array_group_by.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @template T,K
+ * @param {T[]} array
+ * @param {function(T):K} grouping_key_producer given an element from input array, returns a grouping key. Can be an object, if it implements .equals method keys can be compared that way as well
+ * @param keyHashFunction
+ * @returns {Map<K,T[]>}
+ */
+export function array_group_by<T, K>(array: T[], grouping_key_producer: (arg0: T) => K, keyHashFunction?: typeof returnZero): Map<K, T[]>;
+import { returnZero } from "../../function/returnZero.js";
+//# sourceMappingURL=array_group_by.d.ts.map

package/src/core/collection/array/array_group_by.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array_group_by.d.ts","sourceRoot":"","sources":["../../../../../src/core/collection/array/array_group_by.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,0IA+BC;2BAzC0B,8BAA8B"}

package/src/core/collection/array/{groupArrayBy.js → array_group_by.js}

@@ -4,11 +4,11 @@ import { HashMap } from "../map/HashMap.js";
 /**
  * @template T,K
  * @param {T[]} array
- * @param {function(T):K} groupingFunction
+ * @param {function(T):K} grouping_key_producer given an element from input array, returns a grouping key. Can be an object, if it implements .equals method keys can be compared that way as well
  * @param keyHashFunction
  * @returns {Map<K,T[]>}
  */
-export function groupArrayBy(array, groupingFunction, keyHashFunction = returnZero) {
+export function array_group_by(array, grouping_key_producer, keyHashFunction = returnZero) {
     const result = new HashMap({
         keyHashFunction,
         keyEqualityFunction(a, b) {
@@ -27,7 +27,7 @@ export function groupArrayBy(array, groupingFunction, keyHashFunction = returnZe
     for (let i = 0; i < array.length; i++) {
         const element = array[i];
 
-        const groupKey = groupingFunction(element);
+        const groupKey = grouping_key_producer(element);
 
         const group = result.get(groupKey);
 

package/src/core/collection/array/array_sort_quick.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Quicksort implementation, instead of compare operator, uses scoring function
+ * @template T
+ * @param {T[]|ArrayLike<number>|Uint32Array} data
+ * @param {function(T):number} score_function
+ * @param {*} [score_function_context]
+ * @param {number} [start]
+ * @param {number} [end]
+ * @param {function(T[],number, number):*} [swap_operator]
+ * @param {*} [swap_context]
+ */
+export function array_sort_quick<T>(data: ArrayLike<number> | Uint32Array | T[], score_function: (arg0: T) => number, score_function_context?: any, start?: number, end?: number, swap_operator?: (arg0: T[], arg1: number, arg2: number) => any, swap_context?: any): void;
+//# sourceMappingURL=array_sort_quick.d.ts.map

package/src/core/collection/array/array_sort_quick.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"array_sort_quick.d.ts","sourceRoot":"","sources":["../../../../../src/core/collection/array/array_sort_quick.js"],"names":[],"mappings":"AAKA;;;;;;;;;;GAUG;AACH,8GAPuB,MAAM,wCAElB,MAAM,QACN,MAAM,oCACO,MAAM,QAAE,MAAM,oCAmErC"}

package/src/core/collection/array/{arrayQuickSort.js → array_sort_quick.js}

@@ -1,8 +1,10 @@
+import { assert } from "../../assert.js";
 import { array_swap_one } from "./array_swap_one.js";
 
 const stack = [];
 
 /**
+ * Quicksort implementation, instead of compare operator, uses scoring function
  * @template T
  * @param {T[]|ArrayLike<number>|Uint32Array} data
  * @param {function(T):number} score_function
@@ -12,12 +14,14 @@ const stack = [];
  * @param {function(T[],number, number):*} [swap_operator]
  * @param {*} [swap_context]
  */
-export function arrayQuickSort(
+export function array_sort_quick(
     data,
     score_function, score_function_context,
     start = 0, end = data.length - 1,
     swap_operator = array_swap_one, swap_context = undefined
 ) {
+    assert.isFunction(score_function, 'score_function');
+
     if (start >= end) {
         // section of 0 size, nothing to sort
         return;

package/src/engine/graphics/render/forward_plus/LightManager.js

@@ -23,8 +23,8 @@ import {
     bvh_query_user_data_overlaps_frustum
 } from "../../../../core/bvh2/bvh3/query/bvh_query_user_data_overlaps_frustum.js";
 import { array_copy } from "../../../../core/collection/array/array_copy.js";
+import { array_sort_quick } from "../../../../core/collection/array/array_sort_quick.js";
 import { array_swap_one } from "../../../../core/collection/array/array_swap_one.js";
-import { arrayQuickSort } from "../../../../core/collection/array/arrayQuickSort.js";
 import { read_cluster_frustum_corners } from "../../../../core/geom/3d/frustum/read_cluster_frustum_corners.js";
 import { read_three_planes_to_array } from "../../../../core/geom/3d/frustum/read_three_planes_to_array.js";
 import { slice_frustum_linear_to_points } from "../../../../core/geom/3d/frustum/slice_frustum_linear_to_points.js";
@@ -680,7 +680,7 @@ export class LightManager {
         array_copy(visible_light_set.elements, 0, sorted_lights, 0, visible_light_count);
         array_copy(visible_decal_set.elements, 0, sorted_lights, visible_light_count, visible_decal_count);
 
-        arrayQuickSort(sorted_lights, this.__sort_visible_light_score, this, 0, expected_sorted_size - 1);
+        array_sort_quick(sorted_lights, this.__sort_visible_light_score, this, 0, expected_sorted_size - 1);
     }
 
     __update_visible_bvh() {

package/src/engine/graphics/sh3/path_tracer/sorting/sort_bvh_nodes_by_distance_to_point.js

@@ -1,5 +1,5 @@
 import { ELEMENT_WORD_COUNT } from "../../../../../core/bvh2/bvh3/BVH.js";
-import { arrayQuickSort } from "../../../../../core/collection/array/arrayQuickSort.js";
+import { array_sort_quick } from "../../../../../core/collection/array/array_sort_quick.js";
 import {
     aabb3_unsigned_distance_sqr_to_point
 } from "../../../../../core/geom/3d/aabb/aabb3_unsigned_distance_sqr_to_point.js";
@@ -28,7 +28,7 @@ export function sort_bvh_nodes_by_distance_to_point(
      For performance, we bind data directly to avoid extra copies required to read out AABB
      */
     const float32 = bvh.__data_float32;
-    arrayQuickSort(node_list, (node) => {
+    array_sort_quick(node_list, (node) => {
             const address = node * ELEMENT_WORD_COUNT;
 
             const aabb_distance_sqr = aabb3_unsigned_distance_sqr_to_point(

package/src/engine/graphics/texture/virtual/VirtualTextureTileLoader.js

@@ -1,5 +1,5 @@
 import { assert } from "../../../../core/assert.js";
-import { arrayQuickSort } from "../../../../core/collection/array/arrayQuickSort.js";
+import { array_sort_quick } from "../../../../core/collection/array/array_sort_quick.js";
 import Signal from "../../../../core/events/signal/Signal.js";
 import { AssetManager } from "../../../asset/AssetManager.js";
 import { GameAssetType } from "../../../asset/GameAssetType.js";
@@ -142,7 +142,7 @@ export class VirtualTextureTileLoader {
          */
         const score = (fingerprint) => -usage.getCountByFingerprint(fingerprint);
 
-        arrayQuickSort(
+        array_sort_quick(
             this.#queue,
             score, null,
             0, this.#queue.length - 1

package/src/generation/grid/generation/road/GridTaskGenerateRoads.js

@@ -2,7 +2,7 @@ import { GridTags } from "../../../../../samples/generation/grid/GridTags.js";
 import { MirGridLayers } from "../../../../../samples/generation/grid/MirGridLayers.js";
 import { matcher_tag_traversable } from "../../../../../samples/generation/rules/matcher_tag_traversable.js";
 import { BitSet } from "../../../../core/binary/BitSet.js";
-import { groupArrayBy } from "../../../../core/collection/array/groupArrayBy.js";
+import { array_group_by } from "../../../../core/collection/array/array_group_by.js";
 import { collectIteratorValueToArray } from "../../../../core/collection/collectIteratorValueToArray.js";
 import BinaryHeap from "../../../../core/collection/heap/BinaryHeap.js";
 import { QuadTreeNode } from "../../../../core/geom/2d/quad-tree/QuadTreeNode.js";
@@ -169,7 +169,7 @@ function buildPaths(
     const tBuildNodeGroups = actionTask(() => {
 
         //group nodes
-        const groupMap = groupArrayBy(nodes, readMarkerNodeGroupId);
+        const groupMap = array_group_by(nodes, readMarkerNodeGroupId);
 
         /**
          *

package/src/core/collection/array/arrayQuickSort.d.ts

@@ -1,12 +0,0 @@
-/**
- * @template T
- * @param {T[]|ArrayLike<number>|Uint32Array} data
- * @param {function(T):number} score_function
- * @param {*} [score_function_context]
- * @param {number} [start]
- * @param {number} [end]
- * @param {function(T[],number, number):*} [swap_operator]
- * @param {*} [swap_context]
- */
-export function arrayQuickSort<T>(data: ArrayLike<number> | Uint32Array | T[], score_function: (arg0: T) => number, score_function_context?: any, start?: number, end?: number, swap_operator?: (arg0: T[], arg1: number, arg2: number) => any, swap_context?: any): void;
-//# sourceMappingURL=arrayQuickSort.d.ts.map

package/src/core/collection/array/arrayQuickSort.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"arrayQuickSort.d.ts","sourceRoot":"","sources":["../../../../../src/core/collection/array/arrayQuickSort.js"],"names":[],"mappings":"AAIA;;;;;;;;;GASG;AACH,4GAPuB,MAAM,wCAElB,MAAM,QACN,MAAM,oCACO,MAAM,QAAE,MAAM,oCAiErC"}

package/src/core/collection/array/array_remove_element.d.ts

@@ -1,11 +0,0 @@
-/**
- * @deprecated
- * @template T
- * @param {T[]} array
- * @param {number} start_index
- * @param {number} end_index
- * @param {T} element
- * @return {boolean}
- */
-export function array_remove_element<T>(array: T[], start_index: number, end_index: number, element: T): boolean;
-//# sourceMappingURL=array_remove_element.d.ts.map

package/src/core/collection/array/array_remove_element.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"array_remove_element.d.ts","sourceRoot":"","sources":["../../../../../src/core/collection/array/array_remove_element.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,iEALW,MAAM,aACN,MAAM,eAEL,OAAO,CAMlB"}

package/src/core/collection/array/array_remove_element.js

@@ -1,16 +0,0 @@
-import { array_remove_first } from "./array_remove_first.js";
-
-/**
- * @deprecated
- * @template T
- * @param {T[]} array
- * @param {number} start_index
- * @param {number} end_index
- * @param {T} element
- * @return {boolean}
- */
-export function array_remove_element(array, start_index, end_index, element) {
-    console.warn('deprecated, use array_remove_first instead');
-
-    array_remove_first(array, element, start_index, end_index - start_index);
-}

package/src/core/collection/array/groupArrayBy.d.ts

@@ -1,10 +0,0 @@
-/**
- * @template T,K
- * @param {T[]} array
- * @param {function(T):K} groupingFunction
- * @param keyHashFunction
- * @returns {Map<K,T[]>}
- */
-export function groupArrayBy<T, K>(array: T[], groupingFunction: (arg0: T) => K, keyHashFunction?: typeof returnZero): Map<K, T[]>;
-import { returnZero } from "../../function/returnZero.js";
-//# sourceMappingURL=groupArrayBy.d.ts.map

package/src/core/collection/array/groupArrayBy.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"groupArrayBy.d.ts","sourceRoot":"","sources":["../../../../../src/core/collection/array/groupArrayBy.js"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,mIA+BC;2BAzC0B,8BAA8B"}