Merge pull request #2456 from cptbtptpbcptdtptp/feat/transform

Optimize the addition and replacement logic of `Transform`

Author: GuoLei1990

packages/core/src/Camera.ts

@@ -128,8 +128,6 @@ export class Camera extends Component {
   @ignoreClone
   private _frustumChangeFlag: BoolUpdateFlag;
   @ignoreClone
-  private _transform: Transform;
-  @ignoreClone
   private _isViewMatrixDirty: BoolUpdateFlag;
   @ignoreClone
   private _isInvViewProjDirty: BoolUpdateFlag;
@@ -315,7 +313,7 @@ export class Camera extends Component {
     this._isViewMatrixDirty.flag = false;
 
     // Ignore scale
-    const transform = this._transform;
+    const transform = this._entity.transform;
     Matrix.rotationTranslation(transform.worldRotationQuaternion, transform.worldPosition, viewMatrix);
     viewMatrix.invert();
     return viewMatrix;
@@ -423,11 +421,9 @@ export class Camera extends Component {
   constructor(entity: Entity) {
     super(entity);
 
-    const transform = this.entity.transform;
-    this._transform = transform;
-    this._isViewMatrixDirty = transform.registerWorldChangeFlag();
-    this._isInvViewProjDirty = transform.registerWorldChangeFlag();
-    this._frustumChangeFlag = transform.registerWorldChangeFlag();
+    this._isViewMatrixDirty = entity.registerWorldChangeFlag();
+    this._isInvViewProjDirty = entity.registerWorldChangeFlag();
+    this._frustumChangeFlag = entity.registerWorldChangeFlag();
     this._renderPipeline = new BasicRenderPipeline(this);
     this._addResourceReferCount(this.shaderData, 1);
     this._updatePixelViewport();
@@ -607,7 +603,7 @@ export class Camera extends Component {
     const context = engine._renderContext;
     const virtualCamera = this._virtualCamera;
 
-    const transform = this.entity.transform;
+    const transform = this._entity.transform;
     Matrix.multiply(this.projectionMatrix, this.viewMatrix, virtualCamera.viewProjectionMatrix);
     virtualCamera.position.copyFrom(transform.worldPosition);
     if (virtualCamera.isOrthographic) {
@@ -738,7 +734,6 @@ export class Camera extends Component {
     this._virtualCamera = null;
     this._shaderData = null;
     this._frustumChangeFlag = null;
-    this._transform = null;
     this._isViewMatrixDirty = null;
     this._isInvViewProjDirty = null;
     this._viewport = null;
@@ -788,7 +783,7 @@ export class Camera extends Component {
   private _updateShaderData(): void {
     const shaderData = this.shaderData;
 
-    const transform = this._transform;
+    const transform = this._entity.transform;
     shaderData.setMatrix(Camera._inverseViewMatrixProperty, transform.worldMatrix);
     shaderData.setVector3(Camera._cameraPositionProperty, transform.worldPosition);
     shaderData.setVector3(Camera._cameraForwardProperty, transform.worldForward);
@@ -806,7 +801,7 @@ export class Camera extends Component {
   private _getInvViewProjMat(): Matrix {
     if (this._isInvViewProjDirty.flag) {
       this._isInvViewProjDirty.flag = false;
-      Matrix.multiply(this._transform.worldMatrix, this._getInverseProjectionMatrix(), this._invViewProjMat);
+      Matrix.multiply(this._entity.transform.worldMatrix, this._getInverseProjectionMatrix(), this._invViewProjMat);
     }
     return this._invViewProjMat;
   }

packages/core/src/ComponentsDependencies.ts

@@ -44,7 +44,7 @@ export class ComponentsDependencies {
       if (invDependencies) {
         for (let i = 0, len = invDependencies.length; i < len; i++) {
           if (entity.getComponent(invDependencies[i])) {
-            throw `Should remove ${invDependencies[i].name} before adding ${type.name}`;
+            throw `Should remove ${invDependencies[i].name} before remove ${type.name}`;
           }
         }
       }

packages/core/src/Entity.ts

@@ -7,6 +7,7 @@ import { Layer } from "./Layer";
 import { Scene } from "./Scene";
 import { Script } from "./Script";
 import { Transform } from "./Transform";
+import { UpdateFlagManager } from "./UpdateFlagManager";
 import { ReferResource } from "./asset/ReferResource";
 import { EngineObject } from "./base";
 import { ComponentCloner } from "./clone/ComponentCloner";
@@ -73,8 +74,6 @@ export class Entity extends EngineObject {
   name: string;
   /** The layer the entity belongs to. */
   layer: Layer = Layer.Layer0;
-  /** Transform component. */
-  readonly transform: Transform;
 
   /** @internal */
   _isActiveInHierarchy: boolean = false;
@@ -94,14 +93,24 @@ export class Entity extends EngineObject {
   _isActive: boolean = true;
   /** @internal */
   _siblingIndex: number = -1;
-
   /** @internal */
   _isTemplate: boolean = false;
+  /** @internal */
+  _updateFlagManager: UpdateFlagManager = new UpdateFlagManager();
+  /** @internal */
+  _transform: Transform;
 
   private _templateResource: ReferResource;
   private _parent: Entity = null;
   private _activeChangedComponents: Component[];
 
+  /**
+   * The transform of this entity.
+   */
+  get transform(): Transform {
+    return this._transform;
+  }
+
   /**
    * Whether to activate locally.
    */
@@ -192,12 +201,17 @@ export class Entity extends EngineObject {
   /**
    * Create a entity.
    * @param engine - The engine the entity belongs to
+   * @param name - The name of the entity
+   * @param components - The types of components you wish to add
    */
-  constructor(engine: Engine, name?: string) {
+  constructor(engine: Engine, name?: string, ...components: ComponentConstructor[]) {
     super(engine);
     this.name = name;
-    this.transform = this.addComponent(Transform);
-    this._inverseWorldMatFlag = this.transform.registerWorldChangeFlag();
+    for (let i = 0, n = components.length; i < n; i++) {
+      this.addComponent(components[i]);
+    }
+    !this._transform && this.addComponent(Transform);
+    this._inverseWorldMatFlag = this.registerWorldChangeFlag();
   }
 
   /**
@@ -394,7 +408,10 @@ export class Entity extends EngineObject {
    * @returns The child entity
    */
   createChild(name?: string): Entity {
-    const child = new Entity(this.engine, name);
+    const transform = this._transform;
+    const child = transform
+      ? new Entity(this.engine, name, transform.constructor as ComponentConstructor)
+      : new Entity(this.engine, name);
     child.layer = this.layer;
     child.parent = this;
     return child;
@@ -429,6 +446,14 @@ export class Entity extends EngineObject {
     return cloneEntity;
   }
 
+  /**
+   * Listen for changes in the world pose of this `Entity`.
+   * @returns Change flag
+   */
+  registerWorldChangeFlag(): BoolUpdateFlag {
+    return this._updateFlagManager.createFlag(BoolUpdateFlag);
+  }
+
   /**
    * @internal
    */
@@ -438,8 +463,10 @@ export class Entity extends EngineObject {
   }
 
   private _createCloneEntity(): Entity {
-    const cloneEntity = new Entity(this._engine, this.name);
-
+    const transform = this._transform;
+    const cloneEntity = transform
+      ? new Entity(this.engine, this.name, transform.constructor as ComponentConstructor)
+      : new Entity(this.engine, this.name);
     const templateResource = this._templateResource;
     if (templateResource) {
       cloneEntity._templateResource = templateResource;
@@ -448,12 +475,7 @@ export class Entity extends EngineObject {
 
     cloneEntity.layer = this.layer;
     cloneEntity._isActive = this._isActive;
-    const { transform: cloneTransform } = cloneEntity;
-    const { transform: srcTransform } = this;
-    cloneTransform.position = srcTransform.position;
-    cloneTransform.rotation = srcTransform.rotation;
-    cloneTransform.scale = srcTransform.scale;
-
+    cloneEntity.transform._copyFrom(this.transform);
     const srcChildren = this._children;
     for (let i = 0, n = srcChildren.length; i < n; i++) {
       cloneEntity.addChild(srcChildren[i]._createCloneEntity());
@@ -478,7 +500,7 @@ export class Entity extends EngineObject {
     for (let i = 0, n = components.length; i < n; i++) {
       const sourceComp = components[i];
       if (!(sourceComp instanceof Transform)) {
-        const targetComp = target.addComponent(<new (entity: Entity) => Component>sourceComp.constructor);
+        const targetComp = target.addComponent(<ComponentConstructor>sourceComp.constructor);
         ComponentCloner.cloneComponent(sourceComp, targetComp, srcRoot, targetRoot, deepInstanceMap);
       }
     }
@@ -765,3 +787,5 @@ type ComponentArguments<T extends new (entity: Entity, ...args: any[]) => Compon
 ) => Component
   ? P
   : never;
+
+type ComponentConstructor = new (entity: Entity) => Component;

packages/core/src/RenderPipeline/RenderQueue.ts

@@ -186,7 +186,7 @@ export class RenderQueue {
 
         renderState._applyStates(
           engine,
-          renderer.entity.transform._isFrontFaceInvert(),
+          renderer._transformEntity.transform._isFrontFaceInvert(),
           shaderPass._renderStateDataMap,
           material.shaderData,
           customStates

packages/core/src/Renderer.ts

@@ -59,6 +59,9 @@ export class Renderer extends Component implements IComponentCustomClone {
   /** @internal */
   @ignoreClone
   _batchedTransformShaderData: boolean = false;
+  /** @internal */
+  @ignoreClone
+  _transformEntity: Entity;
 
   @ignoreClone
   protected _overrideUpdate: boolean = false;
@@ -68,8 +71,6 @@ export class Renderer extends Component implements IComponentCustomClone {
   protected _dirtyUpdateFlag: number = 0;
   @ignoreClone
   protected _rendererLayer: Vector4 = new Vector4();
-  @ignoreClone
-  protected _transform: Transform;
 
   @deepClone
   private _shaderData: ShaderData = new ShaderData(ShaderDataGroup.Renderer);
@@ -172,7 +173,7 @@ export class Renderer extends Component implements IComponentCustomClone {
     this._addResourceReferCount(this.shaderData, 1);
 
     this._onTransformChanged = this._onTransformChanged.bind(this);
-    this._setTransform(entity.transform);
+    this._setTransformEntity(entity);
 
     shaderData.enableMacro(Renderer._receiveShadowMacro);
     shaderData.setVector4(Renderer._rendererLayerProperty, this._rendererLayer);
@@ -366,7 +367,7 @@ export class Renderer extends Component implements IComponentCustomClone {
   protected override _onDestroy(): void {
     super._onDestroy();
 
-    this._setTransform(null);
+    this._setTransformEntity(null);
     this._addResourceReferCount(this.shaderData, -1);
 
     const materials = this._materials;
@@ -392,7 +393,7 @@ export class Renderer extends Component implements IComponentCustomClone {
    * @internal
    */
   _updateTransformShaderData(context: RenderContext, onlyMVP: boolean, batched: boolean): void {
-    const worldMatrix = this._transform.worldMatrix;
+    const worldMatrix = this._transformEntity.transform.worldMatrix;
     if (onlyMVP) {
       this._updateProjectionRelatedShaderData(context, worldMatrix, batched);
     } else {
@@ -442,7 +443,7 @@ export class Renderer extends Component implements IComponentCustomClone {
       Matrix.invert(worldMatrix, normalMatrix);
       normalMatrix.transpose();
 
-      shaderData.setMatrix(Renderer._localMatrixProperty, this._transform.localMatrix);
+      shaderData.setMatrix(Renderer._localMatrixProperty, this._transformEntity.transform.localMatrix);
       shaderData.setMatrix(Renderer._worldMatrixProperty, worldMatrix);
       shaderData.setMatrix(Renderer._mvMatrixProperty, mvMatrix);
       shaderData.setMatrix(Renderer._mvInvMatrixProperty, mvInvMatrix);
@@ -465,10 +466,13 @@ export class Renderer extends Component implements IComponentCustomClone {
   /**
    * @internal
    */
-  protected _setTransform(transform: Transform): void {
-    this._transform?._updateFlagManager.removeListener(this._onTransformChanged);
-    transform?._updateFlagManager.addListener(this._onTransformChanged);
-    this._transform = transform;
+  protected _setTransformEntity(entity: Entity): void {
+    const preEntity = this._transformEntity;
+    if (entity !== preEntity) {
+      preEntity?._updateFlagManager.removeListener(this._onTransformChanged);
+      entity?._updateFlagManager.addListener(this._onTransformChanged);
+      this._transformEntity = entity;
+    }
   }
 
   /**

packages/core/src/Transform.ts

@@ -2,7 +2,6 @@ import { MathUtil, Matrix, Matrix3x3, Quaternion, Vector3 } from "@galacean/engi
 import { BoolUpdateFlag } from "./BoolUpdateFlag";
 import { Component } from "./Component";
 import { Entity } from "./Entity";
-import { UpdateFlagManager } from "./UpdateFlagManager";
 import { assignmentClone, deepClone, ignoreClone } from "./clone/CloneManager";
 
 /**
@@ -56,10 +55,6 @@ export class Transform extends Component {
   private _parentTransformCache: Transform = null;
   private _dirtyFlag: number = TransformModifyFlags.WmWpWeWqWs;
 
-  /** @internal */
-  @ignoreClone
-  _updateFlagManager: UpdateFlagManager = new UpdateFlagManager();
-
   /**
    * Local position.
    */
@@ -345,6 +340,12 @@ export class Transform extends Component {
     this._worldRotationQuaternion._onValueChanged = this._onWorldRotationQuaternionChanged;
     //@ts-ignore
     this._scale._onValueChanged = this._onScaleChanged;
+
+    if (entity._transform) {
+      throw `Entity already has a transform.`;
+    } else {
+      entity._transform = this;
+    }
   }
 
   /**
@@ -561,14 +562,6 @@ export class Transform extends Component {
     rotMat.getRotation(this._worldRotationQuaternion);
   }
 
-  /**
-   * Register world transform change flag.
-   * @returns Change flag
-   */
-  registerWorldChangeFlag(): BoolUpdateFlag {
-    return this._updateFlagManager.createFlag(BoolUpdateFlag);
-  }
-
   /**
    * @internal
    */
@@ -588,6 +581,15 @@ export class Transform extends Component {
     return isInvert;
   }
 
+  /**
+   * @internal
+   */
+  _copyFrom(transform: Transform): void {
+    this._position.copyFrom(transform._position);
+    this._rotation.copyFrom(transform._rotation);
+    this._scale.copyFrom(transform._scale);
+  }
+
   protected override _onDestroy(): void {
     super._onDestroy();
     //@ts-ignore
@@ -762,7 +764,7 @@ export class Transform extends Component {
 
   private _worldAssociatedChange(type: number): void {
     this._dirtyFlag |= type;
-    this._updateFlagManager.dispatch(type);
+    this._entity._updateFlagManager.dispatch(type);
   }
 
   private _rotateByQuat(rotateQuat: Quaternion, relativeToLocal: boolean): void {
@@ -875,6 +877,16 @@ export class Transform extends Component {
     }
     return this._worldUniformScaling;
   }
+
+  //--------------------------------------------------------------deprecated----------------------------------------------------------------
+  /**
+   * @deprecated
+   * Listen for changes in the world pose of this `Entity`.
+   * @returns Change flag
+   */
+  registerWorldChangeFlag(): BoolUpdateFlag {
+    return this.entity._updateFlagManager.createFlag(BoolUpdateFlag);
+  }
 }
 
 /**

packages/core/src/mesh/MeshRenderer.ts

@@ -102,8 +102,7 @@ export class MeshRenderer extends Renderer {
     const mesh = this._mesh;
     if (mesh) {
       const localBounds = mesh.bounds;
-      const worldMatrix = this._entity.transform.worldMatrix;
-      BoundingBox.transform(localBounds, worldMatrix, worldBounds);
+      BoundingBox.transform(localBounds, this._transformEntity.transform.worldMatrix, worldBounds);
     } else {
       worldBounds.min.set(0, 0, 0);
       worldBounds.max.set(0, 0, 0);