@galacean/effects-core 2.6.0-beta.0 → 2.6.0

package/dist/events/types.d.ts

@@ -29,12 +29,14 @@ export type CompositionEvent<C> = {
     ];
     /**
      * 合成开始播放事件
+     * @since 2.6.0
      */
     ['play']: [playInfo: {
         time: number;
     }];
     /**
      * 合成暂停事件
+     * @since 2.6.0
      */
     ['pause']: [];
     /**

package/dist/index.js

@@ -3,7 +3,7 @@
  * Description: Galacean Effects runtime core for the web
  * Author: Ant Group CO., Ltd.
  * Contributors: 燃然,飂兮,十弦,云垣,茂安,意绮
- * Version: v2.6.0-beta.0
+ * Version: v2.6.0
  */
 
 'use strict';
@@ -466,6 +466,8 @@ function getPixelRatio() {
     }
     return 1;
 }
+// window 对象不存在时需要判断
+var canUseBOM = typeof window !== "undefined";
 function isIOS() {
     // real ios device not in simulator
     return !!navigator.platform && /iPad|iPhone|iPod/.test(navigator.platform);
@@ -5584,7 +5586,7 @@ var Skeleton = /*#__PURE__*/ function() {
     };
     _proto.addRecordedProperty = function addRecordedProperty(path, className, property, type) {
         var totalPath = path + className + property;
-        if (this.pathToObjectIndex.get(totalPath)) {
+        if (this.pathToObjectIndex.get(totalPath) !== undefined) {
             return;
         }
         var targetBone = this.findTarget(path);
@@ -8290,6 +8292,8 @@ function gpuTimer(gl) {
 
 var initErrors = [];
 var glContext = {};
+var IOS16_LOCKDOWN_MODE = "iOS16 lockdown mode, WebGL Constants not in global";
+var WEBGL_CONSTANTS_NOT_IN_GLOBAL = "WebGL Constants not in global, please check your environment";
 if (!initErrors.length) {
     initGLContext();
 }
@@ -8301,8 +8305,12 @@ function initGLContext() {
         copy(WebGLRenderingContext);
         copy(WebGLRenderingContext.prototype);
     } else {
-        initErrors.push(isIOS() ? // iOS 16 lockdown mode
-        "iOS16 lockdown mode, WebGL Constants not in global" : "WebGL Constants not in global, please check your environment");
+        if (canUseBOM) {
+            initErrors.push(// iOS 16 lockdown mode
+            isIOS() ? IOS16_LOCKDOWN_MODE : WEBGL_CONSTANTS_NOT_IN_GLOBAL);
+        } else {
+            initErrors.push(WEBGL_CONSTANTS_NOT_IN_GLOBAL);
+        }
     }
     if (!initErrors.length && !("HALF_FLOAT" in glContext)) {
         // @ts-expect-error set default value
@@ -10012,18 +10020,15 @@ var MaskProcessor = /*#__PURE__*/ function() {
     _proto.getRefValue = function getRefValue() {
         return 1;
     };
-    _proto.getMaskMode = function getMaskMode(data) {
+    _proto.setMaskOptions = function setMaskOptions(data) {
         var _data_isMask = data.isMask, isMask = _data_isMask === void 0 ? false : _data_isMask, _data_inverted = data.inverted, inverted = _data_inverted === void 0 ? false : _data_inverted, reference = data.reference, _data_alphaMaskEnabled = data.alphaMaskEnabled, alphaMaskEnabled = _data_alphaMaskEnabled === void 0 ? false : _data_alphaMaskEnabled;
         this.alphaMaskEnabled = alphaMaskEnabled;
         if (isMask) {
             this.maskMode = exports.MaskMode.MASK;
         } else {
             this.maskMode = inverted ? exports.MaskMode.REVERSE_OBSCURED : exports.MaskMode.OBSCURED;
-            if (reference) {
-                this.maskable = this.engine.findObject(reference);
-            }
+            this.maskable = this.engine.findObject(reference);
         }
-        return this.maskMode;
     };
     _proto.drawStencilMask = function drawStencilMask(renderer) {
         if (this.maskable) {
@@ -15210,7 +15215,7 @@ var singleSplits = [
         var textureSheetAnimation = baseRenderComponentData.textureSheetAnimation;
         var maskOptions = baseRenderComponentData.mask;
         if (maskOptions) {
-            this.maskManager.getMaskMode(maskOptions);
+            this.maskManager.setMaskOptions(maskOptions);
         }
         // TODO 新蒙板上线后移除
         //-------------------------------------------------------------------------
@@ -15616,7 +15621,7 @@ exports.ShapeComponent = /*#__PURE__*/ function(BaseRenderComponent) {
                 }
         }
         if (data.mask) {
-            this.maskManager.getMaskMode(data.mask);
+            this.maskManager.setMaskOptions(data.mask);
         }
         var maskRef = this.maskManager.getRefValue();
         this.material.stencilRef = maskRef !== undefined ? [
@@ -15843,6 +15848,7 @@ var EventSystem = /*#__PURE__*/ function() {
         var touchstart = "mousedown";
         var touchmove = "mousemove";
         var touchend = "mouseup";
+        var touchcancel = "mouseleave";
         var getTouchEventValue = function(event, x, y, dx, dy) {
             if (dx === void 0) dx = 0;
             if (dy === void 0) dy = 0;
@@ -15896,6 +15902,7 @@ var EventSystem = /*#__PURE__*/ function() {
             touchstart = "touchstart";
             touchmove = "touchmove";
             touchend = "touchend";
+            touchcancel = "touchcancel";
         }
         var _obj;
         this.nativeHandlers = (_obj = {}, _obj[touchstart] = function(event) {
@@ -15938,6 +15945,7 @@ var EventSystem = /*#__PURE__*/ function() {
             }
             currentTouch = 0;
         }, _obj);
+        this.nativeHandlers[touchcancel] = this.nativeHandlers[touchend];
         Object.keys(this.nativeHandlers).forEach(function(name) {
             var _this_target;
             (_this_target = _this.target) == null ? void 0 : _this_target.addEventListener(String(name), _this.nativeHandlers[name]);
@@ -18071,16 +18079,23 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
         var _this;
         _this = RendererComponent.apply(this, arguments) || this;
         /**
-   * 拖拽的惯性衰减系数，范围[0, 1], 越大惯性越强
+   * 拖拽后的惯性衰减系数，范围[0, 1], 越大惯性越强
+   * @default 0.95
    */ _this.downgrade = 0.95;
         /**
-   * 拖拽的距离映射系数，越大越容易拖动
+   * 拖拽后的惯性速度，范围[0, +∞), 越大惯性越强
+   * @default 25
+   * @since 2.6.0
+   */ _this.speed = 25;
+        /**
+   * 拖拽时的距离映射系数，越大越容易拖动
+   * @default [1, 1]
    */ _this.dragRatio = [
             1,
             1
         ];
         /**
-   * 拖拽X范围
+   * 拖拽范围（编辑器制作时已经设置好，特殊情况可运行时修改）
    */ _this.dragRange = {
             dxRange: [
                 0,
@@ -18091,6 +18106,13 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
                 0
             ]
         };
+        /**
+   * 滑动失效区域，范围[0, 1]，单位 %，避免滑动触控冲突（如 iOS 右滑退出时不执行）
+   * > 若是数组形式，格式为：[top、right、bottom、left]
+   * @since 2.6.0
+   * @default 0
+   */ _this.invalidBorderRange = 0;
+        _this.invalidByBorderRange = false;
         _this.duringPlay = false;
         /** 是否响应点击和拖拽交互事件 */ _this._interactive = true;
         _this.lastTime = -1;
@@ -18130,7 +18152,6 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
         ];
     };
     _proto.onStart = function onStart() {
-        var options = this.item.props.content.options;
         var env = this.item.engine.renderer.env;
         var composition = this.item.composition;
         var _this_interactData_options = this.interactData.options, type = _this_interactData_options.type, showPreview = _this_interactData_options.showPreview;
@@ -18143,11 +18164,6 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
                 }
             }
         }
-        if (options.type === InteractType.DRAG) {
-            if (env !== PLAYER_OPTIONS_ENV_EDITOR || options.enableInEditor) {
-                (composition == null ? void 0 : composition.event) && this.beginDragTarget(options, composition.event);
-            }
-        }
         if (this.previewContent) {
             this.previewContent.mesh.item = this.item;
             this.materials = this.previewContent.mesh.materials;
@@ -18157,7 +18173,8 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
     _proto.onDisable = function onDisable() {
         RendererComponent.prototype.onDisable.call(this);
         if (this.item && this.item.composition) {
-            if (this.duringPlay && !this.item.transform.getValid()) {
+            // Triggers the Message end event, do not trigger when reverse playback
+            if (this.duringPlay && !this.item.transform.getValid() && this.item.composition.getSpeed() > 0) {
                 this.item.composition.removeInteractiveItem(this.item, this.item.props.content.options.type);
                 this.duringPlay = false;
             }
@@ -18176,14 +18193,17 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
             var enableInEditor = options.enableInEditor;
             if (env !== PLAYER_OPTIONS_ENV_EDITOR || enableInEditor) {
                 var _this_item_composition;
-                ((_this_item_composition = this.item.composition) == null ? void 0 : _this_item_composition.event) && this.beginDragTarget(options, this.item.composition.event);
+                var event = ((_this_item_composition = this.item.composition) != null ? _this_item_composition : {}).event;
+                if (event) {
+                    this.beginDragTarget(options, event);
+                }
             }
         }
     };
     _proto.onUpdate = function onUpdate(dt) {
         var _this_previewContent;
         this.duringPlay = true;
-        // trigger messageBegin when item enter
+        // Trigger messageBegin when item enter
         if (this.lastTime <= this.item.time) {
             if (this.item.time >= 0 && this.lastTime < 0) {
                 var _this_item_composition;
@@ -18191,8 +18211,8 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
                 (_this_item_composition = this.item.composition) == null ? void 0 : _this_item_composition.addInteractiveItem(this.item, options.type);
             }
         } else {
-            // loop trigger
-            if (this.item.time >= 0) {
+            // Loop trigger, do not trigger when reverse playback
+            if (this.item.time >= 0 && dt > 0) {
                 var _this_item_composition1;
                 var options1 = this.item.props.content.options;
                 (_this_item_composition1 = this.item.composition) == null ? void 0 : _this_item_composition1.addInteractiveItem(this.item, options1.type);
@@ -18266,6 +18286,13 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
                 if (!_this.canInteract()) {
                     return;
                 }
+                _this.invalidByBorderRange = _this.checkInvalidBorderRange({
+                    x: event.x,
+                    y: event.y
+                });
+                if (_this.invalidByBorderRange) {
+                    return;
+                }
                 _this.dragEvent = null;
                 _this.bouncingArg = null;
                 var camera = (_this_item_composition = _this.item.composition) == null ? void 0 : _this_item_composition.camera;
@@ -18283,6 +18310,9 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
                 };
             },
             touchmove: function(event) {
+                if (_this.invalidByBorderRange) {
+                    return;
+                }
                 _this.handleDragMove(dragEvent, event);
                 _this.bouncingArg = event;
             },
@@ -18292,9 +18322,8 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
                 }
                 var bouncingArg = _this.bouncingArg;
                 if (!shouldIgnoreBouncing(bouncingArg, 3) && bouncingArg) {
-                    var speed = 5;
-                    bouncingArg.vx *= speed;
-                    bouncingArg.vy *= speed;
+                    bouncingArg.vx *= _this.speed;
+                    bouncingArg.vy *= _this.speed;
                     _this.dragEvent = _extends({}, dragEvent);
                 }
                 dragEvent = null;
@@ -18345,6 +18374,31 @@ exports.InteractComponent = /*#__PURE__*/ function(RendererComponent) {
         var _this_item_composition;
         return Boolean((_this_item_composition = this.item.composition) == null ? void 0 : _this_item_composition.interactive) && this._interactive;
     };
+    /**
+   * 检查滑动手势边界
+   * @param position
+   */ _proto.checkInvalidBorderRange = function checkInvalidBorderRange(position) {
+        var invalidBorderRange = this.invalidBorderRange;
+        if (invalidBorderRange) {
+            var top = 0;
+            var right = 0;
+            var bottom = 0;
+            var left = 0;
+            if (typeof invalidBorderRange === "number") {
+                top = invalidBorderRange;
+                right = invalidBorderRange;
+                bottom = invalidBorderRange;
+                left = invalidBorderRange;
+            } else if (isArray(invalidBorderRange)) {
+                var ref, ref1, ref2, ref3, ref4;
+                ref = invalidBorderRange, ref1 = ref[0], top = ref1 === void 0 ? 0 : ref1, ref2 = ref[1], right = ref2 === void 0 ? 0 : ref2, ref3 = ref[2], bottom = ref3 === void 0 ? 0 : ref3, ref4 = ref[3], left = ref4 === void 0 ? 0 : ref4;
+            }
+            if (position.x < left - 1 || position.x > 1 - right || position.y < top - 1 || position.y > 1 - bottom) {
+                return true;
+            }
+        }
+        return false;
+    };
     _create_class(InteractComponent, [
         {
             key: "interactive",
@@ -22139,7 +22193,9 @@ exports.ParticleSystem = /*#__PURE__*/ function(Component) {
             this.options.startSize = createValueGetter(options.startSize);
             this.options.sizeAspect = createValueGetter(options.sizeAspect || 1);
         }
-        var maskProps = this.getMaskOptions(props);
+        if (props.mask) {
+            this.maskManager.setMaskOptions(props.mask);
+        }
         var particleMeshProps = {
             // listIndex: vfxItem.listIndex,
             meshSlots: options.meshSlots,
@@ -22160,8 +22216,8 @@ exports.ParticleSystem = /*#__PURE__*/ function(Component) {
             occlusion: !!renderer.occlusion,
             transparentOcclusion: !!renderer.transparentOcclusion,
             maxCount: options.maxCount,
-            mask: maskProps.maskRef,
-            maskMode: maskProps.maskMode,
+            mask: this.maskManager.getRefValue(),
+            maskMode: this.maskManager.maskMode,
             forceTarget: forceTarget,
             diffuse: renderer.texture ? this.engine.findObject(renderer.texture) : undefined,
             sizeOverLifetime: sizeOverLifetimeGetter,
@@ -22242,7 +22298,9 @@ exports.ParticleSystem = /*#__PURE__*/ function(Component) {
                 inheritParticleColor: !!trails.inheritParticleColor,
                 parentAffectsPosition: !!trails.parentAffectsPosition
             };
-            maskProps = this.getMaskOptions(trails);
+            if (trails.mask) {
+                this.maskManager.setMaskOptions(trails.mask);
+            }
             trailMeshProps = {
                 name: "Trail",
                 matrix: Matrix4.IDENTITY,
@@ -22259,8 +22317,8 @@ exports.ParticleSystem = /*#__PURE__*/ function(Component) {
                 occlusion: !!trails.occlusion,
                 transparentOcclusion: !!trails.transparentOcclusion,
                 textureMap: trails.textureMap,
-                mask: maskProps.maskRef,
-                maskMode: maskProps.maskMode
+                mask: this.maskManager.getRefValue(),
+                maskMode: this.maskManager.maskMode
             };
             if (trails.colorOverLifetime && trails.colorOverLifetime[0] === ValueType.GRADIENT_COLOR) {
                 trailMeshProps.colorOverLifetime = trails.colorOverLifetime[1];
@@ -22285,18 +22343,6 @@ exports.ParticleSystem = /*#__PURE__*/ function(Component) {
         this.item.getHitTestParams = this.getHitTestParams;
         this.item._content = this;
     };
-    _proto.getMaskOptions = function getMaskOptions(data) {
-        var maskMode = exports.MaskMode.NONE;
-        var maskRef = 0;
-        if (data.mask) {
-            maskMode = this.maskManager.getMaskMode(data.mask);
-            maskRef = this.maskManager.getRefValue();
-        }
-        return {
-            maskMode: maskMode,
-            maskRef: maskRef
-        };
-    };
     _create_class(ParticleSystem, [
         {
             key: "timePassed",
@@ -25474,7 +25520,11 @@ exports.SpriteComponent = /*#__PURE__*/ function(BaseRenderComponent) {
                 dy
             ]);
         }
-        this.time += dt / 1000;
+        this.time = time + dt / 1000;
+    };
+    _proto.onDisable = function onDisable() {
+        BaseRenderComponent.prototype.onDisable.call(this);
+        this.time = 0;
     };
     _proto.onDestroy = function onDestroy() {
         var texture = this.renderer.texture;
@@ -30105,6 +30155,7 @@ var itemMap = new Map();
             }
         }
     }
+    json.version = JSONSceneVersion["3_2"];
     return json;
 }
 function version32Migration(json) {
@@ -30124,6 +30175,7 @@ function version32Migration(json) {
         var comp = _step2.value;
         processContent(comp);
     }
+    json.version = JSONSceneVersion["3_3"];
     return json;
 }
 function version33Migration(json) {
@@ -30191,6 +30243,7 @@ function version33Migration(json) {
             }
         }
     }
+    json.version = JSONSceneVersion["3_4"];
     return json;
 }
 function processContent(composition) {
@@ -31046,7 +31099,7 @@ function getStandardSpriteContent(sprite, transform) {
     return ret;
 }
 
-var version$1 = "2.6.0-beta.0";
+var version$1 = "2.6.0";
 var v0 = /^(\d+)\.(\d+)\.(\d+)(-(\w+)\.\d+)?$/;
 var standardVersion = /^(\d+)\.(\d+)$/;
 var reverseParticle = false;
@@ -34296,7 +34349,7 @@ registerPlugin("sprite", SpriteLoader, exports.VFXItem);
 registerPlugin("particle", ParticleLoader, exports.VFXItem);
 registerPlugin("cal", CalculateLoader, exports.VFXItem);
 registerPlugin("interact", InteractLoader, exports.VFXItem);
-var version = "2.6.0-beta.0";
+var version = "2.6.0";
 logger.info("Core version: " + version + ".");
 
 exports.AbstractPlugin = AbstractPlugin;
@@ -34454,6 +34507,7 @@ exports.base64ToFile = base64ToFile;
 exports.blend = blend;
 exports.buildLine = buildLine;
 exports.calculateTranslation = calculateTranslation;
+exports.canUseBOM = canUseBOM;
 exports.canvasPool = canvasPool;
 exports.closePointEps = closePointEps;
 exports.colorGradingFrag = colorGradingFrag;