@woosh/meep-engine 3.0.0 → 3.0.2

package/src/engine/graphics/particles/particular/engine/ParticularEngine.js

@@ -1,253 +1,229 @@
-import { BVH } from "../../../../../core/bvh2/bvh3/BVH.js";
-import List from "../../../../../core/collection/list/List.js";
-import { ParticleEmitterFlag } from "./emitter/ParticleEmitterFlag.js";
-import { ShaderManager } from "./shader/ShaderManager.js";
-import { SimulationStepApplyForce } from "./simulator/SimulationStepApplyForce.js";
-import { SimulationStepCurlNoiseAcceleration } from "./simulator/SimulationStepCurlNoiseAcceleration.js";
-import { SimulationStepCurlNoiseVelocity } from "./simulator/SimulationStepCurlNoiseVelocity.js";
-import { SimulationStepFixedPhysics } from "./simulator/SimulationStepFixedPhysics.js";
-
-
-export class ParticularEngine {
-    /**
-     *
-     * @type {THREE.Camera|null}
-     */
-    camera = null;
-
-    /**
-     * Managed emitters
-     * @type {List.<ParticleEmitter>}
-     */
-    emitters = new List();
-
-    /**
-     * @readonly
-     * @type {BVH}
-     */
-    bvh = new BVH();
-
-
-    /**
-     *
-     * @type {AbstractSimulationStep[]}
-     */
-    steps = [
-        new SimulationStepFixedPhysics(),
-        new SimulationStepCurlNoiseAcceleration(),
-        new SimulationStepCurlNoiseVelocity(),
-        new SimulationStepApplyForce()
-    ];
-
-    /**
-     *
-     * @param {AssetManager} assetManager
-     * @param {MaterialManager} material_manager
-     * @constructor
-     */
-    constructor(assetManager, material_manager) {
-        this.shaderManager = new ShaderManager(assetManager, material_manager);
-    }
-
-    /**
-     *
-     * @param {ParticleEmitter} emitter
-     */
-    add(emitter) {
-        if (!emitter.getFlag(ParticleEmitterFlag.Built)) {
-            emitter.build();
-        }
-
-        //mark sprites for update as their UVs might have changed since last usage
-        emitter.setFlag(ParticleEmitterFlag.SpritesNeedUpdate);
-
-        this.emitters.add(emitter);
-
-        this.shaderManager.register(emitter);
-
-        emitter.bvh_leaf.link(this.bvh, emitter.id);
-    }
-
-    /**
-     *
-     * @param {ParticleEmitter} emitter
-     * @returns {boolean}
-     */
-    remove(emitter) {
-
-        const removed = this.emitters.removeOneOf(emitter);
-
-        if (!removed) {
-            return false;
-        }
-
-        this.shaderManager.deregister(emitter);
-
-        emitter.bvh_leaf.unlink();
-
-        return true;
-    }
-
-    /**
-     *
-     * @param {THREE.Camera} camera
-     */
-    setCamera(camera) {
-        this.camera = camera;
-        this.shaderManager.setCamera(camera);
-    }
-
-    setDepthTexture(texture) {
-        this.shaderManager.setDepthTexture(texture);
-    }
-
-    setViewportSize(x, y) {
-        this.shaderManager.setViewportSize(x, y);
-    }
-
-    /**
-     * Hand back the resources held on behalf of the managed emitters. Emitters themselves are owned by
-     * their components and are disposed by {@link ParticleEmitter#dispose} as they are removed.
-     */
-    dispose() {
-        this.shaderManager.dispose();
-    }
-
-    /**
-     * @private
-     * @param {ParticleEmitter} emitter
-     * @param {number} timeDelta
-     */
-    advanceEmitter(emitter, timeDelta) {
-        let i, j;
-
-
-        /**
-         *
-         * @type {List<ParticleLayer>}
-         */
-        const layers = emitter.layers;
-
-        const layer_count = layers.length;
-
-        let step_mask = 0;
-
-        const steps = this.steps;
-
-        for (j = 0; j < layer_count; j++) {
-            const particleLayer = layers.get(j);
-
-            const simulationStepDefinitions = particleLayer.steps;
-
-            const n = simulationStepDefinitions.length;
-
-            for (i = 0; i < n; i++) {
-                /**
-                 *
-                 * @type {SimulationStepDefinition}
-                 */
-                const stepDefinition = simulationStepDefinitions.get(i);
-
-                const type = stepDefinition.type;
-
-                step_mask |= 1 << type;
-
-                const step = steps[type];
-
-                if (step === undefined) {
-                    // no step definition
-                    continue;
-                }
-
-                step.emitter = emitter;
-                step.timeDelta = timeDelta;
-                step.particles = emitter.particles;
-                step.layer_parameters[j] = stepDefinition.parameters;
-                step.includeLayer(j);
-
-            }
-        }
-
-        // apply simulation steps
-        const step_index_limit = steps.length;
-
-        for (i = 0; i < step_index_limit; i++) {
-            const m = 1 << i;
-            const is_used = (step_mask & m) !== 0;
-
-            if (is_used) {
-                const step = steps[i];
-
-                step.layer_count = layer_count;
-
-                step.execute();
-
-                step.clear();
-            }
-        }
-
-        emitter.advance(timeDelta);
-
-    }
-
-    /**
-     * @private
-     * @param {ParticleEmitter} emitter
-     * @param {number} timeDelta
-     */
-    updateEmitter(emitter, timeDelta) {
-        if (emitter.getFlag(ParticleEmitterFlag.Sleeping)) {
-            emitter.sleepTime += timeDelta;
-        } else {
-
-            if (!emitter.getFlag(ParticleEmitterFlag.Initialized)) {
-                emitter.initialize();
-            }
-
-            if (emitter.sleepTime > 0) {
-                //emitter was sleeping, need to catch up the simulation
-                const maxParticleLife = emitter.computeMaxEmittingParticleLife();
-
-                let wakingTime = Math.min(emitter.sleepTime, maxParticleLife - timeDelta);
-
-                const minWakingIncrement = 0.15;
-
-                const maxWakingSteps = 10;
-
-                const wakingIncrement = Math.max(wakingTime / maxWakingSteps, minWakingIncrement);
-
-                while (wakingTime > 0) {
-                    const wakingStep = Math.min(wakingIncrement, wakingTime);
-
-                    this.advanceEmitter(emitter, wakingStep);
-
-                    wakingTime -= wakingStep;
-                }
-
-                //consume the sleep time
-                emitter.sleepTime = 0;
-            }
-
-            //advance simulation
-            this.advanceEmitter(emitter, timeDelta);
-
-            //update bounding box
-            emitter.computeBoundingBox();
-        }
-    }
-
-    /**
-     *
-     * @param {number} timeDelta
-     */
-    advance(timeDelta) {
-        const emitters = this.emitters;
-
-        const numEmitters = emitters.length;
-
-        for (let i = 0; i < numEmitters; i++) {
-            const emitter = emitters.get(i);
-            this.updateEmitter(emitter, timeDelta);
-        }
-    }
-}
+import { BVH } from "../../../../../core/bvh2/bvh3/BVH.js";
+import List from "../../../../../core/collection/list/List.js";
+import { ParticleEmitterFlag } from "./emitter/ParticleEmitterFlag.js";
+import { ShaderManager } from "./shader/ShaderManager.js";
+import { SimulationStepApplyForce } from "./simulator/SimulationStepApplyForce.js";
+import { SimulationStepCurlNoiseAcceleration } from "./simulator/SimulationStepCurlNoiseAcceleration.js";
+import { SimulationStepCurlNoiseVelocity } from "./simulator/SimulationStepCurlNoiseVelocity.js";
+import { SimulationStepFixedPhysics } from "./simulator/SimulationStepFixedPhysics.js";
+
+
+export class ParticularEngine {
+    /**
+     * Managed emitters
+     * @type {List.<ParticleEmitter>}
+     */
+    emitters = new List();
+
+    /**
+     * @readonly
+     * @type {BVH}
+     */
+    bvh = new BVH();
+
+
+    /**
+     *
+     * @type {AbstractSimulationStep[]}
+     */
+    steps = [
+        new SimulationStepFixedPhysics(),
+        new SimulationStepCurlNoiseAcceleration(),
+        new SimulationStepCurlNoiseVelocity(),
+        new SimulationStepApplyForce()
+    ];
+
+    /**
+     *
+     * @param {AssetManager} assetManager
+     * @constructor
+     */
+    constructor(assetManager) {
+        this.shaderManager = new ShaderManager(assetManager);
+    }
+
+    /**
+     *
+     * @param {ParticleEmitter} emitter
+     */
+    add(emitter) {
+        if (!emitter.getFlag(ParticleEmitterFlag.Built)) {
+            emitter.build();
+        }
+
+        //mark sprites for update as their UVs might have changed since last usage
+        emitter.setFlag(ParticleEmitterFlag.SpritesNeedUpdate);
+
+        this.emitters.add(emitter);
+
+        this.shaderManager.register(emitter);
+
+        emitter.bvh_leaf.link(this.bvh, emitter.id);
+    }
+
+    /**
+     *
+     * @param {ParticleEmitter} emitter
+     * @returns {boolean}
+     */
+    remove(emitter) {
+
+        const removed = this.emitters.removeOneOf(emitter);
+
+        if (!removed) {
+            return false;
+        }
+
+        this.shaderManager.deregister(emitter);
+
+        emitter.bvh_leaf.unlink();
+
+        return true;
+    }
+
+    /**
+     * Hand back the resources held on behalf of the managed emitters. Emitters themselves are owned by
+     * their components and are disposed by {@link ParticleEmitter#dispose} as they are removed.
+     */
+    dispose() {
+        this.shaderManager.dispose();
+    }
+
+    /**
+     * @private
+     * @param {ParticleEmitter} emitter
+     * @param {number} timeDelta
+     */
+    advanceEmitter(emitter, timeDelta) {
+        let i, j;
+
+
+        /**
+         *
+         * @type {List<ParticleLayer>}
+         */
+        const layers = emitter.layers;
+
+        const layer_count = layers.length;
+
+        let step_mask = 0;
+
+        const steps = this.steps;
+
+        for (j = 0; j < layer_count; j++) {
+            const particleLayer = layers.get(j);
+
+            const simulationStepDefinitions = particleLayer.steps;
+
+            const n = simulationStepDefinitions.length;
+
+            for (i = 0; i < n; i++) {
+                /**
+                 *
+                 * @type {SimulationStepDefinition}
+                 */
+                const stepDefinition = simulationStepDefinitions.get(i);
+
+                const type = stepDefinition.type;
+
+                step_mask |= 1 << type;
+
+                const step = steps[type];
+
+                if (step === undefined) {
+                    // no step definition
+                    continue;
+                }
+
+                step.emitter = emitter;
+                step.timeDelta = timeDelta;
+                step.particles = emitter.particles;
+                step.layer_parameters[j] = stepDefinition.parameters;
+                step.includeLayer(j);
+
+            }
+        }
+
+        // apply simulation steps
+        const step_index_limit = steps.length;
+
+        for (i = 0; i < step_index_limit; i++) {
+            const m = 1 << i;
+            const is_used = (step_mask & m) !== 0;
+
+            if (is_used) {
+                const step = steps[i];
+
+                step.layer_count = layer_count;
+
+                step.execute();
+
+                step.clear();
+            }
+        }
+
+        emitter.advance(timeDelta);
+
+    }
+
+    /**
+     * @private
+     * @param {ParticleEmitter} emitter
+     * @param {number} timeDelta
+     */
+    updateEmitter(emitter, timeDelta) {
+        if (emitter.getFlag(ParticleEmitterFlag.Sleeping)) {
+            emitter.sleepTime += timeDelta;
+        } else {
+
+            if (!emitter.getFlag(ParticleEmitterFlag.Initialized)) {
+                emitter.initialize();
+            }
+
+            if (emitter.sleepTime > 0) {
+                //emitter was sleeping, need to catch up the simulation
+                const maxParticleLife = emitter.computeMaxEmittingParticleLife();
+
+                let wakingTime = Math.min(emitter.sleepTime, maxParticleLife - timeDelta);
+
+                const minWakingIncrement = 0.15;
+
+                const maxWakingSteps = 10;
+
+                const wakingIncrement = Math.max(wakingTime / maxWakingSteps, minWakingIncrement);
+
+                while (wakingTime > 0) {
+                    const wakingStep = Math.min(wakingIncrement, wakingTime);
+
+                    this.advanceEmitter(emitter, wakingStep);
+
+                    wakingTime -= wakingStep;
+                }
+
+                //consume the sleep time
+                emitter.sleepTime = 0;
+            }
+
+            //advance simulation
+            this.advanceEmitter(emitter, timeDelta);
+
+            //update bounding box
+            emitter.computeBoundingBox();
+        }
+    }
+
+    /**
+     *
+     * @param {number} timeDelta
+     */
+    advance(timeDelta) {
+        const emitters = this.emitters;
+
+        const numEmitters = emitters.length;
+
+        for (let i = 0; i < numEmitters; i++) {
+            const emitter = emitters.get(i);
+            this.updateEmitter(emitter, timeDelta);
+        }
+    }
+}

package/src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.d.ts

@@ -45,11 +45,6 @@ export class ParticleEmitter {
      * @type {ParticlePool|null}
      */
     particles: ParticlePool | null;
-    /**
-     *
-     * @type {Object3D|null}
-     */
-    mesh: Object3D | null;
     /**
      * @readonly
      * @type {BvhClient}
@@ -114,12 +109,20 @@ export class ParticleEmitter {
     toJSON(): {
         position: {
             x: number;
-            y: number;
+            y: number; /**
+             * @private
+             * @param {int} layerIndex
+             * @param {number} timeDelta period over which particles are being spawned, this will ensure that spawned particles have different initial age
+             */
             z: number;
         };
         scale: {
             x: number;
-            y: number;
+            y: number; /**
+             * @private
+             * @param {int} layerIndex
+             * @param {number} timeDelta period over which particles are being spawned, this will ensure that spawned particles have different initial age
+             */
             z: number;
         };
         rotation: {
@@ -159,7 +162,6 @@ export class ParticleEmitter {
     computeEmissionBounds(): void;
     computeParticleBounds(): void;
     computeBoundingBox(): void;
-    updateGeometryBounds(): void;
     /**
      * @param {number} limit longest maximum life per layer, layers that exceed this value are ignored. Measured in seconds
      * @returns {number} in seconds
@@ -175,11 +177,22 @@ export class ParticleEmitter {
      */
     equals(other: ParticleEmitter): boolean;
     /**
-     * PRECONDITION: no dead particles may exist in the pool. Make sure to call {@link ParticlePool#compact} before sorting
-     * @protected
-     * @param {Camera} camera THREE.js camera object
+     * Order the live particles back to front along a view direction, so that whoever draws them
+     * blends them in the right order.
+     *
+     * **The direction is the caller's**, because only whoever is drawing knows which way the frame
+     * is being looked from. The predecessor took it off a three camera and read `planes[0]` of the
+     * frustum calling it the near plane, where three's plane order puts the *right* one — so the
+     * ordering it produced ran across the screen rather than into it.
+     *
+     * PRECONDITION: no dead particles may exist in the pool. Make sure to call
+     * {@link ParticlePool#compact} before sorting.
+     *
+     * @param {number} direction_x unit view direction, pointing away from the viewer
+     * @param {number} direction_y
+     * @param {number} direction_z
      */
-    protected sort(camera: Camera): void;
+    sort(direction_x: number, direction_y: number, direction_z: number): void;
     update(): void;
     /**
      *

package/src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ParticleEmitter.d.ts","sourceRoot":"","sources":["../../../../../../../../src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.js"],"names":[],"mappings":"AA2FA;IA0iCI;;;;OAIG;IACH,4BAFa,eAAe,CAM3B;IAljCD;;OAEG;IACH,IAFU,MAAM,CAEE;IAElB;;;;OAIG;IACH,wBAAoB;IAEpB;;;OAGG;IACH,UAFU,OAAO,CAEe;IAChC,eAA6B;IAC7B,qBAAsC;IAEtC;;;;;OAKG;IACH,qCAA2C;IAE3C;;;;OAIG;IACH,WAFU,MAAM,CAEF;IAEd;;;OAGG;IACH,cAFU,YAAY,GAAC,MAAM,CAEM;IAEnC;;;OAGG;IACH,WAFU,YAAY,GAAC,IAAI,CAEV;IAEjB;;;OAGG;IACH,MAFU,WAAS,IAAI,CAEX;IAEZ;;;OAGG;IACH,mBAFU,SAAS,CAEQ;IAG3B;;;;OAIG;IACH,yBAFU,KAAK,CAE2E;IAE1F;;;OAGG;IACH,yBAFU,KAAK,CAE8B;IAG7C;;;OAGG;IACH,OAFU,MAAM,CAE6F;IAE7G;;;;OAIG;IACH,eAAW;IAGX;;;OAGG;IACH,qBAFU,YAAY,CAEU;IAWhC,wBAIC;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,mBAAmB,GACxB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,mBAAmB,GACxB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,mBAAmB,SAC1B,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,mBAAmB,GACxB,OAAO,CAInB;IAED;;OAEG;IACH,gCAaC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;MAeC;IAED,0BAkEC;IAGD;;;OAGG;IACH,gBAFW,aAAa,QASvB;IAED;;;;OAIG;IACH,gCAHmB,aAAa,SAAS,MAAM,KAAK,IAAI,uBAavD;IAED;;;;OAIG;IACH,iCAHW,aAAa,GACZ,MAAM,CA2CjB;IAED,8BA0DC;IAED,8BAmBC;IAED,2BAmBC;IAED,6BAkBC;IAED;;;OAGG;IACH,uCAHW,MAAM,GACJ,MAAM,CA+BlB;IAED,cAuCC;IAED,mBA6BC;IAuBD,eAOC;IAED;;;;OAIG;IACH,cAHW,eAAe,GACb,OAAO,CASnB;IAED;;;;OAIG;IACH,qCA2FC;IAED,eAOC;IAED;;;OAGG;IACH,4BAFY,MAAM,CAejB;IAED;;;OAGG;IACH,mBAFW,MAAM,QAMhB;IAiCD;;;;OAIG;IACH,sCA+GC;IAED;;;;OAIG;IACH,qCA6GC;IAED;;;OAGG;IACH,aA4CC;IAGD;;OAEG;IACH,gBAIC;;CAYJ;;;;;;;;;;;;;;;;oBAnoCmB,wCAAwC;uBAFrC,2CAA2C;6BAOrC,6CAA6C;6BAqB7C,mBAAmB;0BApCtB,+CAA+C;sBAInD,8CAA8C;6BAYvC,8BAA8B;oCAiBvB,0BAA0B;8BAChC,oBAAoB;uCAF3C,0BAA0B;6CAA1B,0BAA0B;kDAA1B,0BAA0B;4CAA1B,0BAA0B;4CAA1B,0BAA0B;kDAA1B,0BAA0B;wCAA1B,0BAA0B;sCAA1B,0BAA0B;4CAA1B,0BAA0B;AAWjC,yCAKC"}
+{"version":3,"file":"ParticleEmitter.d.ts","sourceRoot":"","sources":["../../../../../../../../src/engine/graphics/particles/particular/engine/emitter/ParticleEmitter.js"],"names":[],"mappings":"AAuFA;IAqgCI;;;;OAIG;IACH,4BAFa,eAAe,CAM3B;IA7gCD;;OAEG;IACH,IAFU,MAAM,CAEE;IAElB;;;;OAIG;IACH,wBAAoB;IAEpB;;;OAGG;IACH,UAFU,OAAO,CAEe;IAChC,eAA6B;IAC7B,qBAAsC;IAEtC;;;;;OAKG;IACH,qCAA2C;IAE3C;;;;OAIG;IACH,WAFU,MAAM,CAEF;IAEd;;;OAGG;IACH,cAFU,YAAY,GAAC,MAAM,CAEM;IAEnC;;;OAGG;IACH,WAFU,YAAY,GAAC,IAAI,CAEV;IAEjB;;;OAGG;IACH,mBAFU,SAAS,CAEQ;IAG3B;;;;OAIG;IACH,yBAFU,KAAK,CAE2E;IAE1F;;;OAGG;IACH,yBAFU,KAAK,CAE8B;IAG7C;;;OAGG;IACH,OAFU,MAAM,CAE6F;IAE7G;;;;OAIG;IACH,eAAW;IAGX;;;OAGG;IACH,qBAFU,YAAY,CAEU;IAWhC,wBAIC;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,mBAAmB,GACxB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,mBAAmB,GACxB,IAAI,CAIhB;IAED;;;;OAIG;IACH,gBAHW,MAAM,GAAC,mBAAmB,SAC1B,OAAO,QAQjB;IAED;;;;OAIG;IACH,cAHW,MAAM,GAAC,mBAAmB,GACxB,OAAO,CAInB;IAED;;OAEG;IACH,gCAaC;IAED;;;uBA6jBA;;;;eAIG;;;;;uBAJH;;;;eAIG;;;;;;;;;;;;;;;;;;MAljBF;IAED,0BAkEC;IAGD;;;OAGG;IACH,gBAFW,aAAa,QASvB;IAED;;;;OAIG;IACH,gCAHmB,aAAa,SAAS,MAAM,KAAK,IAAI,uBAavD;IAED;;;;OAIG;IACH,iCAHW,aAAa,GACZ,MAAM,CA2CjB;IAED,8BA0DC;IAED,8BAiBC;IAED,2BAmBC;IAED;;;OAGG;IACH,uCAHW,MAAM,GACJ,MAAM,CA+BlB;IAED,cAoBC;IAED,mBA6BC;IAuBD,eAOC;IAED;;;;OAIG;IACH,cAHW,eAAe,GACb,OAAO,CASnB;IAED;;;;;;;;;;;;;;;OAeG;IACH,kBAJW,MAAM,eACN,MAAM,eACN,MAAM,QA4FhB;IAED,eAOC;IAED;;;OAGG;IACH,4BAFY,MAAM,CAejB;IAED;;;OAGG;IACH,mBAFW,MAAM,QAMhB;IAiCD;;;;OAIG;IACH,sCA+GC;IAED;;;;OAIG;IACH,qCA6GC;IAED;;;OAGG;IACH,aA4CC;IAGD;;OAEG;IACH,gBAIC;;CAYJ;;;;;;;;;;;;;;;;oBA3lCmB,wCAAwC;uBAFrC,2CAA2C;6BAMrC,6CAA6C;6BAqB7C,mBAAmB;0BAnCtB,+CAA+C;sBAInD,8CAA8C;6BAWvC,8BAA8B;oCAiBvB,0BAA0B;8BAChC,oBAAoB;uCAF3C,0BAA0B;6CAA1B,0BAA0B;kDAA1B,0BAA0B;4CAA1B,0BAA0B;4CAA1B,0BAA0B;kDAA1B,0BAA0B;wCAA1B,0BAA0B;sCAA1B,0BAA0B;4CAA1B,0BAA0B;AASjC,yCAKC"}