@babylonjs/core 9.2.0 → 9.2.2

package/Particles/gpuParticleSystem.d.ts

@@ -6,6 +6,7 @@ import { Color4 } from "../Maths/math.color.js";
 import { VertexBuffer } from "../Buffers/buffer.js";
 import { type IParticleSystem } from "./IParticleSystem.js";
 import { BaseParticleSystem } from "./baseParticleSystem.js";
+import { Attractor } from "./attractor.js";
 import { BoxParticleEmitter } from "../Particles/EmitterTypes/boxParticleEmitter.js";
 import { type IDisposable, Scene } from "../scene.js";
 import { type Effect } from "../Materials/effect.js";
@@ -70,6 +71,22 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
     private readonly _rawTextureWidth;
     private _platform;
     private _rebuildingAfterContextLost;
+    /**
+     * Whether the particle buffer needs to store the initial emission direction.
+     * True when particles are not billboarded (they orient by direction) or when
+     * using stretched-local billboard mode (stretches along initial direction).
+     * @internal
+     */
+    get _needsInitialDirection(): boolean;
+    private _currentEmitRateGradient;
+    private _currentEmitRate1;
+    private _currentEmitRate2;
+    private _currentStartSizeGradient;
+    private _currentStartSize1;
+    private _currentStartSize2;
+    private _startSizeGradientFactor;
+    private _lifeTimeGradientMin;
+    private _lifeTimeGradientMax;
     /**
      * Specifies if the particle system should be serialized
      */
@@ -129,6 +146,18 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
     isLocal: boolean;
     /** Indicates that the particle system is GPU based */
     readonly isGPU = true;
+    /** Attractors */
+    /**
+     * Maximum number of attractors for this GPU particle system instance.
+     * Determined at construction time via the `maxAttractors` option (default 8).
+     * Limited by the fixed-size uniform arrays in the update shaders.
+     */
+    readonly maxAttractors: number;
+    /**
+     * Add an attractor to the particle system. Attractors are used to change the direction of the particles in the system.
+     * @param attractor - The attractor to add to the particle system
+     */
+    addAttractor(attractor: Attractor): void;
     /** Gets or sets a matrix to use to compute projection */
     defaultProjectionMatrix: Matrix;
     /**
@@ -321,14 +350,14 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
     _limitVelocityGradientsTexture: RawTexture;
     /** @internal */
     _dragGradientsTexture: RawTexture;
-    private _addFactorGradient;
     /**
      * Adds a new size gradient
      * @param gradient defines the gradient to use (between 0 and 1)
      * @param factor defines the size factor to affect to the specified gradient
+     * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
      * @returns the current particle system
      */
-    addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
+    addSizeGradient(gradient: number, factor: number, factor2?: number): GPUParticleSystem;
     /**
      * Remove a specific size gradient
      * @param gradient defines the gradient to remove
@@ -340,9 +369,10 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
      * Adds a new angular speed gradient
      * @param gradient defines the gradient to use (between 0 and 1)
      * @param factor defines the angular speed to affect to the specified gradient
+     * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
      * @returns the current particle system
      */
-    addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
+    addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): GPUParticleSystem;
     /**
      * Remove a specific angular speed gradient
      * @param gradient defines the gradient to remove
@@ -353,9 +383,10 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
      * Adds a new velocity gradient
      * @param gradient defines the gradient to use (between 0 and 1)
      * @param factor defines the velocity to affect to the specified gradient
+     * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
      * @returns the current particle system
      */
-    addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
+    addVelocityGradient(gradient: number, factor: number, factor2?: number): GPUParticleSystem;
     /**
      * Remove a specific velocity gradient
      * @param gradient defines the gradient to remove
@@ -366,9 +397,10 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
      * Adds a new limit velocity gradient
      * @param gradient defines the gradient to use (between 0 and 1)
      * @param factor defines the limit velocity value to affect to the specified gradient
+     * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
      * @returns the current particle system
      */
-    addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
+    addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): GPUParticleSystem;
     /**
      * Remove a specific limit velocity gradient
      * @param gradient defines the gradient to remove
@@ -379,9 +411,10 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
      * Adds a new drag gradient
      * @param gradient defines the gradient to use (between 0 and 1)
      * @param factor defines the drag value to affect to the specified gradient
+     * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
      * @returns the current particle system
      */
-    addDragGradient(gradient: number, factor: number): GPUParticleSystem;
+    addDragGradient(gradient: number, factor: number, factor2?: number): GPUParticleSystem;
     /**
      * Remove a specific drag gradient
      * @param gradient defines the gradient to remove
@@ -389,25 +422,19 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
      */
     removeDragGradient(gradient: number): GPUParticleSystem;
     /**
-     * Not supported by GPUParticleSystem
-     * @returns the current particle system
-     */
-    addEmitRateGradient(): IParticleSystem;
-    /**
-     * Not supported by GPUParticleSystem
-     * @returns the current particle system
-     */
-    removeEmitRateGradient(): IParticleSystem;
-    /**
-     * Not supported by GPUParticleSystem
+     * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
+     * @param gradient defines the gradient to use (between 0 and 1)
+     * @param factor defines the start size factor to affect to the specified gradient
+     * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
      * @returns the current particle system
      */
-    addStartSizeGradient(): IParticleSystem;
+    addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
     /**
-     * Not supported by GPUParticleSystem
+     * Remove a specific start size gradient
+     * @param gradient defines the gradient to remove
      * @returns the current particle system
      */
-    removeStartSizeGradient(): IParticleSystem;
+    removeStartSizeGradient(gradient: number): IParticleSystem;
     /**
      * Not supported by GPUParticleSystem
      * @returns the current particle system
@@ -451,15 +478,19 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
     get useRampGradients(): boolean;
     set useRampGradients(value: boolean);
     /**
-     * Not supported by GPUParticleSystem
+     * Adds a new life time gradient (please note that this will only work if you set the targetStopDuration property)
+     * @param gradient defines the gradient to use (between 0 and 1)
+     * @param factor defines the life time factor to affect to the specified gradient
+     * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
      * @returns the current particle system
      */
-    addLifeTimeGradient(): IParticleSystem;
+    addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
     /**
-     * Not supported by GPUParticleSystem
+     * Remove a specific life time gradient
+     * @param gradient defines the gradient to remove
      * @returns the current particle system
      */
-    removeLifeTimeGradient(): IParticleSystem;
+    removeLifeTimeGradient(gradient: number): IParticleSystem;
     /**
      * Instantiates a GPU 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.
@@ -473,10 +504,15 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
         capacity: number;
         randomTextureSize: number;
         emitRateControl: boolean;
+        maxAttractors: number;
     }>, sceneOrEngine: Scene | AbstractEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean);
     protected _reset(): void;
     private _createVertexBuffers;
     private _initialize;
+    /**
+     * Forces the update effect to be recreated on the next render.
+     */
+    private _resetEffect;
     /** @internal */
     _recreateUpdateEffect(): boolean;
     /**
@@ -486,7 +522,7 @@ export declare class GPUParticleSystem extends BaseParticleSystem implements IDi
     /**
      * @internal
      */
-    static _GetAttributeNamesOrOptions(hasColorGradients?: boolean, isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, isBillboardStretched?: boolean): string[];
+    static _GetAttributeNamesOrOptions(hasColorGradients?: boolean, isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, isBillboardStretched?: boolean, isBillboardStretchedLocal?: boolean): string[];
     /**
      * @internal
      */