@galacean/engine-core 2.0.0-alpha.36 → 2.0.0-alpha.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "2.0.0-alpha.36",
+  "version": "2.0.0-alpha.37",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -18,10 +18,10 @@
     "types/**/*"
   ],
   "dependencies": {
-    "@galacean/engine-math": "2.0.0-alpha.36"
+    "@galacean/engine-math": "2.0.0-alpha.37"
   },
   "devDependencies": {
-    "@galacean/engine-design": "2.0.0-alpha.36"
+    "@galacean/engine-design": "2.0.0-alpha.37"
   },
   "scripts": {
     "b:types": "tsc"

package/types/particle/ParticleGenerator.d.ts

@@ -10,6 +10,7 @@ import { SizeOverLifetimeModule } from "./modules/SizeOverLifetimeModule";
 import { TextureSheetAnimationModule } from "./modules/TextureSheetAnimationModule";
 import { NoiseModule } from "./modules/NoiseModule";
 import { VelocityOverLifetimeModule } from "./modules/VelocityOverLifetimeModule";
+import { SubEmittersModule } from "./modules/SubEmittersModule";
 /**
  * Particle Generator.
  */
@@ -21,7 +22,8 @@ export declare class ParticleGenerator {
     private static _tempVector31;
     private static _tempVector32;
     private static _tempMat;
-    private static _tempColor0;
+    private static _tempColor;
+    private static _tempQuat0;
     private static _tempParticleRenderers;
     private static readonly _particleIncreaseCount;
     private static readonly _transformedBoundsIncreaseCount;
@@ -48,8 +50,11 @@ export declare class ParticleGenerator {
     readonly textureSheetAnimation: TextureSheetAnimationModule;
     /** Noise module. */
     readonly noise: NoiseModule;
+    /** Sub emitters module. */
+    readonly subEmitters: SubEmittersModule;
     /** Custom data module. */
     readonly customData: CustomDataModule;
+    private _feedbackReadback;
     private _isPlaying;
     private _instanceBufferResized;
     private _waitProcessRetiredElementCount;
@@ -61,6 +66,13 @@ export declare class ParticleGenerator {
     private _firstActiveTransformedBoundingBox;
     private _firstFreeTransformedBoundingBox;
     private _playStartDelay;
+    private _eventPos;
+    private _eventColor;
+    private _eventSize;
+    private _eventRotation;
+    private _eventDir;
+    private _emitLocalPos;
+    private _emitDirection;
     /**
      * Whether the particle generator is contain alive or is still creating particles.
      */
@@ -91,9 +103,13 @@ export declare class ParticleGenerator {
      */
     emit(count: number): void;
     private _addNewParticle;
+    private _onParticleBirth;
     private _addFeedbackParticle;
     private _clearActiveParticles;
     private _retireActiveParticles;
+    private _readbackFeedback;
+    private _onParticleDeath;
+    private _evaluateOverLifetime;
     private _freeRetiredParticles;
     private _addActiveParticlesToVertexBuffer;
     private _addVertexBufferBindingsFilterDuplicate;

package/types/particle/enums/ParticleSubEmitterInheritProperty.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Optional parent properties a sub-emitter inherits
+ * Sub particles are always emitted at the parent particle's position; these flags only select
+ * which additional properties are inherited on top of that.
+ */
+export declare enum ParticleSubEmitterInheritProperty {
+    /** Inherit no additional properties; sub particles are still emitted at the parent's position. */
+    None = 0,
+    /** Multiply parent's current color into the sub particle's start color. */
+    Color = 1,
+    /** Multiply parent's current size into the sub particle's start size. */
+    Size = 2,
+    /** Add parent's current rotation onto the sub particle's start rotation. */
+    Rotation = 4,
+    /** Emit the sub particle along the parent's velocity direction. */
+    Velocity = 8
+}

package/types/particle/enums/ParticleSubEmitterType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Particle sub emitter trigger type.
+ */
+export declare enum ParticleSubEmitterType {
+    /** Triggered when a parent particle is born. */
+    Birth = 0,
+    /** Triggered when a parent particle dies (lifetime expired). */
+    Death = 1
+}

package/types/particle/index.d.ts

@@ -7,6 +7,8 @@ export { ParticleRenderMode } from "./enums/ParticleRenderMode";
 export { ParticleScaleMode } from "./enums/ParticleScaleMode";
 export { ParticleSimulationSpace } from "./enums/ParticleSimulationSpace";
 export { ParticleStopMode } from "./enums/ParticleStopMode";
+export { ParticleSubEmitterType } from "./enums/ParticleSubEmitterType";
+export { ParticleSubEmitterInheritProperty } from "./enums/ParticleSubEmitterInheritProperty";
 export { Burst } from "./modules/Burst";
 export { ColorOverLifetimeModule } from "./modules/ColorOverLifetimeModule";
 export { CustomDataModule } from "./modules/CustomDataModule";
@@ -22,4 +24,6 @@ export { TextureSheetAnimationModule } from "./modules/TextureSheetAnimationModu
 export { VelocityOverLifetimeModule } from "./modules/VelocityOverLifetimeModule";
 export { LimitVelocityOverLifetimeModule } from "./modules/LimitVelocityOverLifetimeModule";
 export { NoiseModule } from "./modules/NoiseModule";
+export { SubEmitter } from "./modules/SubEmitter";
+export { SubEmittersModule } from "./modules/SubEmittersModule";
 export * from "./modules/shape/index";

package/types/particle/modules/ParticleCompositeGradient.d.ts

@@ -5,6 +5,7 @@ import { ParticleGradient } from "./ParticleGradient";
  * Particle composite gradient.
  */
 export declare class ParticleCompositeGradient {
+    private static _tempColor;
     /** The gradient mode. */
     mode: ParticleGradientMode;
     constantMin: Color;

package/types/particle/modules/ParticleGeneratorModule.d.ts

@@ -1,11 +1,9 @@
 import { ShaderData, ShaderMacro } from "../../shader";
-import { ParticleGenerator } from "../ParticleGenerator";
 import { ParticleCompositeCurve } from "./ParticleCompositeCurve";
 /**
  * Particle generator module.
  */
 export declare abstract class ParticleGeneratorModule {
-    protected _generator: ParticleGenerator;
     protected _enabled: boolean;
     /**
      * Specifies whether the module is enabled or not.

package/types/particle/modules/SubEmitter.d.ts

@@ -0,0 +1,27 @@
+import { ParticleRenderer } from "../ParticleRenderer";
+import { ParticleSubEmitterInheritProperty } from "../enums/ParticleSubEmitterInheritProperty";
+import { ParticleSubEmitterType } from "../enums/ParticleSubEmitterType";
+/**
+ * One slot in `SubEmittersModule.subEmitters`. Configures which sub-emitter
+ * fires, on which parent event, with what inheritance, probability, and count.
+ */
+export declare class SubEmitter {
+    /** Bitmask of properties inherited from the parent particle. */
+    inheritProperties: ParticleSubEmitterInheritProperty;
+    /** Probability (0..1) the sub-emitter fires for any given event. */
+    emitProbability: number;
+    /** Number of sub particles emitted per parent event. */
+    emitCount: number;
+    private _emitter;
+    private _type;
+    /**
+     * Target particle renderer the sub particles emit into.
+     */
+    get emitter(): ParticleRenderer;
+    set emitter(value: ParticleRenderer);
+    /**
+     * Which parent-particle event drives this slot.
+     */
+    get type(): ParticleSubEmitterType;
+    set type(value: ParticleSubEmitterType);
+}

package/types/particle/modules/SubEmittersModule.d.ts

@@ -0,0 +1,36 @@
+import { ParticleSubEmitterInheritProperty } from "../enums/ParticleSubEmitterInheritProperty";
+import { ParticleSubEmitterType } from "../enums/ParticleSubEmitterType";
+import { ParticleRenderer } from "../ParticleRenderer";
+import { ParticleGeneratorModule } from "./ParticleGeneratorModule";
+import { SubEmitter } from "./SubEmitter";
+/**
+ * Fires sub-emitters on parent particle lifecycle events (Birth / Death).
+ * @remarks Requires WebGL2; the module stays inactive on WebGL1.
+ */
+export declare class SubEmittersModule extends ParticleGeneratorModule {
+    private static _cycleVisited;
+    private static _cycleStack;
+    private static _wouldCreateCycle;
+    private _subEmitters;
+    /**
+     * The configured sub-emitters.
+     */
+    get subEmitters(): readonly SubEmitter[];
+    private _probabilityRand;
+    /**
+     * Add a sub-emitter slot.
+     * @param emitter - Target particle renderer
+     * @param type - Trigger event (`Birth` / `Death`)
+     * @param inheritProperties - Bitmask of properties inherited from the parent particle
+     * @param emitProbability - Per-event fire probability [0, 1]
+     * @param emitCount - Number of sub particles emitted per parent event
+     */
+    addSubEmitter(emitter: ParticleRenderer, type: ParticleSubEmitterType, inheritProperties?: ParticleSubEmitterInheritProperty, emitProbability?: number, emitCount?: number): void;
+    /**
+     * Remove the sub-emitter at the given index.
+     * @param index - Index of the sub-emitter to remove
+     */
+    removeSubEmitterByIndex(index: number): void;
+    get enabled(): boolean;
+    set enabled(value: boolean);
+}