@woosh/meep-engine 2.56.1 → 2.58.0

package/src/engine/graphics/impostors/octahedral/prototypeBaker.js

@@ -1,7 +1,7 @@
 import { EngineHarness } from "../../../EngineHarness.js";
 import { ImpostorBaker } from "./ImpostorBaker.js";
 import { ShadedGeometry } from "../../ecs/mesh-v2/ShadedGeometry.js";
-import EntityBuilder from "../../../ecs/EntityBuilder.js";
+import Entity from "../../../ecs/Entity.js";
 import ViewportPosition from "../../../ecs/gui/position/ViewportPosition.js";
 import GUIElement from "../../../ecs/gui/GUIElement.js";
 import GUIElementSystem from "../../../ecs/gui/GUIElementSystem.js";
@@ -79,7 +79,7 @@ async function main(engine) {
         mode: 'alpha'
     });
 
-    new EntityBuilder()
+    new Entity()
         .add(new ViewportPosition({
             offset: new Vector2(0, 0)
         }))
@@ -110,7 +110,7 @@ async function main(engine) {
     sg_mesh.castShadow = false;
     sg_mesh.receiveShadow = false;
 
-    const entity_true_mesh = new EntityBuilder();
+    const entity_true_mesh = new Entity();
     entity_true_mesh
         .add(sg_mesh)
         .add(t1)
@@ -122,7 +122,7 @@ async function main(engine) {
 
 /**
  *
- * @param {EntityBuilder} entity
+ * @param {Entity} entity
  * @param {number} [speed]
  * @param {Vector3} [axis]
  */
@@ -173,7 +173,7 @@ function make_impostor_wireframe(id, t = new Transform()) {
     sg.clearFlag(ShadedGeometryFlags.CastShadow);
     sg.clearFlag(ShadedGeometryFlags.ReceiveShadow);
 
-    return new EntityBuilder()
+    return new Entity()
         .add(transform)
         .add(sg)
         ;
@@ -183,7 +183,7 @@ function make_impostor_wireframe(id, t = new Transform()) {
  *
  * @param {ImpostorDescription} id
  * @param {Transform} t
- * @returns {EntityBuilder}
+ * @returns {Entity}
  */
 function make_impostor_entity(id, t = new Transform()) {
 
@@ -201,7 +201,7 @@ function make_impostor_entity(id, t = new Transform()) {
     sg.clearFlag(ShadedGeometryFlags.CastShadow);
     sg.clearFlag(ShadedGeometryFlags.ReceiveShadow);
 
-    return new EntityBuilder()
+    return new Entity()
         .add(transform)
         .add(sg)
         ;

package/src/engine/graphics/particles/node-based/editor/ParticleSpecificationEditorView.js

@@ -8,10 +8,10 @@ import { MouseEvents } from "../../../../input/devices/events/MouseEvents.js";
 import InterfaceCommand from "../../../../../view/interaction/InterfaceCommand.js";
 import { InteractionCommand } from "../../../../../view/interaction/InteractionCommand.js";
 import { serializeNodeGraphToJSON } from "../../../../../core/model/node-graph/json/serializeNodeGraphToJSON.js";
-import { downloadAsFile } from "../../../../../core/binary/ByteArrayTools.js";
 import {
     deserializeNodeGraphFromJSON
 } from "../../../../../core/model/node-graph/json/deserializeNodeGraphFromJSON.js";
+import {downloadAsFile} from "../../../../../core/binary/downloadAsFile.js";
 
 export class ParticleSpecificationEditorView extends View {
     constructor() {

package/src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.js

@@ -3,7 +3,7 @@ import List from "../../../../../../core/collection/list/List.js";
 import { lerp } from "../../../../../../core/math/lerp.js";
 import { max2 } from "../../../../../../core/math/max2.js";
 import { min2 } from "../../../../../../core/math/min2.js";
-import { Box3, BufferGeometry, Frustum, Matrix4, Points, PointsMaterial } from 'three';
+import { Box3, BufferGeometry, Frustum, Points, PointsMaterial } from 'three';
 import { ParticlePool } from "./ParticlePool.js";
 import { ParticleParameter } from "../parameter/ParticleParameter.js";
 import { ParameterSet } from "../parameter/ParameterSet.js";
@@ -28,13 +28,13 @@ import {
     PARTICLE_ATTRIBUTE_UV,
     PARTICLE_ATTRIBUTE_VELOCITY
 } from "./PARTICLE_ATTRIBUTES.js";
-import { composeMatrix4 } from "../../../../util/composeMatrix4.js";
 import { update_parameters } from "../simulator/update_parameters.js";
-import { distance_to_camera } from "./distance_to_camera.js";
 import { computeEmissionFunction } from "./computeEmissionFunction.js";
 import { PARTICULAR_PARTICLE_SPECIFICATION } from "./PARTICULAR_PARTICLE_SPECIFICATION.js";
 import { computeHashIntegerArray } from "../../../../../../core/collection/array/computeHashIntegerArray.js";
 import { frustum_from_camera } from "../../../../ecs/camera/frustum_from_camera.js";
+import { v3_dot_array_array } from "../../../../../../core/geom/vec3/v3_dot_array_array.js";
+import { compose_matrix4_array } from "../../../../../../core/geom/3d/compose_matrix4_array.js";
 
 const EMPTY_GEOMETRY = new BufferGeometry();
 
@@ -53,6 +53,8 @@ const SERIALIZABLE_FLAGS = ParticleEmitterFlag.PreWarm
  */
 const corners = new Float64Array(24);
 
+const scratch_near_plane_normal = new Float32Array(3);
+
 /**
  *
  * @type {number[]}
@@ -81,16 +83,16 @@ function generateStandardParameterSet(parameters) {
 }
 
 
-const uint16_mul = 65536;
+const UINT16_MAX = 65535; // = 2^16 - 1
 
 /**
  *
- * @param {AtlasPatch} atlasPatch
+ * @param {AtlasPatch} patch
  * @param {ParticlePool} particles
  * @param {number} ref
  */
-function write_particle_patch_uv(atlasPatch, particles, ref) {
-    const uv = atlasPatch.uv;
+function write_particle_patch_uv(patch, particles, ref) {
+    const uv = patch.uv;
 
     const uv_position = uv.position;
 
@@ -105,96 +107,101 @@ function write_particle_patch_uv(atlasPatch, particles, ref) {
     particles.writeAttributeVector4(
         ref,
         PARTICLE_ATTRIBUTE_UV,
-        u0 * uint16_mul, v0 * uint16_mul, u1 * uint16_mul, v1 * uint16_mul
+        u0 * UINT16_MAX, v0 * UINT16_MAX, u1 * UINT16_MAX, v1 * UINT16_MAX
     );
 }
 
 export class ParticleEmitter {
-    constructor() {
-        /**
-         * @type {ParameterSet}
-         */
-        this.parameters = new ParameterSet();
-        generateStandardParameterSet(this.parameters);
 
+    /**
+     * @private
+     * @type {List<ParticleLayer>}
+     */
+    layers = new List();
 
-        /**
-         * @private
-         * @type {List<ParticleLayer>}
-         */
-        this.layers = new List();
+    /**
+     *
+     * @type {Vector3}
+     */
+    position = new Vector3(0, 0, 0);
+    scale = new Vector3(1, 1, 1);
+    rotation = new Quaternion(0, 0, 0, 1);
 
-        /**
-         *
-         * @type {Vector3}
-         */
-        this.position = new Vector3(0, 0, 0);
-        this.scale = new Vector3(1, 1, 1);
-        this.rotation = new Quaternion(0, 0, 0, 1);
+    /**
+     *
+     * @type {Vector3}
+     * @private
+     */
+    __lastSpawnPosition = new Vector3(0, 0, 0);
 
-        /**
-         *
-         * @type {Vector3}
-         * @private
-         */
-        this.__lastSpawnPosition = new Vector3(0, 0, 0);
+    /**
+     * How long has this emitter been sleeping for?
+     * This amount of time needs to be simulated when we wake the emitter up, but we can typically do it in a small number of large steps
+     * @type {number}
+     */
+    sleepTime = 0;
 
-        this.sleepTime = 0;
+    /**
+     *
+     * @type {BlendingType|number}
+     */
+    blendingMode = BlendingType.Normal;
 
-        /**
-         *
-         * @type {BlendingType|number}
-         */
-        this.blendingMode = BlendingType.Normal;
+    /**
+     *
+     * @type {ParticlePool|null}
+     */
+    particles = null;
 
-        /**
-         *
-         * @type {ParticlePool|null}
-         */
-        this.particles = null;
+    /**
+     *
+     * @type {Object3D|null}
+     */
+    mesh = null;
 
-        /**
-         *
-         * @type {Object3D|null}
-         */
-        this.mesh = null;
+    /**
+     *
+     * @type {LeafNode}
+     */
+    bvhLeaf = new LeafNode(this, 0, 0, 0, 0, 0, 0);
 
+    /**
+     *
+     * @type {AABB3}
+     */
+    particleBounds = new AABB3(Infinity, Infinity, Infinity, -Infinity, -Infinity, -Infinity);
 
-        /**
-         *
-         * @type {LeafNode}
-         */
-        this.bvhLeaf = new LeafNode(this, 0, 0, 0, 0, 0, 0);
+    /**
+     *
+     * @type {AABB3}
+     */
+    emissionBounds = new AABB3(0, 0, 0, 0, 0, 0);
 
 
-        /**
-         *
-         * @type {AABB3}
-         */
-        this.particleBounds = new AABB3(Infinity, Infinity, Infinity, -Infinity, -Infinity, -Infinity);
+    /**
+     * Bit Field of {@link ParticleEmitterFlag}
+     * @type {number}
+     */
+    flags = ParticleEmitterFlag.DepthSorting | ParticleEmitterFlag.HashNeedUpdate | ParticleEmitterFlag.Emitting;
 
+    /**
+     *
+     * @type {number}
+     * @private
+     */
+    __hash = 0;
+
+    constructor() {
         /**
-         *
-         * @type {AABB3}
+         * @type {ParameterSet}
          */
-        this.emisionBounds = new AABB3(0, 0, 0, 0, 0, 0);
+        this.parameters = new ParameterSet();
+        generateStandardParameterSet(this.parameters);
+
 
         this.position.onChanged.add(this.updateTransform, this);
         this.scale.onChanged.add(this.updateTransform, this);
         this.rotation.onChanged.add(this.updateTransform, this);
-
-        /**
-         * Bit Field of {@link ParticleEmitterFlag}
-         * @type {number}
-         */
-        this.flags = ParticleEmitterFlag.DepthSorting | ParticleEmitterFlag.HashNeedUpdate | ParticleEmitterFlag.Emitting;
-
-        /**
-         *
-         * @type {number}
-         * @private
-         */
-        this.__hash = 0;
     }
 
     updateTransform() {
@@ -442,9 +449,7 @@ export class ParticleEmitter {
         const rotation = this.rotation;
         const scale = this.scale;
 
-        composeMatrix4(matrix4, position, rotation, scale);
-
-        const m4 = matrix4.elements;
+        compose_matrix4_array(matrix4, position, rotation, scale);
 
         for (let i = 0; i < numLayers; i++) {
             const particleLayer = layers.get(i);
@@ -463,9 +468,9 @@ export class ParticleEmitter {
                 const z = corners[j + 2];
 
                 //apply matrix transform
-                const _x = m4[0] * x + m4[4] * y + m4[8] * z + m4[12];
-                const _y = m4[1] * x + m4[5] * y + m4[9] * z + m4[13];
-                const _z = m4[2] * x + m4[6] * y + m4[10] * z + m4[14];
+                const _x = matrix4[0] * x + matrix4[4] * y + matrix4[8] * z + matrix4[12];
+                const _y = matrix4[1] * x + matrix4[5] * y + matrix4[9] * z + matrix4[13];
+                const _z = matrix4[2] * x + matrix4[6] * y + matrix4[10] * z + matrix4[14];
 
 
                 //update bounds
@@ -479,7 +484,7 @@ export class ParticleEmitter {
             }
         }
 
-        this.emisionBounds.setBounds(
+        this.emissionBounds.setBounds(
             bounds_x0, bounds_y0, bounds_z0,
             bounds_x1, bounds_y1, bounds_z1
         );
@@ -534,7 +539,7 @@ export class ParticleEmitter {
             this.computeParticleBounds();
         }
 
-        const ebb = this.emisionBounds;
+        const ebb = this.emissionBounds;
         const pbb = this.particleBounds;
 
         const bounds_x0 = min2(ebb.x0, pbb.x0);
@@ -732,6 +737,7 @@ export class ParticleEmitter {
         assert.notNull(camera, 'camera');
 
         //sort particles by distance from camera to ensure proper rendering order
+        // NOTE we don't use full distance calculation, but DOT product instead, as the final component is always the same and we only care about relative distance for comparison
 
         /**
          *
@@ -748,10 +754,11 @@ export class ParticleEmitter {
         frustum_from_camera(camera, frustum);
         const nearPlane = frustum.planes[0];
         const nearPlaneNormal = nearPlane.normal;
+        nearPlaneNormal.toArray(scratch_near_plane_normal);
 
         //Bind attribute array directly for faster access
         const positionAttribute = particles.attributes[PARTICLE_ATTRIBUTE_POSITION];
-        const positionArray = positionAttribute.array;
+        const position_array = positionAttribute.array;
 
 
         if (particleCount <= 1) {
@@ -777,18 +784,18 @@ export class ParticleEmitter {
             i = left;
             j = right;
 
-            const pivotIndex = (left + right) >> 1;
+            const pivot_index = (left + right) >> 1;
 
-            const pivot = distance_to_camera(pivotIndex, positionArray, nearPlaneNormal);
+            const pivot = v3_dot_array_array(position_array, pivot_index * 3, scratch_near_plane_normal, 0);
 
             /* partition */
             while (i <= j) {
 
-                while (distance_to_camera(i, positionArray, nearPlaneNormal) > pivot) {
+                while (v3_dot_array_array(position_array, i * 3, scratch_near_plane_normal, 0) > pivot) {
                     i++;
                 }
 
-                while (distance_to_camera(j, positionArray, nearPlaneNormal) < pivot) {
+                while (v3_dot_array_array(position_array, j * 3, scratch_near_plane_normal, 0) < pivot) {
                     j--;
                 }
 
@@ -912,7 +919,7 @@ export class ParticleEmitter {
         const emitter_position = this.position;
         const last_spawn_position = this.__lastSpawnPosition;
 
-        composeMatrix4(matrix4, emitter_position, this.rotation, this.scale);
+        compose_matrix4_array(matrix4, emitter_position, this.rotation, this.scale);
 
         let time = -layer.timeSinceLastEmission;
 
@@ -935,13 +942,13 @@ export class ParticleEmitter {
 
             if (this.getFlag(ParticleEmitterFlag.PositionChanged)) {
                 //compute position in between
-                matrix4.elements[12] = lerp(emitter_position.x, last_spawn_position.x, f);
-                matrix4.elements[13] = lerp(emitter_position.y, last_spawn_position.y, f);
-                matrix4.elements[14] = lerp(emitter_position.z, last_spawn_position.z, f);
+                matrix4[12] = lerp(emitter_position.x, last_spawn_position.x, f);
+                matrix4[13] = lerp(emitter_position.y, last_spawn_position.y, f);
+                matrix4[14] = lerp(emitter_position.z, last_spawn_position.z, f);
             }
 
             //apply emitter transform
-            v3position.applyMatrix4_three(matrix4);
+            v3position.applyMatrix4(matrix4);
 
 
             //randomize initial age across time delta
@@ -1032,7 +1039,7 @@ export class ParticleEmitter {
         const emissionFunction = computeEmissionFunction(layer.emissionFrom, layer.emissionShape);
 
         //compute transform matrix of the emitter
-        composeMatrix4(matrix4, this.position, this.rotation, this.scale);
+        compose_matrix4_array(matrix4, this.position, this.rotation, this.scale);
 
         //pre-grow particle pool
         particles.growCapacity(particles.capacity + count);
@@ -1052,7 +1059,7 @@ export class ParticleEmitter {
             v3position.add(layer.position);
 
             //apply emitter transform
-            v3position.applyMatrix4_three(matrix4);
+            v3position.applyMatrix4(matrix4);
 
 
             //randomize initial age across time delta
@@ -1212,7 +1219,7 @@ ParticleEmitter.Attributes = {
 ParticleEmitter.SERIALIZABLE_FLAGS = SERIALIZABLE_FLAGS;
 
 
-const matrix4 = new Matrix4();
+const matrix4 = new Float32Array(16);
 
 const defaultPointsMaterial = new PointsMaterial({ color: 0xFFFFFF });
 

package/src/engine/graphics/particles/particular/engine/emitter/ParticleLayer.spec.js

@@ -73,3 +73,28 @@ test('BinaryBuffer serialization consistency', () => {
     expect(actual.particleVelocityDirection.roughlyEquals(expected.particleVelocityDirection)).toBe(true);
     expect(actual.particleSpeed.equals(expected.particleSpeed)).toBe(true);
 });
+
+
+test("hash - basics", () => {
+    const layer = new ParticleLayer();
+
+    const hash = layer.hash();
+
+    expect(layer.hash()).toEqual(hash); // consistency
+    expect(typeof hash).toBe("number");
+    expect(Number.isInteger(hash)).toBe(true);
+});
+
+test("equals - basics", () => {
+    const a = new ParticleLayer();
+
+    expect(a.equals(a)).toBe(true);
+
+    const b = new ParticleLayer();
+
+    expect(a.equals(b)).toBe(true);
+
+    b.emissionRate++;
+
+    expect(a.equals(b)).toBe(false);
+});

package/src/engine/graphics/particles/particular/engine/emitter/ParticlePool.js

@@ -231,41 +231,6 @@ export class ParticlePool {
         }
     }
 
-    /**
-     *
-     * @param {AttributeSpec} spec
-     * @return {number}
-     * @private
-     */
-    __compute_attribute_byte_size(spec) {
-
-        const item_size = spec.itemSize;
-
-        const TypedArrayConstructor = compute_typed_array_constructor_from_data_type(spec.type);
-
-        const element_byte_size = TypedArrayConstructor.BYTES_PER_ELEMENT;
-
-        return item_size * element_byte_size * this.capacity;
-    }
-
-    /**
-     *
-     * @return {number}
-     * @private
-     */
-    __compute_attribute_byte_size_total() {
-
-        const spec_attributes = this.spec.attributes;
-        const l = spec_attributes.length;
-
-        let r = 0;
-        for (let i = 0; i < l; i++) {
-            r += this.__compute_attribute_byte_size(spec_attributes[i]);
-        }
-
-        return r;
-    }
-
     build() {
         const geometry = new BufferGeometry();
         geometry.dynamic = true;

package/src/engine/graphics/particles/particular/engine/emitter/ParticlePool.spec.js

@@ -10,8 +10,8 @@ import { AttributeSpec } from "../../../../geometry/AttributeSpec.js";
 function samplePool() {
     const specification = new VertexDataSpec();
 
-    specification.add(AttributeSpec.fromJSON({name:'a', type:BinaryDataType.Float32, itemSize:1}));
-    specification.add(AttributeSpec.fromJSON({name:'b', type:BinaryDataType.Float32, itemSize:4}));
+    specification.add(AttributeSpec.fromJSON({ name: 'a', type: BinaryDataType.Float32, itemSize: 1 }));
+    specification.add(AttributeSpec.fromJSON({ name: 'b', type: BinaryDataType.Float32, itemSize: 4 }));
 
     const pool = new ParticlePool(specification);
 
@@ -186,3 +186,40 @@ test('read/write scalar attribute', () => {
 
     expect(pool.readAttributeScalar(1, 0)).toBe(42);
 });
+
+
+test("update on empty pool", () => {
+
+    const pool = samplePool();
+
+    expect(pool.size()).toBe(0);
+
+    pool.update();
+
+    expect(pool.size()).toBe(0);
+
+    pool.update();
+
+    expect(pool.size()).toBe(0);
+});
+
+test("swap", () => {
+
+    const pool = samplePool();
+
+    populatePool(pool, 2);
+
+    pool.writeAttributeScalar(0, 0, 17);
+    pool.writeAttributeScalar(1, 0, 23);
+
+    pool.swap(0, 1);
+
+    expect(pool.readAttributeScalar(0, 0)).toBe(23);
+    expect(pool.readAttributeScalar(1, 0)).toBe(17);
+});
+
+test("calling dispose on newly created instance should not throw", () => {
+    const pool = samplePool();
+
+    pool.dispose();
+});

package/src/engine/graphics/particles/particular/engine/renderers/billboard/prototypeBillboardRenderer.js

@@ -7,7 +7,7 @@ import { writeSample2DDataToDataTexture } from "../../../../../texture/sampler/w
 import { ImageRGBADataLoader } from "../../../../../../asset/loaders/image/ImageRGBADataLoader.js";
 import { EngineConfiguration } from "../../../../../../EngineConfiguration.js";
 import { MeshSystem } from "../../../../../ecs/mesh/MeshSystem.js";
-import EntityBuilder from "../../../../../../ecs/EntityBuilder.js";
+import Entity from "../../../../../../ecs/Entity.js";
 import { Transform } from "../../../../../../ecs/transform/Transform.js";
 import Mesh from "../../../../../ecs/mesh/Mesh.js";
 import Vector3 from "../../../../../../../core/geom/Vector3.js";
@@ -155,7 +155,7 @@ async function main(engine) {
     });
 
 
-    new EntityBuilder()
+    new Entity()
         .add(Mesh.fromJSON({ url: 'data/models/Jauntmessina/Red_Robot/gltf/Model.gltf' }))
         .add(new Transform())
         .build(ecd)

package/src/engine/graphics/particles/particular/engine/shader/ShaderManager.js

@@ -88,6 +88,12 @@ function buildDataTexture(
 }
 
 export class ShaderManager {
+    /**
+     *
+     * @type {Map<ParticleLayer, Reference<AtlasPatch>>}
+     */
+    #sprite_references = new Map();
+
     /**
      *
      * @param {AssetManager} assetManager
@@ -107,7 +113,6 @@ export class ShaderManager {
          * @type {ManagedAtlas}
          */
         this.spriteAtlas = new ManagedAtlas(assetManager);
-        this.spriteAtlas.autoUpdate = false;
 
         /**
          *
@@ -275,9 +280,12 @@ export class ShaderManager {
 
             const patchPromise = spriteAtlas.acquire(layer.imageURL);
 
-            patchPromise.then(function (patch) {
-                layer.setAtlasPatch(patch);
-            }, (e) => {
+            patchPromise.then(ref => {
+                this.#sprite_references.set(layer, ref);
+                layer.setAtlasPatch(ref.getValue());
+            });
+
+            patchPromise.catch((e) => {
                 console.warn(`Failed to load sprite '${layer.imageURL}':`, e);
             });
         }
@@ -349,7 +357,7 @@ export class ShaderManager {
         const entry = this.materialMap.get(emitter);
 
         if (entry === undefined) {
-            console.error(`Attempted to deregisted emitter that was not registered (not found in materialMap). Request ignored.`, emitter);
+            console.error(`Attempted to deregister emitter that was not registered (not found in materialMap). Request ignored.`, emitter);
             return;
         }
 
@@ -363,7 +371,15 @@ export class ShaderManager {
         const layer_count = particle_layers.length;
         for (let i = 0; i < layer_count; i++) {
             const layer = particle_layers.get(i);
-            spriteAtlas.release(layer.imageURL);
+
+            // TODO deal with the case where we remove the layer before sprite is loaded
+            const ref = this.#sprite_references.get(layer);
+
+            if (ref !== undefined) {
+                ref.release();
+            }
+
+            layer.setAtlasPatch(null); // clear patch
         }
 
         if (entry.count <= 0) {

package/src/engine/graphics/particles/particular/engine/utils/volume/ParticleVolume.d.ts

@@ -1,4 +1,4 @@
-import EntityBuilder from "../../../../../../ecs/EntityBuilder";
+import Entity from "../../../../../../ecs/Entity";
 import {AbstractShape3D} from "../../../../../../../core/geom/3d/shape/AbstractShape3D";
 import {AttributeValue} from "./AttributeValue";
 import {SamplingFunctionKind} from "./SamplingFunctionKind";
@@ -17,7 +17,7 @@ interface Attributes {
 }
 
 export class ParticleVolume {
-    readonly entity: EntityBuilder
+    readonly entity: Entity
 
     from(args?: Args): void