@babylonjs/core 8.11.0 → 8.12.0

package/Particles/thinParticleSystem.d.ts

@@ -67,6 +67,10 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
      * An event triggered when the system is stopped
      */
     onStoppedObservable: Observable<IParticleSystem>;
+    /**
+     * An event triggered when the system is started
+     */
+    onStartedObservable: Observable<IParticleSystem>;
     private _onDisposeObserver;
     /**
      * Sets a callback that will be triggered when the system is disposed
@@ -105,6 +109,11 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
     private _alive;
     private _useInstancing;
     private _vertexArrayObject;
+    private _isDisposed;
+    /**
+     * Gets a boolean indicating that the particle system was disposed
+     */
+    get isDisposed(): boolean;
     private _started;
     private _stopped;
     /** @internal */
@@ -129,7 +138,8 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
     private readonly _rawTextureWidth;
     private _rampGradientsTexture;
     private _useRampGradients;
-    protected _updateQueueStart: Nullable<_IExecutionQueueItem>;
+    /** @internal */
+    _updateQueueStart: Nullable<_IExecutionQueueItem>;
     protected _colorProcessing: _IExecutionQueueItem;
     protected _angularSpeedGradientProcessing: _IExecutionQueueItem;
     protected _angularSpeedProcessing: _IExecutionQueueItem;
@@ -142,18 +152,24 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
     protected _gravityProcessing: _IExecutionQueueItem;
     protected _sizeGradientProcessing: _IExecutionQueueItem;
     protected _remapGradientProcessing: _IExecutionQueueItem;
-    private _lifeTimeCreation;
-    private _positionCreation;
+    /** @internal */
+    _lifeTimeCreation: _IExecutionQueueItem;
+    /** @internal */
+    _positionCreation: _IExecutionQueueItem;
     private _isLocalCreation;
-    private _directionCreation;
+    /** @internal */
+    _directionCreation: _IExecutionQueueItem;
     private _emitPowerCreation;
-    private _sizeCreation;
+    /** @internal */
+    _sizeCreation: _IExecutionQueueItem;
     private _startSizeCreation;
-    private _angleCreation;
+    /** @internal */
+    _angleCreation: _IExecutionQueueItem;
     private _velocityCreation;
     private _limitVelocityCreation;
     private _dragCreation;
-    private _colorCreation;
+    /** @internal */
+    _colorCreation: _IExecutionQueueItem;
     private _sheetCreation;
     private _rampCreation;
     private _noiseCreation;
@@ -255,8 +271,9 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
      * @param customEffect a custom effect used to change the way particles are rendered by default
      * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
      * @param epsilon Offset used to render the particles
+     * @param noUpdateQueue If true, the particle system will start with an empty update queue
      */
-    constructor(name: string, capacity: number, sceneOrEngine: Scene | AbstractEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
+    constructor(name: string, capacity: number, sceneOrEngine: Scene | AbstractEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number, noUpdateQueue?: boolean);
     /** @internal */
     _emitFromParticle: (particle: Particle) => void;
     serialize(serializeTexture: boolean): void;
@@ -488,7 +505,7 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
      */
     stop(stopSubEmitters?: boolean): void;
     /** @internal */
-    _postStop(stopSubEmitters: boolean): void;
+    _postStop(_stopSubEmitters: boolean): void;
     /**
      * Remove all active particles
      */
@@ -505,7 +522,7 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
     recycleParticle: (particle: Particle) => void;
     private _createParticle;
     /** @internal */
-    _prepareParticle(particle: Particle): void;
+    _prepareParticle(_particle: Particle): void;
     private _createNewOnes;
     private _update;
     /**
@@ -534,6 +551,10 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
      * @internal
      */
     private _getWrapper;
+    /**
+     * Gets or sets a boolean indicating that the particle system is paused (no animation will be done).
+     */
+    paused: boolean;
     /**
      * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
      * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
@@ -558,7 +579,7 @@ export declare class ThinParticleSystem extends BaseParticleSystem implements ID
      */
     render(): number;
     /** @internal */
-    _onDispose(disposeAttachedSubEmitters?: boolean, disposeEndSubEmitters?: boolean): void;
+    _onDispose(_disposeAttachedSubEmitters?: boolean, _disposeEndSubEmitters?: boolean): void;
     /**
      * Disposes the particle system and free the associated resources
      * @param disposeTexture defines if the particle texture must be disposed as well (true by default)

package/Particles/thinParticleSystem.js

@@ -72,6 +72,12 @@ export class ThinParticleSystem extends BaseParticleSystem {
         }
         this._onDisposeObserver = this.onDisposeObservable.add(callback);
     }
+    /**
+     * Gets a boolean indicating that the particle system was disposed
+     */
+    get isDisposed() {
+        return this._isDisposed;
+    }
     /** Gets or sets a boolean indicating that ramp gradients must be used
      * @see https://doc.babylonjs.com/features/featuresDeepDive/particles/particle_system/particle_system_intro#ramp-gradients
      */
@@ -158,6 +164,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
         else {
             _RemoveFromQueue(this._sheetCreation);
         }
+        this._reset();
     }
     /**
      * Gets the number of particles active at the same time.
@@ -265,8 +272,9 @@ export class ThinParticleSystem extends BaseParticleSystem {
      * @param customEffect a custom effect used to change the way particles are rendered by default
      * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
      * @param epsilon Offset used to render the particles
+     * @param noUpdateQueue If true, the particle system will start with an empty update queue
      */
-    constructor(name, capacity, sceneOrEngine, customEffect = null, isAnimationSheetEnabled = false, epsilon = 0.01) {
+    constructor(name, capacity, sceneOrEngine, customEffect = null, isAnimationSheetEnabled = false, epsilon = 0.01, noUpdateQueue = false) {
         super(name);
         /** @internal */
         this._emitterInverseWorldMatrix = Matrix.Identity();
@@ -284,6 +292,10 @@ export class ThinParticleSystem extends BaseParticleSystem {
          * An event triggered when the system is stopped
          */
         this.onStoppedObservable = new Observable();
+        /**
+         * An event triggered when the system is started
+         */
+        this.onStartedObservable = new Observable();
         /** @internal */
         this._noiseTextureSize = null;
         /** @internal */
@@ -302,6 +314,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
         this._scaledGravity = Vector3.Zero();
         this._currentRenderId = -1;
         this._useInstancing = false;
+        this._isDisposed = false;
         this._started = false;
         this._stopped = false;
         /** @internal */
@@ -318,6 +331,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
         this.updateInAnimate = true;
         this._rawTextureWidth = 256;
         this._useRampGradients = false;
+        /** @internal */
         this._updateQueueStart = null;
         this._startSizeCreation = null;
         this._createQueueStart = null;
@@ -358,6 +372,10 @@ export class ThinParticleSystem extends BaseParticleSystem {
             this._prepareParticle(particle);
             return particle;
         };
+        /**
+         * Gets or sets a boolean indicating that the particle system is paused (no animation will be done).
+         */
+        this.paused = false;
         this._shadersLoaded = false;
         this._capacity = capacity;
         this._epsilon = epsilon;
@@ -420,36 +438,38 @@ export class ThinParticleSystem extends BaseParticleSystem {
         _ConnectAfter(this._colorCreation, this._angleCreation);
         this._createQueueStart = this._lifeTimeCreation;
         // Processing queue
-        this._colorProcessing = {
-            process: _ProcessColor,
-            previousItem: null,
-            nextItem: null,
-        };
-        this._angularSpeedProcessing = {
-            process: _ProcessAngularSpeed,
-            previousItem: null,
-            nextItem: null,
-        };
-        _ConnectAfter(this._angularSpeedProcessing, this._colorProcessing);
-        this._directionProcessing = {
-            process: _ProcessDirection,
-            previousItem: null,
-            nextItem: null,
-        };
-        _ConnectAfter(this._directionProcessing, this._angularSpeedProcessing);
-        this._positionProcessing = {
-            process: _ProcessPosition,
-            previousItem: null,
-            nextItem: null,
-        };
-        _ConnectAfter(this._positionProcessing, this._directionProcessing);
-        this._gravityProcessing = {
-            process: _ProcessGravity,
-            previousItem: null,
-            nextItem: null,
-        };
-        _ConnectAfter(this._gravityProcessing, this._positionProcessing);
-        this._updateQueueStart = this._colorProcessing;
+        if (!noUpdateQueue) {
+            this._colorProcessing = {
+                process: _ProcessColor,
+                previousItem: null,
+                nextItem: null,
+            };
+            this._angularSpeedProcessing = {
+                process: _ProcessAngularSpeed,
+                previousItem: null,
+                nextItem: null,
+            };
+            _ConnectAfter(this._angularSpeedProcessing, this._colorProcessing);
+            this._directionProcessing = {
+                process: _ProcessDirection,
+                previousItem: null,
+                nextItem: null,
+            };
+            _ConnectAfter(this._directionProcessing, this._angularSpeedProcessing);
+            this._positionProcessing = {
+                process: _ProcessPosition,
+                previousItem: null,
+                nextItem: null,
+            };
+            _ConnectAfter(this._positionProcessing, this._directionProcessing);
+            this._gravityProcessing = {
+                process: _ProcessGravity,
+                previousItem: null,
+                nextItem: null,
+            };
+            _ConnectAfter(this._gravityProcessing, this._positionProcessing);
+            this._updateQueueStart = this._colorProcessing;
+        }
         this._isAnimationSheetEnabled = isAnimationSheetEnabled;
         // Setup the default processing configuration to the scene.
         this._attachImageProcessingConfiguration(null);
@@ -493,7 +513,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
                     currentQueueItem.process(particle, this);
                     currentQueueItem = currentQueueItem.nextItem;
                 }
-                if (this._isAnimationSheetEnabled) {
+                if (this._isAnimationSheetEnabled && !noUpdateQueue) {
                     particle.updateCellIndex();
                 }
                 // Update the position of the attached sub-emitters to match their attached particle
@@ -1036,6 +1056,9 @@ export class ThinParticleSystem extends BaseParticleSystem {
      * Resets the draw wrappers cache
      */
     resetDrawCache() {
+        if (!this._drawWrappers) {
+            return;
+        }
         for (const drawWrappers of this._drawWrappers) {
             if (drawWrappers) {
                 for (const drawWrapper of drawWrappers) {
@@ -1244,6 +1267,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
         if (this.beginAnimationOnStart && this.animations && this.animations.length > 0 && this._scene) {
             this._scene.beginAnimation(this, this.beginAnimationFrom, this.beginAnimationTo, this.beginAnimationLoop);
         }
+        this.onStartedObservable.notifyObservers(this);
     }
     /**
      * Stops the particle system.
@@ -1258,7 +1282,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
         this._postStop(stopSubEmitters);
     }
     /** @internal */
-    _postStop(stopSubEmitters) {
+    _postStop(_stopSubEmitters) {
         // Do nothing
     }
     // Animation sheet
@@ -1346,7 +1370,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
         }
     }
     /** @internal */
-    _prepareParticle(particle) {
+    _prepareParticle(_particle) {
         //Do nothing
     }
     _createNewOnes(newParticles) {
@@ -1523,7 +1547,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
      * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
      */
     animate(preWarmOnly = false) {
-        if (!this._started) {
+        if (!this._started || this.paused) {
             return;
         }
         if (!preWarmOnly && this._scene) {
@@ -1777,7 +1801,7 @@ export class ThinParticleSystem extends BaseParticleSystem {
         return outparticles;
     }
     /** @internal */
-    _onDispose(disposeAttachedSubEmitters = false, disposeEndSubEmitters = false) {
+    _onDispose(_disposeAttachedSubEmitters = false, _disposeEndSubEmitters = false) {
         // Do Nothing
     }
     /**
@@ -1840,7 +1864,9 @@ export class ThinParticleSystem extends BaseParticleSystem {
         this.onDisposeObservable.notifyObservers(this);
         this.onDisposeObservable.clear();
         this.onStoppedObservable.clear();
+        this.onStartedObservable.clear();
         this.reset();
+        this._isDisposed = true;
     }
 }
 /**