@woosh/meep-engine 2.59.6 → 2.60.1

package/src/core/geom/2d/line/line_segment_compute_line_segment_intersection_vectors_array_2d.js

@@ -7,7 +7,7 @@ import {
  * @param {Vector2} p1
  * @param {Vector2} p2
  * @param {Vector2} p3
- * @returns {[number,number]}
+ * @returns {number[]} 2 elements
  */
 export function line_segment_compute_line_segment_intersection_vectors_array_2d(p0, p1, p2, p3) {
     const p0_x = p0.x;

package/src/core/geom/2d/quad-tree/QuadTreeNode.js

@@ -487,7 +487,7 @@ export class QuadTreeNode extends AABB2 {
 
     /**
      *
-     * @param {QuadTreeDatum<D>[]} result
+     * @param {Array<QuadTreeDatum<D>>} result
      * @param {number} x
      * @param {number} y
      * @returns {number} number of intersecting objects added to the result
@@ -506,7 +506,7 @@ export class QuadTreeNode extends AABB2 {
 
     /**
      *
-     * @param {QuadTreeDatum<D>[]} result
+     * @param {Array<QuadTreeDatum<D>>} result
      * @param {number} x0
      * @param {number} y0
      * @param {number} x1

package/src/core/geom/2d/quad-tree/qt_collect_by_circle.js

@@ -8,7 +8,7 @@ const node_stack = [];
 
 /**
  * @template T
- * @param {QuadTreeDatum<T>[]} result
+ * @param {Array<QuadTreeDatum<T>>} result
  * @param {number} result_offset
  * @param {QuadTreeNode<T>} tree
  * @param {number} x

package/src/core/geom/3d/sphere/harmonics/sh3_dering_optimize_positive.js

@@ -53,17 +53,17 @@ function factorial(n, d = 1) {
 }
 
 const F_PI = 3.14159265358979323846264338327950288;
-const F_2_PI = 0.636619772367581343075535053490057448;
 const F_2_SQRTPI = 1.12837916709551257389615890312154517;
 const F_SQRT2 = 1.41421356237309504880168872420969808;
 const F_SQRT1_2 = 0.707106781186547524400844362104849039;
 const M_SQRT_3 = 1.7320508076;
 
 /**
- * SH scaling factors:
- *  returns sqrt((2*l + 1) / 4*pi) * sqrt( (l-|m|)! / (l+|m|)! )
+ * SH scaling factors
  */
 function Kml(m, l) {
+    //  returns sqrt((2*l + 1) / 4*pi) * sqrt( (l-|m|)! / (l+|m|)! )
+
     m = m < 0 ? -m : m;  // abs() is not constexpr
     const K = (2 * l + 1) * factorial((l - m), (l + m));
     return Math.sqrt(K) * (F_2_SQRTPI * 0.25);

package/src/core/geom/3d/tetrahedra/TetrahedralMesh.js

@@ -135,7 +135,7 @@ export class TetrahedralMesh {
 
     /**
      * Traverse tetrahedrons
-     * @param {(tet:number,mesh:TetrahedralMesh)=>*} visitor
+     * @param {function(tet:number,mesh:TetrahedralMesh):*} visitor
      * @param {*} [thisArg]
      */
     forEach(visitor, thisArg) {

package/src/core/geom/3d/tetrahedra/validate_tetrahedral_mesh.js

@@ -134,7 +134,7 @@ function is_tetrahedron_degenerate(mesh, tet) {
  *
  * @param {TetrahedralMesh} mesh
  * @param {ArrayLike<number>} points
- * @param {(problem:string)=>*} [consumer]
+ * @param {function(problem:string):*} [consumer]
  * @returns {boolean}
  */
 export function validate_tetrahedral_mesh(mesh, points, consumer = noop) {

package/src/core/geom/packing/miniball/Miniball.js

@@ -162,7 +162,6 @@ class Miniball {
     /**
      * TODO
      *
-     * @return
      * @return {*}
      */
     support() {

package/src/core/geom/packing/miniball/Subspan.js

@@ -273,8 +273,7 @@ export class Subspan {
      *
      * Complexity: O(dim^2).
      *
-     * @param {number} index
-     * index into <i>S</i> of the point to add
+     * @param {number} index index into <i>S</i> of the point to add
      */
     add(index) {
         let o = this.origin();
@@ -310,7 +309,6 @@ export class Subspan {
      * Euclidean coordinates of point <i>p</i>
      * @param {Array} w
      * the squared length of <i>w</i>
-     * @return
      * @return {number}
      */
     shortestVectorToSpan(p, w) {

package/src/core/graph/coloring/colorizeGraph.js

@@ -118,7 +118,7 @@ function updateNN(NN, a, vertexCount, colors, colorNumber) {
  * @param {number[]} NN
  * @param {number[]} color
  * @param {number} colorNumber
- * @return {(number)[]}
+ * @return {number[]}
  */
 function findSuitableY(vertexCount, a, NN, color, colorNumber) {
     var temp, tmp_y, y = 0;

package/src/core/localization/Localization.js

@@ -1,13 +1,13 @@
-import { distance as levenshtein_distance } from "fastest-levenshtein";
-import { parseTooltipString } from "../../view/tooltip/gml/parser/parseTooltipString.js";
-import { assert } from "../assert.js";
+import {distance as levenshtein_distance} from "fastest-levenshtein";
+import {parseTooltipString} from "../../view/tooltip/gml/parser/parseTooltipString.js";
+import {assert} from "../assert.js";
+import {Cache} from "../cache/Cache.js";
+import {computeHashArray} from "../collection/array/computeHashArray.js";
 import ObservedString from "../model/ObservedString.js";
-import { seedVariablesIntoTemplateString } from "../parser/seedVariablesIntoTemplateString.js";
-import { STRING_TEMPLATE_VARIABLE_REGEX } from "../parser/STRING_TEMPLATE_VARIABLE_REGEX.js";
-import { Cache } from "../cache/Cache.js";
-import { computeStringHash } from "../primitives/strings/computeStringHash.js";
-import { computeHashArray } from "../collection/array/computeHashArray.js";
-import { LanguageMetadata } from "./LanguageMetadata.js";
+import {seedVariablesIntoTemplateString} from "../parser/seedVariablesIntoTemplateString.js";
+import {STRING_TEMPLATE_VARIABLE_REGEX} from "../parser/STRING_TEMPLATE_VARIABLE_REGEX.js";
+import {computeStringHash} from "../primitives/strings/computeStringHash.js";
+import {LanguageMetadata} from "./LanguageMetadata.js";
 
 /**
  * Validation utility method
@@ -56,7 +56,7 @@ export class Localization {
         this.debug = true;
 
         /**
-         * @type {Cache<string[], string>}
+         * @type {Cache<Array<string>, string>}
          * @private
          */
         this.__failure_cache = new Cache({
@@ -176,7 +176,7 @@ export class Localization {
      * @param {number} value
      */
     formatIntegerByThousands(value) {
-        const formatter = new Intl.NumberFormat(this.locale.getValue(), { useGrouping: true });
+        const formatter = new Intl.NumberFormat(this.locale.getValue(), {useGrouping: true});
 
         return formatter.format(value);
     }

package/src/core/model/ModuleRegistry.js

@@ -9,7 +9,7 @@ export class ModuleRegistry {
     #modules = new Map();
     /**
      *
-     * @type {Map<*,string[]>}
+     * @type {Map<*,Array<string>>}
      */
     #reverse_lookup = new Map();
 
@@ -37,7 +37,7 @@ export class ModuleRegistry {
 
     /**
      *
-     * @param {(name:string, module:*)=>void} visitor
+     * @param {function(name:string,module:*):void} visitor
      */
     traverse(visitor) {
         this.#modules.forEach((klass, name) => visitor(name, klass));
@@ -55,7 +55,7 @@ export class ModuleRegistry {
 
     /**
      *
-     * @param {String} name
+     * @param {string} name
      * @returns {boolean}
      */
     has(name) {
@@ -64,7 +64,7 @@ export class ModuleRegistry {
 
     /**
      * @template T
-     * @param {String} name
+     * @param {string} name
      * @param {T} module
      * @returns {boolean}
      */

package/src/core/process/task/Task.js

@@ -55,7 +55,7 @@ class Task {
 
         /**
          *
-         * @type {function(Task, executor:{run:function(Task)})}
+         * @type {function(Task, executor:ConcurrentExecutor)}
          */
         this.initialize = initializer;
 
@@ -149,7 +149,7 @@ class Task {
 
     /**
      *
-     * @param {(Task|TaskGroup)[]} tasks
+     * @param {Array<(Task|TaskGroup)>} tasks
      */
     addDependencies(tasks) {
         if (!Array.isArray(tasks)) {
@@ -205,7 +205,7 @@ class Task {
 
     /**
      *
-     * @param {(Task|TaskGroup)[]} tasks
+     * @param {Array<(Task|TaskGroup)>} tasks
      * @return {Promise}
      */
     static promiseAll(tasks) {

package/src/engine/EngineConfiguration.js

@@ -91,7 +91,6 @@ export class EngineConfiguration {
     }
 
     /**
-     *
      * @param {System} systems
      */
     addManySystems(...systems) {

package/src/engine/EngineHarness.js

@@ -184,7 +184,7 @@ export class EngineHarness {
             em.addSystem(new TopDownCameraControllerSystem());
         }
         if (em.getSystem(CameraSystem) === null) {
-            em.addSystem(new CameraSystem(engine.graphics.scene, engine.graphics))
+            em.addSystem(new CameraSystem(engine.graphics))
         }
 
         if (em.getSystem(SoundListenerSystem) === null) {

package/src/engine/ecs/EntityComponentDataset.js

@@ -1094,7 +1094,7 @@ export class EntityComponentDataset {
      * Performs traversal on a subset of entities which have specified components.
      * @example traverseEntities([Transform,Renderable,Tag],function(transform, renderable, tag, entity){ ... }, this);
      * @param {Array} classes
-     * @param {function:boolean?} visitor Visitor can return optional "false" to terminate traversal earlier
+     * @param {function(...args):boolean} visitor Visitor can return optional "false" to terminate traversal earlier
      * @param {object} [thisArg] specifies context object on which callbacks are to be called, optional
      */
     traverseEntities(classes, visitor, thisArg) {
@@ -1719,7 +1719,7 @@ export class EntityComponentDataset {
     /**
      * Main utility of this method is to facilitate serialization.
      * @param {Array} componentClasses
-     * @param {function(componentIndex:number,components:[], componentCount:number)} visitor
+     * @param {function(componentIndex:number,components:Array, componentCount:number)} visitor
      */
     traverseEntitiesCompactedFiltered(componentClasses, visitor) {
 

package/src/engine/ecs/parent/EntityNode.js

@@ -1,12 +1,12 @@
-import { ParentEntity } from "./ParentEntity.js";
-import Entity from "../Entity.js";
-import { array_remove_first } from "../../../core/collection/array/array_remove_first.js";
-import { assert } from "../../../core/assert.js";
-import { array_push_if_unique } from "../../../core/collection/array/array_push_if_unique.js";
-import { Transform } from "../transform/Transform.js";
-import { TransformAttachment, TransformAttachmentFlags } from "../transform-attachment/TransformAttachment.js";
+import {assert} from "../../../core/assert.js";
+import {array_push_if_unique} from "../../../core/collection/array/array_push_if_unique.js";
+import {array_remove_first} from "../../../core/collection/array/array_remove_first.js";
 import Signal from "../../../core/events/signal/Signal.js";
-import { EntityNodeFlags } from "./EntityNodeFlags.js";
+import Entity from "../Entity.js";
+import {TransformAttachment, TransformAttachmentFlags} from "../transform-attachment/TransformAttachment.js";
+import {Transform} from "../transform/Transform.js";
+import {EntityNodeFlags} from "./EntityNodeFlags.js";
+import {ParentEntity} from "./ParentEntity.js";
 
 const DEFAULT_FLAGS = EntityNodeFlags.LiveManagement;
 
@@ -116,7 +116,7 @@ export class EntityNode {
 
     /**
      *
-     * @param {(EntityNode) => *} visitor
+     * @param {function(node:EntityNode):*} visitor
      * @param {*} [context]
      */
     traverseChildren(visitor, context) {
@@ -125,7 +125,7 @@ export class EntityNode {
 
     /**
      *
-     * @return {Readonly<EntityNode[]>}
+     * @return {Readonly<Array<EntityNode>>}
      */
     get children() {
         return this.__children;

package/src/engine/graphics/camera/testClippingPlaneComputation.js

@@ -92,7 +92,7 @@ function makeConfig(engine) {
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
         new TopDownCameraLanderSystem(),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/engine/graphics/ecs/camera/Camera.js

@@ -3,18 +3,18 @@
  */
 
 
-import ObservedBoolean from "../../../../core/model/ObservedBoolean.js";
-import ObservedEnum from "../../../../core/model/ObservedEnum.js";
-import { Frustum } from 'three';
-import { assert } from "../../../../core/assert.js";
+import {Frustum} from 'three';
+import {assert} from "../../../../core/assert.js";
+import {plane3_compute_ray_intersection} from "../../../../core/geom/3d/plane/plane3_compute_ray_intersection.js";
+import {v3_distance_above_plane} from "../../../../core/geom/vec3/v3_distance_above_plane.js";
 import Vector1 from "../../../../core/geom/Vector1.js";
-import { unprojectPoint } from "./unprojectPoint.js";
 import Vector3 from "../../../../core/geom/Vector3.js";
-import { frustum_from_camera } from "./frustum_from_camera.js";
-import { invertQuaternionOrientation } from "./InvertQuaternionOrientation.js";
-import { v3_distance_above_plane } from "../../../../core/geom/vec3/v3_distance_above_plane.js";
-import { ProjectionType } from "./ProjectionType.js";
-import { plane3_compute_ray_intersection } from "../../../../core/geom/3d/plane/plane3_compute_ray_intersection.js";
+import ObservedBoolean from "../../../../core/model/ObservedBoolean.js";
+import ObservedEnum from "../../../../core/model/ObservedEnum.js";
+import {frustum_from_camera} from "./frustum_from_camera.js";
+import {invertQuaternionOrientation} from "./InvertQuaternionOrientation.js";
+import {ProjectionType} from "./ProjectionType.js";
+import {unprojectPoint} from "./unprojectPoint.js";
 
 /**
  * @class
@@ -51,7 +51,7 @@ export class Camera {
          *
          * @type {ObservedBoolean}
          */
-        this.active = new ObservedBoolean(false);
+        this.active = new ObservedBoolean(true);
 
         /**
          * Near clipping plane

package/src/engine/graphics/ecs/camera/CameraSystem.d.ts

@@ -1,11 +1,10 @@
+import {EntityComponentDataset} from "../../../ecs/EntityComponentDataset";
 import {System} from "../../../ecs/System";
-import {Scene} from "three";
 import {GraphicsEngine} from "../../GraphicsEngine";
-import {EntityComponentDataset} from "../../../ecs/EntityComponentDataset";
 import {Camera} from "./Camera";
 
 export class CameraSystem extends System<Camera> {
-    constructor(scene: Scene, graphics: GraphicsEngine)
+    constructor(engine: GraphicsEngine)
 
     public static getFirstActiveCamera(ecd: EntityComponentDataset): { entity: number, component: Camera | undefined }
 }

package/src/engine/graphics/ecs/camera/CameraSystem.js

@@ -21,14 +21,13 @@ import { ResourceAccessKind } from "../../../../core/model/ResourceAccessKind.js
 export class CameraSystem extends System {
     /**
      *
-     * @param {THREE.Scene} scene
      * @param {GraphicsEngine} graphics
      * @constructor
      */
-    constructor(scene, graphics) {
+    constructor(graphics) {
         super();
 
-        this.scene = scene;
+        this.scene = graphics.scene;
 
         this.dependencies = [Camera, Transform];
 

package/src/engine/graphics/ecs/path/testPathDisplaySystem.js

@@ -102,7 +102,7 @@ function makeConfig(engine) {
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
         new TopDownCameraLanderSystem(),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/engine/graphics/ecs/path/tube/prototypeAnimatedPathMask.js

@@ -106,7 +106,7 @@ function makeConfig(engine) {
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
         new TopDownCameraLanderSystem(),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/engine/graphics/ecs/water2/shader/testWaterShader.js

@@ -38,14 +38,14 @@ function makeConfig(engine) {
     const assetManager = engine.assetManager;
     const devices = engine.devices;
 
-    config.systems.push(
+    config.addManySystems(
         new ScriptSystem(),
         new PathFollowingSystem(),
         new TagSystem(),
         new TimerSystem(),
         new TopDownCameraControllerSystem(graphics),
         new TopDownCameraLanderSystem(),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(graphics, assetManager),
         new TerrainSystem(graphics, assetManager),
         new WaterSystem(graphics),

package/src/engine/graphics/geometry/instancing/InstancedMeshGroup.js

@@ -21,9 +21,15 @@ import { array_copy } from "../../../../core/collection/array/array_copy.js";
 import { Cache } from "../../../../core/cache/Cache.js";
 import { computeMaterialHash } from "../../../asset/loaders/material/computeMaterialHash.js";
 
+/**
+ * @typedef {Object} CacheKey
+ * @property {Material} color
+ * @property {Material} depth
+ */
+
 /**
  * @readonly
- * @type {Cache<Material, {color:Material, depth:Material}>}
+ * @type {Cache<Material,CacheKey>}
  */
 const material_cache = new Cache({
     maxWeight: 1024,
@@ -38,14 +44,14 @@ export class InstancedMeshGroup {
     constructor() {
         /**
          * Instanced geometry
-         * @type {THREE.InstancedBufferGeometry|null}
+         * @type {InstancedBufferGeometry|null}
          * @private
          */
         this.__threeGeometry = null;
 
         /**
          * Geometry of a single instance
-         * @type {THREE.BufferGeometry|null}
+         * @type {BufferGeometry|null}
          * @private
          */
         this.__threeInstanceGeometry = null;
@@ -73,7 +79,12 @@ export class InstancedMeshGroup {
          */
         this.growConstant = 16;
 
+        /**
+         *
+         * @type {number}
+         */
         this.shrinkFactor = 0.5;
+
         /**
          * Minimum capacity reduction for shrinkage to occur
          * @type {number}
@@ -238,7 +249,7 @@ export class InstancedMeshGroup {
     /**
      *
      * @param {THREE.Material|THREE.ShaderMaterial} sourceMaterial
-     * @returns {{depth: Material, color: Material}}
+     * @returns {CacheKey}
      */
     #buildMaterial(sourceMaterial) {
         //console.warn(`building material : {id:${sourceMaterial.id}, name: ${sourceMaterial.name}, type: ${sourceMaterial.type}`)

package/src/engine/graphics/particles/particular/engine/utils/volume/prototypeParticleVolume.js

@@ -99,7 +99,7 @@ function makeConfig(engine) {
     const guiSystem = new GUIElementSystem(engine.gui.view, engine);
     const headsUpDisplaySystem = new HeadsUpDisplaySystem(graphics);
 
-    config.systems.push(
+    config.addManySystems(
         new TagSystem(),
         new AttachmentSystem(),
         new SoundEmitterSystem(assetManager, sound.destination, sound.context),
@@ -108,7 +108,7 @@ function makeConfig(engine) {
         guiSystem,
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/engine/graphics/render/buffer/buffers/prototypeNormalFrameBuffer.js

@@ -98,7 +98,7 @@ function makeConfig(engine) {
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
         new TopDownCameraLanderSystem(),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/engine/graphics/render/forward_plus/plugin/ptototypeFPPlugin.js

@@ -126,7 +126,7 @@ function makeConfig(engine) {
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
         new TopDownCameraLanderSystem(),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/engine/graphics/render/view/CameraView.js

@@ -73,7 +73,7 @@ export class CameraView {
 
         /**
          *
-         * @type {{transform:(Float32Array, Float32Array)=>void, context:*}[]}
+         * @type {Array<{transform:function(Float32Array, Float32Array):void, context:*}>}
          */
         this.projection_modifiers = [];
     }

package/src/engine/graphics/render/visibility/hiz/prototypeHiZ.js

@@ -103,7 +103,7 @@ function makeConfig(engine) {
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
         new TopDownCameraLanderSystem(),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/engine/graphics/shaders/ClearShader.js

@@ -24,7 +24,7 @@ const ClearShader = {
         "}"
 
 
-    ].join("\n')
+    ].join("\n")
 };
 
 export default ClearShader;

package/src/engine/graphics/shadows/testShadowMapRendering.js

@@ -79,7 +79,7 @@ function makeConfig(engine) {
         guiSystem,
         new AnimationSystem(graphics.viewport.size),
         new TopDownCameraControllerSystem(graphics),
-        new CameraSystem(graphics.scene, graphics),
+        new CameraSystem(engine.graphics),
         new MeshSystem(engine),
         new ClingToTerrainSystem(),
         new TerrainSystem(graphics, assetManager),

package/src/misc/makeMaterialIconCached.js

@@ -4,9 +4,16 @@ import { computeMaterialHash } from "../engine/asset/loaders/material/computeMat
 import { makeMaterialIcon } from "./makeMaterialIcon.js";
 import { computeHashIntegerArray } from "../core/collection/array/computeHashIntegerArray.js";
 
+
+/**
+ * @typedef {Object} CacheKey
+ * @property {number} size
+ * @property {Material} material
+ */
+
 /**
  *
- * @type {Cache<{size:number,material:THREE.Material}, Sampler2D>}
+ * @type {Cache<CacheKey, Sampler2D>}
  */
 const cache = new Cache({
                             maxWeight: 1024000,