particle support limit velocity over lifetime

e2e/case/particleRenderer-limitVelocity.ts

@@ -0,0 +1,134 @@
+/**
+ * @title Particle Limit Velocity Over Lifetime
+ * @category Particle
+ */
+import {
+  AssetType,
+  BlendMode,
+  Burst,
+  Camera,
+  Color,
+  Engine,
+  Entity,
+  SphereShape,
+  ParticleCompositeCurve,
+  ParticleCurveMode,
+  ParticleGradientMode,
+  ParticleMaterial,
+  ParticleRenderer,
+  ParticleSimulationSpace,
+  PostProcess,
+  BloomEffect,
+  TonemappingEffect,
+  Texture2D,
+  WebGLEngine
+} from "@galacean/engine";
+import { initScreenshot, updateForE2E } from "./.mockForE2E";
+
+WebGLEngine.create({
+  canvas: "canvas"
+}).then((engine) => {
+  engine.canvas.resizeByClientSize();
+
+  const scene = engine.sceneManager.activeScene;
+  const rootEntity = scene.createRootEntity();
+  scene.background.solidColor = new Color(0, 0, 0, 1);
+
+  const cameraEntity = rootEntity.createChild("camera");
+  cameraEntity.transform.setPosition(2, 1.43, 30);
+  const camera = cameraEntity.addComponent(Camera);
+  camera.fieldOfView = 60;
+  camera.enableHDR = true;
+  camera.enablePostProcess = true;
+
+  // Post process
+  const postProcess = rootEntity.addComponent(PostProcess);
+  const bloom = postProcess.addEffect(BloomEffect);
+  bloom.intensity.value = 1;
+  bloom.threshold.value = 0.8;
+  postProcess.addEffect(TonemappingEffect);
+
+  engine.resourceManager
+    .load({
+      url: "https://mdn.alipayobjects.com/huamei_b4l2if/afts/img/A*JPsCSK5LtYkAAAAAAAAAAAAADil6AQ/original",
+      type: AssetType.Texture2D
+    })
+    .then((texture) => {
+      createParticle(engine, rootEntity, <Texture2D>texture);
+
+      updateForE2E(engine, 30);
+      initScreenshot(engine, camera);
+    });
+});
+
+function createParticle(engine: Engine, rootEntity: Entity, texture: Texture2D): void {
+  const particleEntity = new Entity(engine, "LimitVelocity");
+  particleEntity.transform.setPosition(2.006557, 1.43, 12.35);
+
+  const particleRenderer = particleEntity.addComponent(ParticleRenderer);
+  const generator = particleRenderer.generator;
+  generator.useAutoRandomSeed = false;
+
+  const material = new ParticleMaterial(engine);
+  material.baseColor = new Color(0.2, 0.6, 1.0, 1.0);
+  material.blendMode = BlendMode.Additive;
+  material.baseTexture = texture;
+  particleRenderer.setMaterial(material);
+
+  const { main, emission, limitVelocityOverLifetime, colorOverLifetime, velocityOverLifetime } = generator;
+
+  // Main
+  main.duration = 2;
+  main.isLoop = true;
+  main.startDelay.constant = 0;
+  main.startLifetime.constantMin = 0.6;
+  main.startLifetime.constantMax = 1;
+  main.startLifetime.mode = ParticleCurveMode.TwoConstants;
+  main.startSpeed.constantMin = 20;
+  main.startSpeed.constantMax = 40;
+  main.startSpeed.mode = ParticleCurveMode.TwoConstants;
+  main.startSize.constantMin = 0.05;
+  main.startSize.constantMax = 0.15;
+  main.startSize.mode = ParticleCurveMode.TwoConstants;
+  main.startColor.constantMin.set(280 / 255, 670 / 255, 2550 / 255, 1);
+  main.startColor.constantMax.set(1130 / 255, 740 / 255, 2550 / 255, 1);
+  main.startColor.mode = ParticleGradientMode.TwoConstants;
+  main.gravityModifier.constant = 0;
+  main.simulationSpace = ParticleSimulationSpace.Local;
+  main.maxParticles = 100;
+
+  // Emission
+  emission.rateOverTime.constant = 0;
+  emission.addBurst(new Burst(0, new ParticleCompositeCurve(10, 30)));
+  const sphereShape = new SphereShape();
+  sphereShape.radius = 0.8;
+  emission.shape = sphereShape;
+
+  // Color over lifetime
+  colorOverLifetime.enabled = true;
+  colorOverLifetime.color.mode = ParticleGradientMode.Gradient;
+  const gradient = colorOverLifetime.color.gradient;
+  gradient.alphaKeys[0].alpha = 0;
+  gradient.alphaKeys[1].alpha = 0;
+  gradient.addAlphaKey(0.2, 1.0);
+  gradient.addAlphaKey(0.8, 1.0);
+
+  velocityOverLifetime.enabled = true;
+  velocityOverLifetime.velocityX.constant = 1;
+  velocityOverLifetime.velocityY.constant = 20;
+  velocityOverLifetime.velocityZ.constant = 1;
+
+  // Limit velocity over lifetime
+  limitVelocityOverLifetime.enabled = true;
+  limitVelocityOverLifetime.separateAxes = true;
+  limitVelocityOverLifetime.limitX = new ParticleCompositeCurve(1);
+  limitVelocityOverLifetime.limitY = new ParticleCompositeCurve(1);
+  limitVelocityOverLifetime.limitZ = new ParticleCompositeCurve(0);
+  limitVelocityOverLifetime.space = ParticleSimulationSpace.World;
+  limitVelocityOverLifetime.dampen = 0.25;
+  limitVelocityOverLifetime.drag = new ParticleCompositeCurve(0.0);
+  limitVelocityOverLifetime.multiplyDragByParticleSize = true;
+  limitVelocityOverLifetime.multiplyDragByParticleVelocity = true;
+
+  rootEntity.addChild(particleEntity);
+}

e2e/config.ts

@@ -335,6 +335,12 @@ export const E2E_CONFIG = {
       threshold: 0,
       diffPercentage: 0.1630209
     },
+    limitVelocityOverLifetime: {
+      category: "Particle",
+      caseFileName: "particleRenderer-limitVelocity",
+      threshold: 0,
+      diffPercentage: 0.0364
+    },
     textureSheetAnimation: {
       category: "Particle",
       caseFileName: "particleRenderer-textureSheetAnimation",
@@ -345,7 +351,7 @@ export const E2E_CONFIG = {
       category: "Particle",
       caseFileName: "particleRenderer-shape-mesh",
       threshold: 0,
-      diffPercentage: 0.0162
+      diffPercentage: 0.01698
     },
     particleEmissive: {
       category: "Particle",

e2e/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@galacean/engine-e2e",
   "private": true,
-  "version": "2.0.0-alpha.14",
+  "version": "2.0.0-alpha.15",
   "license": "MIT",
   "scripts": {
     "case": "vite serve .dev --config .dev/vite.config.js",

examples/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-examples",
-  "version": "2.0.0-alpha.14",
+  "version": "2.0.0-alpha.15",
   "private": true,
   "license": "MIT",
   "main": "dist/main.js",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-root",
-  "version": "2.0.0-alpha.14",
+  "version": "2.0.0-alpha.15",
   "packageManager": "pnpm@9.3.0",
   "private": true,
   "scripts": {

packages/core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/engine-core",
-  "version": "2.0.0-alpha.14",
+  "version": "2.0.0-alpha.15",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"

packages/core/src/2d/sprite/SpriteMask.ts

@@ -196,8 +196,8 @@ export class SpriteMask extends Renderer implements ISpriteRenderer {
   /**
    * @internal
    */
-  override _cloneTo(target: SpriteMask, srcRoot: Entity, targetRoot: Entity): void {
-    super._cloneTo(target, srcRoot, targetRoot);
+  override _cloneTo(target: SpriteMask): void {
+    super._cloneTo(target);
     target.sprite = this._sprite;
   }
 

packages/core/src/2d/sprite/SpriteRenderer.ts

@@ -286,8 +286,8 @@ export class SpriteRenderer extends Renderer implements ISpriteRenderer {
   /**
    * @internal
    */
-  override _cloneTo(target: SpriteRenderer, srcRoot: Entity, targetRoot: Entity): void {
-    super._cloneTo(target, srcRoot, targetRoot);
+  override _cloneTo(target: SpriteRenderer): void {
+    super._cloneTo(target);
     target.sprite = this._sprite;
     target.drawMode = this._drawMode;
   }

packages/core/src/2d/text/TextRenderer.ts

@@ -333,8 +333,8 @@ export class TextRenderer extends Renderer implements ITextRenderer {
   /**
    * @internal
    */
-  override _cloneTo(target: TextRenderer, srcRoot: Entity, targetRoot: Entity): void {
-    super._cloneTo(target, srcRoot, targetRoot);
+  override _cloneTo(target: TextRenderer): void {
+    super._cloneTo(target);
     target.font = this._font;
     target._subFont = this._subFont;
   }
@@ -458,8 +458,8 @@ export class TextRenderer extends Renderer implements ITextRenderer {
 
     // prettier-ignore
     const e0 = e[0], e1 = e[1], e2 = e[2],
-    e4 = e[4], e5 = e[5], e6 = e[6],
-    e12 = e[12], e13 = e[13], e14 = e[14];
+      e4 = e[4], e5 = e[5], e6 = e[6],
+      e12 = e[12], e13 = e[13], e14 = e[14];
 
     const up = TextRenderer._tempVec31.set(e4, e5, e6);
     const right = TextRenderer._tempVec30.set(e0, e1, e2);

packages/core/src/Camera.ts

@@ -829,7 +829,7 @@ export class Camera extends Component {
   /**
    * @internal
    */
-  _cloneTo(target: Camera, srcRoot: Entity, targetRoot: Entity): void {
+  _cloneTo(target: Camera): void {
     this._renderTarget?._addReferCount(1);
   }
 

packages/core/src/Component.ts

@@ -1,6 +1,7 @@
 import { IReferable } from "./asset/IReferable";
 import { EngineObject } from "./base";
 import { assignmentClone, ignoreClone } from "./clone/CloneManager";
+import { CloneUtils } from "./clone/CloneUtils";
 import { Entity } from "./Entity";
 import { ActiveChangeFlag } from "./enums/ActiveChangeFlag";
 import { Scene } from "./Scene";
@@ -10,7 +11,6 @@ import { Scene } from "./Scene";
  */
 export class Component extends EngineObject {
   /** @internal */
-  @ignoreClone
   _entity: Entity;
 
   /** @internal */
@@ -154,6 +154,13 @@ export class Component extends EngineObject {
     }
   }
 
+  /**
+   * @internal
+   */
+  _remap<T extends Component>(srcRoot: Entity, targetRoot: Entity): T {
+    return CloneUtils.remapComponent(srcRoot, targetRoot, this) as unknown as T;
+  }
+
   protected _addResourceReferCount(resource: IReferable, count: number): void {
     this._entity._isTemplate || resource._addReferCount(count);
   }

packages/core/src/Entity.ts

@@ -10,6 +10,7 @@ import { Transform } from "./Transform";
 import { UpdateFlagManager } from "./UpdateFlagManager";
 import { ReferResource } from "./asset/ReferResource";
 import { EngineObject } from "./base";
+import { CloneUtils } from "./clone/CloneUtils";
 import { ComponentCloner } from "./clone/ComponentCloner";
 import { ActiveChangeFlag } from "./enums/ActiveChangeFlag";
 import { EntityModifyFlags } from "./enums/EntityModifyFlags";
@@ -431,6 +432,13 @@ export class Entity extends EngineObject {
     return this._updateFlagManager.createFlag(BoolUpdateFlag);
   }
 
+  /**
+   * @internal
+   */
+  _remap(srcRoot: Entity, targetRoot: Entity): Entity {
+    return CloneUtils.remapEntity(srcRoot, targetRoot, this);
+  }
+
   /**
    * @internal
    */

packages/core/src/Renderer.ts

@@ -8,7 +8,6 @@ import { RenderContext } from "./RenderPipeline/RenderContext";
 import { SubRenderElement } from "./RenderPipeline/SubRenderElement";
 import { Transform, TransformModifyFlags } from "./Transform";
 import { assignmentClone, deepClone, ignoreClone } from "./clone/CloneManager";
-import { IComponentCustomClone } from "./clone/ComponentCloner";
 import { SpriteMaskLayer } from "./enums/SpriteMaskLayer";
 import { Material } from "./material";
 import { ShaderMacro, ShaderProperty } from "./shader";
@@ -21,7 +20,7 @@ import { ShaderDataGroup } from "./shader/enums/ShaderDataGroup";
  * @decorator `@dependentComponents(Transform, DependentMode.CheckOnly)`
  */
 @dependentComponents(Transform, DependentMode.CheckOnly)
-export class Renderer extends Component implements IComponentCustomClone {
+export class Renderer extends Component {
   private static _tempVector0 = new Vector3();
 
   private static _receiveShadowMacro = ShaderMacro.getByName("RENDERER_IS_RECEIVE_SHADOWS");
@@ -66,7 +65,6 @@ export class Renderer extends Component implements IComponentCustomClone {
   protected _rendererLayer: Vector4 = new Vector4();
   @ignoreClone
   protected _bounds: BoundingBox = new BoundingBox();
-  @ignoreClone
   protected _transformEntity: Entity;
 
   @deepClone
@@ -351,7 +349,7 @@ export class Renderer extends Component implements IComponentCustomClone {
   /**
    * @internal
    */
-  _cloneTo(target: Renderer, srcRoot: Entity, targetRoot: Entity): void {
+  _cloneTo(target: Renderer): void {
     const materials = this._materials;
     for (let i = 0, n = materials.length; i < n; i++) {
       target._setMaterial(i, materials[i]);

packages/core/src/Transform.ts

@@ -51,7 +51,6 @@ export class Transform extends Component {
 
   @ignoreClone
   protected _isParentDirty: boolean = true;
-  @ignoreClone
   private _parentTransformCache: Transform = null;
   @ignoreClone
   private _dirtyFlag: number = TransformModifyFlags.LqLmWmWpWeWqWsWus;
@@ -581,7 +580,7 @@ export class Transform extends Component {
   /**
    * @internal
    */
-  _cloneTo(target: Transform, srcRoot: Entity, targetRoot: Entity): void {
+  _cloneTo(target: Transform): void {
     const { _position: position, _rotation: rotation, _scale: scale } = target;
 
     // @ts-ignore

packages/core/src/animation/Animator.ts

@@ -334,7 +334,7 @@ export class Animator extends Component {
   /**
    * @internal
    */
-  _cloneTo(target: Animator, srcRoot: Entity, targetRoot: Entity): void {
+  _cloneTo(target: Animator): void {
     const animatorController = target._animatorController;
     if (animatorController) {
       target._addResourceReferCount(animatorController, 1);

packages/core/src/audio/AudioSource.ts

@@ -217,7 +217,7 @@ export class AudioSource extends Component {
   /**
    * @internal
    */
-  _cloneTo(target: AudioSource, srcRoot: Entity, targetRoot: Entity): void {
+  _cloneTo(target: AudioSource): void {
     target._clip?._addReferCount(1);
     target._gainNode.gain.setValueAtTime(target._volume, AudioManager.getContext().currentTime);
   }