@galacean/engine-core 2.0.0-alpha.45 → 2.0.0-alpha.47

package/dist/main.js

@@ -5022,10 +5022,25 @@ registerDefaultCloneMode(Component, CloneMode.Remap);
     };
     /**
    * @internal
-   */ ComponentsDependencies._removeCheck = function _removeCheck(entity, type) {
+   */ ComponentsDependencies._hasDependencies = function _hasDependencies(type) {
+        while(type !== Component){
+            if (ComponentsDependencies._dependenciesMap.has(type)) {
+                return true;
+            }
+            type = Object.getPrototypeOf(type);
+        }
+        return false;
+    };
+    /**
+   * @internal
+   */ ComponentsDependencies._removeCheck = function _removeCheck(entity, type, replace) {
         var components = entity._components;
         var n = components.length;
         while(type !== Component){
+            // The replacement still satisfies this type and all of its base types
+            if (replace && (replace === type || _instanceof(replace.prototype, type))) {
+                return;
+            }
             var count = 0;
             for(var i = 0; i < n; i++){
                 if (_instanceof(components[i], type) && ++count > 1) return;
@@ -5142,6 +5157,7 @@ registerDefaultCloneMode(UpdateFlag, CloneMode.Ignore);
 
 /**
  * Used to implement transformation related functions.
+ * @remarks A `Transform` subclass must not declare component dependencies.
  */ var Transform = /*#__PURE__*/ function(Component) {
     _inherits(Transform, Component);
     function Transform(entity) {
@@ -5171,6 +5187,13 @@ registerDefaultCloneMode(UpdateFlag, CloneMode.Ignore);
         return _this;
     }
     var _proto = Transform.prototype;
+    _proto.destroy = function destroy() {
+        var entity = this._entity;
+        if (entity.transform === this && !entity.destroyed) {
+            throw "Transform cannot be destroyed directly; replace it by adding another Transform-compatible component";
+        }
+        Component.prototype.destroy.call(this);
+    };
     /**
    * Set local position by X, Y, Z value.
    * @param x - X coordinate
@@ -5309,22 +5332,35 @@ registerDefaultCloneMode(UpdateFlag, CloneMode.Ignore);
         return isInvert;
     };
     /**
+   * @internal
+   */ _proto._copyLocalPoseFrom = function _copyLocalPoseFrom(source) {
+        var _this = this, position = _this._position, rotation = _this._rotation, rotationQuaternion = _this._rotationQuaternion, scale = _this._scale;
+        //@ts-ignore
+        position._onValueChanged = rotation._onValueChanged = scale._onValueChanged = null;
+        //@ts-ignore
+        rotationQuaternion._onValueChanged = null;
+        position.copyFrom(source._position);
+        scale.copyFrom(source._scale);
+        rotation.copyFrom(source._rotation);
+        rotationQuaternion.copyFrom(source._rotationQuaternion);
+        //@ts-ignore
+        position._onValueChanged = this._onPositionChanged;
+        //@ts-ignore
+        rotation._onValueChanged = this._onRotationChanged;
+        //@ts-ignore
+        rotationQuaternion._onValueChanged = this._onRotationQuaternionChanged;
+        //@ts-ignore
+        scale._onValueChanged = this._onScaleChanged;
+        this._localUniformScaling = source._localUniformScaling;
+        var rotationDirtyBits = 1 | 2;
+        this._dirtyFlag = this._dirtyFlag & ~rotationDirtyBits | source._dirtyFlag & rotationDirtyBits;
+        this._setDirtyFlagTrue(64);
+        this._updateAllWorldFlag(444);
+    };
+    /**
    * @inheritdoc
    */ _proto._onClone = function _onClone(target) {
-        var position = target._position, rotation = target._rotation, scale = target._scale;
-        // @ts-ignore
-        position._onValueChanged = rotation._onValueChanged = scale._onValueChanged = null;
-        position.copyFrom(this.position);
-        rotation.copyFrom(this.rotation);
-        scale.copyFrom(this.scale);
-        // @ts-ignore
-        position._onValueChanged = target._onPositionChanged;
-        // @ts-ignore
-        rotation._onValueChanged = target._onRotationChanged;
-        // @ts-ignore
-        scale._onValueChanged = target._onScaleChanged;
-        // When cloning, other components may obtain properties such as `rotationQuaternion` in the constructor, local related dirty flags need to be corrected
-        target._setDirtyFlagTrue(2 | 64);
+        target._copyLocalPoseFrom(this);
     };
     _proto._onLocalMatrixChanging = function _onLocalMatrixChanging() {
         this._setDirtyFlagFalse(64);
@@ -6175,10 +6211,27 @@ function _construct(Parent, args, Class) {
         _this = EngineObject.call(this, engine) || this, /** The layer the entity belongs to. */ _this.layer = Layer.Layer0, /** @internal */ _this._isActiveInHierarchy = false, /** @internal */ _this._isActiveInScene = false, /** @internal */ _this._components = [], /** @internal */ _this._scripts = new DisorderedArray(), /** @internal */ _this._scriptsVersion = 0, /** @internal */ _this._children = [], /** @internal */ _this._isRoot = false, /** @internal */ _this._isActive = true, /** @internal */ _this._siblingIndex = -1, /** @internal */ _this._isTemplate = false, /** @internal */ _this._updateFlagManager = new UpdateFlagManager(), _this._parent = null, //--------------------------------------------------------------deprecated----------------------------------------------------------------
         _this._invModelMatrix = new engineMath.Matrix();
         _this.name = name != null ? name : "Entity";
-        for(var i = 0, n = components.length; i < n; i++){
-            _this.addComponent(components[i]);
+        var transformType = Transform;
+        var n = components.length;
+        for(var i = n - 1; i >= 0; i--){
+            var componentType = components[i];
+            if (Entity._isTransformType(componentType)) {
+                transformType = componentType;
+                break;
+            }
+        }
+        Entity._checkTransformDependencies(transformType);
+        var transform = new transformType(_this);
+        // Constructors may add components, but Transform always owns slot zero
+        _this._components.unshift(transform);
+        _this._transform = transform;
+        transform._setActive(true, ActiveChangeFlag.All);
+        for(var i1 = 0; i1 < n; i1++){
+            var componentType1 = components[i1];
+            if (!Entity._isTransformType(componentType1)) {
+                _this.addComponent(componentType1);
+            }
         }
-        !_this._transform && _this.addComponent(Transform);
         _this._inverseWorldMatFlag = _this.registerWorldChangeFlag();
         return _this;
     }
@@ -6192,13 +6245,21 @@ function _construct(Parent, args, Class) {
         for(var _len = arguments.length, args = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++){
             args[_key - 1] = arguments[_key];
         }
-        ComponentsDependencies._addCheck(this, type);
+        var isTransform = Entity._isTransformType(type);
+        if (isTransform) {
+            Entity._checkTransformDependencies(type);
+            ComponentsDependencies._removeCheck(this, this._transform.constructor, type);
+        } else {
+            ComponentsDependencies._addCheck(this, type);
+        }
         var component = _construct(type, [].concat([
             this
         ], args));
-        this._components.push(component);
-        // @todo: temporary solution
-        if (_instanceof(component, Transform)) this._setTransform(component);
+        if (isTransform) {
+            this._replaceTransform(component);
+        } else {
+            this._components.push(component);
+        }
         component._setActive(true, ActiveChangeFlag.All);
         return component;
     };
@@ -6346,6 +6407,7 @@ function _construct(Parent, args, Class) {
     _proto._createCloneEntity = function _createCloneEntity(cloneMap) {
         var componentConstructors = Entity._tempComponentConstructors;
         var components = this._components;
+        componentConstructors.length = components.length;
         for(var i = 0, n = components.length; i < n; i++){
             componentConstructors[i] = components[i].constructor;
         }
@@ -6413,9 +6475,13 @@ function _construct(Parent, args, Class) {
     /**
    * @internal
    */ _proto._removeComponent = function _removeComponent(component) {
-        ComponentsDependencies._removeCheck(this, component.constructor);
         var components = this._components;
-        components.splice(components.indexOf(component), 1);
+        var index = components.indexOf(component);
+        // A replaced Transform is detached from the component slot immediately but
+        // can still reach here later because object destruction may be deferred
+        if (index < 0) return;
+        ComponentsDependencies._removeCheck(this, component.constructor);
+        components.splice(index, 1);
     };
     /**
    * @internal
@@ -6617,15 +6683,16 @@ function _construct(Parent, args, Class) {
             }
         }
     };
-    _proto._setTransform = function _setTransform(value) {
-        var _this__transform;
-        (_this__transform = this._transform) == null ? void 0 : _this__transform.destroy();
-        this._transform = value;
+    _proto._replaceTransform = function _replaceTransform(replacement) {
+        var previous = this._transform;
+        replacement._copyLocalPoseFrom(previous);
+        this._components[0] = replacement;
+        this._transform = replacement;
         var children = this._children;
         for(var i = 0, n = children.length; i < n; i++){
-            var _children_i_transform;
-            (_children_i_transform = children[i].transform) == null ? void 0 : _children_i_transform._parentChange();
+            children[i].transform._parentChange();
         }
+        previous.destroy();
     };
     /**
    * @deprecated
@@ -6636,6 +6703,14 @@ function _construct(Parent, args, Class) {
         }
         return this._invModelMatrix;
     };
+    Entity._isTransformType = function _isTransformType(type) {
+        return type === Transform || _instanceof(type.prototype, Transform);
+    };
+    Entity._checkTransformDependencies = function _checkTransformDependencies(type) {
+        if (ComponentsDependencies._hasDependencies(type)) {
+            throw "Transform-compatible component " + type.name + " cannot declare component dependencies";
+        }
+    };
     /**
    * @internal
    */ Entity._findChildByName = function _findChildByName(entity, childIndex, paths, pathIndex) {
@@ -14751,6 +14826,7 @@ BlendShapeManager._blendShapeTextureInfoProperty = ShaderProperty.getByName("ren
 
 /**
  * Mesh containing common vertex elements of the model.
+ * Define draw ranges with `addSubMesh()` and assign a material to each corresponding MeshRenderer slot.
  */ var ModelMesh = /*#__PURE__*/ function(Mesh) {
     _inherits(ModelMesh, Mesh);
     function ModelMesh(engine, name) {
@@ -15084,8 +15160,8 @@ BlendShapeManager._blendShapeTextureInfoProperty = ShaderProperty.getByName("ren
         return blendShapes[index].name;
     };
     /**
-   * Upload data to GPU set by `setPositions()`, `setNormals()`, `setColors()`, `setBoneWeights()`, `setBoneIndices()`, `setTangents()`, `setUVs()`, `setIndices()` methods.
-   * This method will be auto generate vertex element and vertex buffer binding if needed.
+   * Upload mesh data to the GPU, generating vertex elements and buffer bindings as needed.
+   * Bounds must be set separately for culling.
    *
    * @param releaseData - Whether to release the data cache, release data can reduce memory usage.
    */ _proto.uploadData = function uploadData(releaseData) {
@@ -19509,7 +19585,7 @@ var rePropName = RegExp(// Match anything that isn't a dot or bracket.
  * Pointer.
  */ var Pointer = /*#__PURE__*/ function() {
     function Pointer(id) {
-        /** The phase of pointer. */ this.phase = PointerPhase.Leave;
+        /** The current phase of this pointer. */ this.phase = PointerPhase.Leave;
         /** The position of the pointer in screen space pixel coordinates. */ this.position = new engineMath.Vector2();
         /** The change of the pointer. */ this.deltaPosition = new engineMath.Vector2();
         /** @internal */ this._events = [];
@@ -22988,9 +23064,9 @@ PointerEventEmitter._tempRay = new engineMath.Ray();
         }
     };
     /**
-   * Whether the pointer starts to be pressed down during the current frame, if there is no parameter, return whether any pointer starts to be pressed down during the current frame.
-   * @param pointerButton - The pointerButton on a pointer device
-   * @returns Whether the pointer starts to be pressed down during the current frame
+   * Whether any pointer was pressed this frame.
+   * @param pointerButton - The button to query; omit to include all buttons
+   * @returns The result remains true for the frame, even if a release also occurred
    */ _proto.isPointerDown = function isPointerDown(pointerButton) {
         if (this._initialized) {
             if (pointerButton === undefined) {
@@ -23003,9 +23079,9 @@ PointerEventEmitter._tempRay = new engineMath.Ray();
         }
     };
     /**
-   * Whether the pointer is released during the current frame, if there is no parameter, return whether any pointer released during the current frame.
-   * @param pointerButton - The pointerButtons on a mouse device
-   * @returns Whether the pointer is released during the current frame
+   * Whether any pointer was released this frame.
+   * @param pointerButton - The button to query; omit to include all buttons
+   * @returns The result remains true for the frame, even if a press also occurred
    */ _proto.isPointerUp = function isPointerUp(pointerButton) {
         if (this._initialized) {
             if (pointerButton === undefined) {