@babylonjs/core 5.45.2 → 5.46.0

package/Particles/baseParticleSystem.js

@@ -11,238 +11,6 @@ import "../Engines/Extensions/engine.dynamicBuffer.js";
  * @example https://doc.babylonjs.com/features/featuresDeepDive/particles/particle_system/particle_system_intro
  */
 export class BaseParticleSystem {
-    /**
-     * Instantiates a particle system.
-     * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
-     * @param name The name of the particle system
-     */
-    constructor(name) {
-        /**
-         * List of animations used by the particle system.
-         */
-        this.animations = [];
-        /**
-         * The rendering group used by the Particle system to chose when to render.
-         */
-        this.renderingGroupId = 0;
-        /**
-         * The emitter represents the Mesh or position we are attaching the particle system to.
-         */
-        this.emitter = Vector3.Zero();
-        /**
-         * The maximum number of particles to emit per frame
-         */
-        this.emitRate = 10;
-        /**
-         * If you want to launch only a few particles at once, that can be done, as well.
-         */
-        this.manualEmitCount = -1;
-        /**
-         * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
-         */
-        this.updateSpeed = 0.01;
-        /**
-         * The amount of time the particle system is running (depends of the overall update speed).
-         */
-        this.targetStopDuration = 0;
-        /**
-         * Specifies whether the particle system will be disposed once it reaches the end of the animation.
-         */
-        this.disposeOnStop = false;
-        /**
-         * Minimum power of emitting particles.
-         */
-        this.minEmitPower = 1;
-        /**
-         * Maximum power of emitting particles.
-         */
-        this.maxEmitPower = 1;
-        /**
-         * Minimum life time of emitting particles.
-         */
-        this.minLifeTime = 1;
-        /**
-         * Maximum life time of emitting particles.
-         */
-        this.maxLifeTime = 1;
-        /**
-         * Minimum Size of emitting particles.
-         */
-        this.minSize = 1;
-        /**
-         * Maximum Size of emitting particles.
-         */
-        this.maxSize = 1;
-        /**
-         * Minimum scale of emitting particles on X axis.
-         */
-        this.minScaleX = 1;
-        /**
-         * Maximum scale of emitting particles on X axis.
-         */
-        this.maxScaleX = 1;
-        /**
-         * Minimum scale of emitting particles on Y axis.
-         */
-        this.minScaleY = 1;
-        /**
-         * Maximum scale of emitting particles on Y axis.
-         */
-        this.maxScaleY = 1;
-        /**
-         * Gets or sets the minimal initial rotation in radians.
-         */
-        this.minInitialRotation = 0;
-        /**
-         * Gets or sets the maximal initial rotation in radians.
-         */
-        this.maxInitialRotation = 0;
-        /**
-         * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
-         */
-        this.minAngularSpeed = 0;
-        /**
-         * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
-         */
-        this.maxAngularSpeed = 0;
-        /**
-         * The layer mask we are rendering the particles through.
-         */
-        this.layerMask = 0x0fffffff;
-        /**
-         * This can help using your own shader to render the particle system.
-         * The according effect will be created
-         */
-        this.customShader = null;
-        /**
-         * By default particle system starts as soon as they are created. This prevents the
-         * automatic start to happen and let you decide when to start emitting particles.
-         */
-        this.preventAutoStart = false;
-        /** @internal */
-        this._wasDispatched = false;
-        this._rootUrl = "";
-        /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
-        this.noiseStrength = new Vector3(10, 10, 10);
-        /**
-         * Callback triggered when the particle animation is ending.
-         */
-        this.onAnimationEnd = null;
-        /**
-         * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
-         */
-        this.blendMode = BaseParticleSystem.BLENDMODE_ONEONE;
-        /**
-         * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
-         * to override the particles.
-         */
-        this.forceDepthWrite = false;
-        /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
-        this.preWarmCycles = 0;
-        /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
-        this.preWarmStepOffset = 1;
-        /**
-         * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
-         */
-        this.spriteCellChangeSpeed = 1;
-        /**
-         * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
-         */
-        this.startSpriteCellID = 0;
-        /**
-         * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
-         */
-        this.endSpriteCellID = 0;
-        /**
-         * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
-         */
-        this.spriteCellWidth = 0;
-        /**
-         * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
-         */
-        this.spriteCellHeight = 0;
-        /**
-         * If using a spritesheet (isAnimationSheetEnabled), defines wether the sprite animation is looping
-         */
-        this.spriteCellLoop = true;
-        /**
-         * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
-         */
-        this.spriteRandomStartCell = false;
-        /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
-        this.translationPivot = new Vector2(0, 0);
-        /**
-         * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
-         */
-        this.beginAnimationOnStart = false;
-        /**
-         * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
-         */
-        this.beginAnimationFrom = 0;
-        /**
-         * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
-         */
-        this.beginAnimationTo = 60;
-        /**
-         * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
-         */
-        this.beginAnimationLoop = false;
-        /**
-         * Gets or sets a world offset applied to all particles
-         */
-        this.worldOffset = new Vector3(0, 0, 0);
-        this._useLogarithmicDepth = false;
-        /**
-         * You can use gravity if you want to give an orientation to your particles.
-         */
-        this.gravity = Vector3.Zero();
-        this._colorGradients = null;
-        this._sizeGradients = null;
-        this._lifeTimeGradients = null;
-        this._angularSpeedGradients = null;
-        this._velocityGradients = null;
-        this._limitVelocityGradients = null;
-        this._dragGradients = null;
-        this._emitRateGradients = null;
-        this._startSizeGradients = null;
-        this._rampGradients = null;
-        this._colorRemapGradients = null;
-        this._alphaRemapGradients = null;
-        /**
-         * Defines the delay in milliseconds before starting the system (0 by default)
-         */
-        this.startDelay = 0;
-        /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
-        this.limitVelocityDamping = 0.4;
-        /**
-         * Random color of each particle after it has been emitted, between color1 and color2 vectors
-         */
-        this.color1 = new Color4(1.0, 1.0, 1.0, 1.0);
-        /**
-         * Random color of each particle after it has been emitted, between color1 and color2 vectors
-         */
-        this.color2 = new Color4(1.0, 1.0, 1.0, 1.0);
-        /**
-         * Color the particle will have at the end of its lifetime
-         */
-        this.colorDead = new Color4(0, 0, 0, 1.0);
-        /**
-         * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
-         */
-        this.textureMask = new Color4(1.0, 1.0, 1.0, 1.0);
-        /** @internal */
-        this._isSubEmitter = false;
-        /** @internal */
-        this._billboardMode = 7;
-        /** @internal */
-        this._isBillboardBased = true;
-        /**
-         * Local cache of defines for image processing.
-         */
-        this._imageProcessingConfigurationDefines = new ImageProcessingConfigurationDefines();
-        this.id = name;
-        this.name = name;
-    }
     /**
      * Gets or sets a texture used to add random noise to particle positions
      */
@@ -517,6 +285,238 @@ export class BaseParticleSystem {
         }
         return this;
     }
+    /**
+     * Instantiates a particle system.
+     * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
+     * @param name The name of the particle system
+     */
+    constructor(name) {
+        /**
+         * List of animations used by the particle system.
+         */
+        this.animations = [];
+        /**
+         * The rendering group used by the Particle system to chose when to render.
+         */
+        this.renderingGroupId = 0;
+        /**
+         * The emitter represents the Mesh or position we are attaching the particle system to.
+         */
+        this.emitter = Vector3.Zero();
+        /**
+         * The maximum number of particles to emit per frame
+         */
+        this.emitRate = 10;
+        /**
+         * If you want to launch only a few particles at once, that can be done, as well.
+         */
+        this.manualEmitCount = -1;
+        /**
+         * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
+         */
+        this.updateSpeed = 0.01;
+        /**
+         * The amount of time the particle system is running (depends of the overall update speed).
+         */
+        this.targetStopDuration = 0;
+        /**
+         * Specifies whether the particle system will be disposed once it reaches the end of the animation.
+         */
+        this.disposeOnStop = false;
+        /**
+         * Minimum power of emitting particles.
+         */
+        this.minEmitPower = 1;
+        /**
+         * Maximum power of emitting particles.
+         */
+        this.maxEmitPower = 1;
+        /**
+         * Minimum life time of emitting particles.
+         */
+        this.minLifeTime = 1;
+        /**
+         * Maximum life time of emitting particles.
+         */
+        this.maxLifeTime = 1;
+        /**
+         * Minimum Size of emitting particles.
+         */
+        this.minSize = 1;
+        /**
+         * Maximum Size of emitting particles.
+         */
+        this.maxSize = 1;
+        /**
+         * Minimum scale of emitting particles on X axis.
+         */
+        this.minScaleX = 1;
+        /**
+         * Maximum scale of emitting particles on X axis.
+         */
+        this.maxScaleX = 1;
+        /**
+         * Minimum scale of emitting particles on Y axis.
+         */
+        this.minScaleY = 1;
+        /**
+         * Maximum scale of emitting particles on Y axis.
+         */
+        this.maxScaleY = 1;
+        /**
+         * Gets or sets the minimal initial rotation in radians.
+         */
+        this.minInitialRotation = 0;
+        /**
+         * Gets or sets the maximal initial rotation in radians.
+         */
+        this.maxInitialRotation = 0;
+        /**
+         * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
+         */
+        this.minAngularSpeed = 0;
+        /**
+         * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
+         */
+        this.maxAngularSpeed = 0;
+        /**
+         * The layer mask we are rendering the particles through.
+         */
+        this.layerMask = 0x0fffffff;
+        /**
+         * This can help using your own shader to render the particle system.
+         * The according effect will be created
+         */
+        this.customShader = null;
+        /**
+         * By default particle system starts as soon as they are created. This prevents the
+         * automatic start to happen and let you decide when to start emitting particles.
+         */
+        this.preventAutoStart = false;
+        /** @internal */
+        this._wasDispatched = false;
+        this._rootUrl = "";
+        /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
+        this.noiseStrength = new Vector3(10, 10, 10);
+        /**
+         * Callback triggered when the particle animation is ending.
+         */
+        this.onAnimationEnd = null;
+        /**
+         * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
+         */
+        this.blendMode = BaseParticleSystem.BLENDMODE_ONEONE;
+        /**
+         * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
+         * to override the particles.
+         */
+        this.forceDepthWrite = false;
+        /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
+        this.preWarmCycles = 0;
+        /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
+        this.preWarmStepOffset = 1;
+        /**
+         * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
+         */
+        this.spriteCellChangeSpeed = 1;
+        /**
+         * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
+         */
+        this.startSpriteCellID = 0;
+        /**
+         * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
+         */
+        this.endSpriteCellID = 0;
+        /**
+         * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
+         */
+        this.spriteCellWidth = 0;
+        /**
+         * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
+         */
+        this.spriteCellHeight = 0;
+        /**
+         * If using a spritesheet (isAnimationSheetEnabled), defines wether the sprite animation is looping
+         */
+        this.spriteCellLoop = true;
+        /**
+         * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
+         */
+        this.spriteRandomStartCell = false;
+        /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
+        this.translationPivot = new Vector2(0, 0);
+        /**
+         * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
+         */
+        this.beginAnimationOnStart = false;
+        /**
+         * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
+         */
+        this.beginAnimationFrom = 0;
+        /**
+         * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
+         */
+        this.beginAnimationTo = 60;
+        /**
+         * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
+         */
+        this.beginAnimationLoop = false;
+        /**
+         * Gets or sets a world offset applied to all particles
+         */
+        this.worldOffset = new Vector3(0, 0, 0);
+        this._useLogarithmicDepth = false;
+        /**
+         * You can use gravity if you want to give an orientation to your particles.
+         */
+        this.gravity = Vector3.Zero();
+        this._colorGradients = null;
+        this._sizeGradients = null;
+        this._lifeTimeGradients = null;
+        this._angularSpeedGradients = null;
+        this._velocityGradients = null;
+        this._limitVelocityGradients = null;
+        this._dragGradients = null;
+        this._emitRateGradients = null;
+        this._startSizeGradients = null;
+        this._rampGradients = null;
+        this._colorRemapGradients = null;
+        this._alphaRemapGradients = null;
+        /**
+         * Defines the delay in milliseconds before starting the system (0 by default)
+         */
+        this.startDelay = 0;
+        /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
+        this.limitVelocityDamping = 0.4;
+        /**
+         * Random color of each particle after it has been emitted, between color1 and color2 vectors
+         */
+        this.color1 = new Color4(1.0, 1.0, 1.0, 1.0);
+        /**
+         * Random color of each particle after it has been emitted, between color1 and color2 vectors
+         */
+        this.color2 = new Color4(1.0, 1.0, 1.0, 1.0);
+        /**
+         * Color the particle will have at the end of its lifetime
+         */
+        this.colorDead = new Color4(0, 0, 0, 1.0);
+        /**
+         * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
+         */
+        this.textureMask = new Color4(1.0, 1.0, 1.0, 1.0);
+        /** @internal */
+        this._isSubEmitter = false;
+        /** @internal */
+        this._billboardMode = 7;
+        /** @internal */
+        this._isBillboardBased = true;
+        /**
+         * Local cache of defines for image processing.
+         */
+        this._imageProcessingConfigurationDefines = new ImageProcessingConfigurationDefines();
+        this.id = name;
+        this.name = name;
+    }
     /**
      * Creates a Point Emitter for the particle system (emits directly from the emitter position)
      * @param direction1 Particles are emitted between the direction1 and direction2 from within the box