@galacean/effects-core 2.5.0-alpha.0 → 2.5.0-alpha.1

package/dist/components/base-render-component.d.ts

@@ -2,7 +2,7 @@ import { Color } from '@galacean/effects-math/es/core/color';
 import * as spec from '@galacean/effects-specification';
 import type { Engine } from '../engine';
 import type { Maskable } from '../material';
-import { MaskMode, MaskProcessor } from '../material';
+import { MaskProcessor } from '../material';
 import type { BoundingBoxTriangle, HitTestTriangleParams, splitsDataType } from '../plugins';
 import { MeshCollider } from '../plugins';
 import type { Renderer } from '../render';
@@ -16,9 +16,7 @@ import { RendererComponent } from './renderer-component';
 export interface ItemRenderer extends Required<Omit<spec.RendererOptions, 'texture' | 'shape' | 'anchor' | 'particleOrigin' | 'mask'>> {
     texture: Texture;
     mask: number;
-    maskMode: MaskMode;
     shape?: GeometryFromShape;
-    alphaMask: boolean;
 }
 /**
  * @since 2.1.0

package/dist/index.js

@@ -3,7 +3,7 @@
  * Description: Galacean Effects runtime core for the web
  * Author: Ant Group CO., Ltd.
  * Contributors: 燃然,飂兮,十弦,云垣,茂安,意绮
- * Version: v2.5.0-alpha.0
+ * Version: v2.5.0-alpha.1
  */
 
 'use strict';
@@ -680,6 +680,17 @@ function asserts(condition, msg) {
     return /^[^\d.][\w-]*$/.test(fontFamily);
 }
 
+/**
+ * Simple implementation of the deferred pattern.
+ * An object that exposes a promise and functions to resolve and reject it.
+ */ var Deferred = function Deferred() {
+    var _this = this;
+    this.promise = new Promise(function(resolve, reject) {
+        _this.resolve = resolve;
+        _this.reject = reject;
+    });
+};
+
 var prefix = "[Galacean Effects]";
 var localLogger;
 function format(message) {
@@ -7625,6 +7636,8 @@ exports.MaterialRenderType = void 0;
 var MaskProcessor = /*#__PURE__*/ function() {
     function MaskProcessor(engine) {
         this.engine = engine;
+        this.alphaMaskEnabled = false;
+        this.maskMode = exports.MaskMode.NONE;
         this.maskable = null;
         this.stencilClearAction = {
             stencilAction: exports.TextureLoadAction.clear
@@ -7635,19 +7648,17 @@ var MaskProcessor = /*#__PURE__*/ function() {
         return 1;
     };
     _proto.getMaskMode = function getMaskMode(data) {
-        var maskMode = exports.MaskMode.NONE;
-        if (data.mask) {
-            var _data_mask = data.mask, _data_mask_mask = _data_mask.mask, mask = _data_mask_mask === void 0 ? false : _data_mask_mask, _data_mask_mode = _data_mask.mode, mode = _data_mask_mode === void 0 ? exports.MaskMode.NONE : _data_mask_mode, ref = _data_mask.ref;
-            if (mask) {
-                maskMode = exports.MaskMode.MASK;
-            } else if (mode === ObscuredMode.OBSCURED || mode === ObscuredMode.REVERSE_OBSCURED) {
-                maskMode = mode === ObscuredMode.OBSCURED ? exports.MaskMode.OBSCURED : exports.MaskMode.REVERSE_OBSCURED;
-                if (ref) {
-                    this.maskable = ref;
-                }
+        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);
             }
         }
-        return maskMode;
+        return this.maskMode;
     };
     _proto.drawStencilMask = function drawStencilMask(renderer) {
         if (this.maskable) {
@@ -12491,9 +12502,7 @@ var singleSplits = [
             occlusion: false,
             transparentOcclusion: false,
             side: SideMode.DOUBLE,
-            maskMode: exports.MaskMode.NONE,
-            mask: 0,
-            alphaMask: false
+            mask: 0
         };
         _this.defaultGeometry = Geometry.create(_this.engine, {
             attributes: {
@@ -12783,7 +12792,8 @@ var singleSplits = [
         return geometry;
     };
     _proto.configureMaterial = function configureMaterial(renderer) {
-        var side = renderer.side, occlusion = renderer.occlusion, blendMode = renderer.blending, maskMode = renderer.maskMode, mask = renderer.mask, texture = renderer.texture;
+        var side = renderer.side, occlusion = renderer.occlusion, blendMode = renderer.blending, mask = renderer.mask, texture = renderer.texture;
+        var maskMode = this.maskManager.maskMode;
         var material = this.material;
         material.blending = true;
         material.depthTest = true;
@@ -12804,9 +12814,9 @@ var singleSplits = [
         texParams.x = renderer.occlusion ? +renderer.transparentOcclusion : 1;
         texParams.y = preMultiAlpha;
         texParams.z = renderer.renderMode;
-        texParams.w = renderer.maskMode;
+        texParams.w = maskMode;
         material.setVector4("_TexParams", texParams);
-        if (texParams.x === 0 || renderer.alphaMask) {
+        if (texParams.x === 0 || this.maskManager.alphaMaskEnabled) {
             material.enableMacro("ALPHA_CLIP");
         } else {
             material.disableMacro("ALPHA_CLIP");
@@ -12833,11 +12843,10 @@ var singleSplits = [
         var renderer = (_baseRenderComponentData_renderer = baseRenderComponentData.renderer) != null ? _baseRenderComponentData_renderer : {};
         var splits = baseRenderComponentData.splits;
         var textureSheetAnimation = baseRenderComponentData.textureSheetAnimation;
-        var maskProps = data.mask;
-        if (maskProps && maskProps.ref) {
-            maskProps.ref = this.engine.findObject(maskProps.ref);
+        var maskOptions = baseRenderComponentData.mask;
+        if (maskOptions) {
+            this.maskManager.getMaskMode(maskOptions);
         }
-        var maskMode = this.maskManager.getMaskMode(data);
         // TODO 新蒙板上线后移除
         //-------------------------------------------------------------------------
         var shapeData = renderer.shape;
@@ -12849,19 +12858,16 @@ var singleSplits = [
         //-------------------------------------------------------------------------
         this.splits = splits || singleSplits;
         this.textureSheetAnimation = textureSheetAnimation;
-        var _renderer_renderMode, _renderer_blending, _renderer_side, _renderer_alphaMask;
+        var _renderer_renderMode, _renderer_blending, _renderer_side;
         this.renderer = {
             renderMode: (_renderer_renderMode = renderer.renderMode) != null ? _renderer_renderMode : RenderMode.MESH,
             blending: (_renderer_blending = renderer.blending) != null ? _renderer_blending : BlendingMode.ALPHA,
             texture: renderer.texture ? this.engine.findObject(renderer.texture) : this.engine.emptyTexture,
             occlusion: !!renderer.occlusion,
-            transparentOcclusion: !!renderer.transparentOcclusion || maskMode === exports.MaskMode.MASK,
+            transparentOcclusion: !!renderer.transparentOcclusion || this.maskManager.maskMode === exports.MaskMode.MASK,
             side: (_renderer_side = renderer.side) != null ? _renderer_side : SideMode.DOUBLE,
             mask: this.maskManager.getRefValue(),
-            shape: shapeGeometry,
-            maskMode: maskMode,
-            //@ts-expect-error TODO 新蒙版兼容老数据需要增加纹理透明度蒙版是否开启参数
-            alphaMask: (_renderer_alphaMask = renderer.alphaMask) != null ? _renderer_alphaMask : false
+            shape: shapeGeometry
         };
         this.configureMaterial(this.renderer);
         if (baseRenderComponentData.geometry) {
@@ -13204,17 +13210,15 @@ exports.ShapeComponent = /*#__PURE__*/ function(BaseRenderComponent) {
                     break;
                 }
         }
-        var maskProps = data.mask;
-        if (maskProps && maskProps.ref) {
-            maskProps.ref = this.engine.findObject(maskProps.ref);
+        if (data.mask) {
+            this.maskManager.getMaskMode(data.mask);
         }
-        var maskMode = this.maskManager.getMaskMode(data);
         var maskRef = this.maskManager.getRefValue();
         this.material.stencilRef = maskRef !== undefined ? [
             maskRef,
             maskRef
         ] : undefined;
-        setMaskMode(this.material, maskMode);
+        setMaskMode(this.material, this.maskManager.maskMode);
     };
     _create_class(ShapeComponent, [
         {
@@ -19689,11 +19693,7 @@ exports.ParticleSystem = /*#__PURE__*/ function(Component) {
         var maskMode = exports.MaskMode.NONE;
         var maskRef = 0;
         if (data.mask) {
-            var maskProps = data.mask;
-            if (maskProps && maskProps.ref) {
-                maskProps.ref = this.engine.findObject(maskProps.ref);
-            }
-            maskMode = this.maskManager.getMaskMode(data);
+            maskMode = this.maskManager.getMaskMode(data.mask);
             maskRef = this.maskManager.getRefValue();
         }
         return {
@@ -27546,13 +27546,13 @@ function processMask(renderContent) {
     }
     if (maskMode === exports.MaskMode.MASK) {
         renderContent.mask = {
-            mask: true
+            isMask: true
         };
         currentMaskComponent = renderContent.id;
     } else if (maskMode === ObscuredMode.OBSCURED || maskMode === ObscuredMode.REVERSE_OBSCURED) {
         renderContent.mask = {
-            mode: maskMode,
-            ref: {
+            inverted: maskMode === ObscuredMode.REVERSE_OBSCURED ? true : false,
+            reference: {
                 "id": currentMaskComponent
             }
         };
@@ -28376,6 +28376,7 @@ function getStandardSpriteContent(sprite, transform) {
     return ret;
 }
 
+var version$1 = "2.5.0-alpha.1";
 var v0 = /^(\d+)\.(\d+)\.(\d+)(-(\w+)\.\d+)?$/;
 var standardVersion = /^(\d+)\.(\d+)$/;
 var reverseParticle = false;
@@ -28383,6 +28384,11 @@ function getStandardJSON(json) {
     if (!json || typeof json !== "object") {
         throw new Error("Invalid input: Expected a JSON object.");
     }
+    // 如果 JSON 中的 runtime 版本高于当前运行时版本，则发出警告
+    if (checkRuntimeVersion(json)) {
+        var _json_playerVersion;
+        console.warn("The JSON need higher than " + ((_json_playerVersion = json.playerVersion) == null ? void 0 : _json_playerVersion.web) + " runtime version(current: " + version$1 + "). Some features may not work as expected.");
+    }
     // 修正老版本数据中，meshItem 以及 lightItem 结束行为错误问题
     version22Migration(json);
     if (v0.test(json.version)) {
@@ -28698,6 +28704,21 @@ function getStandardItem(item, opt) {
         return {};
     }
 }
+/**
+ * 检查 json.playerVersion.web 的版本号是否低于当前 runtime 的版本
+ */ function checkRuntimeVersion(json) {
+    var _ref = json.playerVersion || {}, _ref_web = _ref.web, web = _ref_web === void 0 ? "" : _ref_web;
+    if (web) {
+        var _v0_exec;
+        var jsonVersionMatch = (_v0_exec = v0.exec(web)) != null ? _v0_exec : [];
+        var _v0_exec1;
+        var runtimeVersionMatch = (_v0_exec1 = v0.exec(version$1)) != null ? _v0_exec1 : [];
+        var major = jsonVersionMatch[1], minor = jsonVersionMatch[2];
+        var currentMajor = runtimeVersionMatch[1], currentMinor = runtimeVersionMatch[2];
+        return Number(currentMajor) < Number(major) || Number(currentMajor) === Number(major) && Number(currentMinor) < Number(minor);
+    }
+    return false;
+}
 
 var _obj;
 /**
@@ -31605,7 +31626,7 @@ registerPlugin("sprite", SpriteLoader, exports.VFXItem);
 registerPlugin("particle", ParticleLoader, exports.VFXItem);
 registerPlugin("cal", CalculateLoader, exports.VFXItem);
 registerPlugin("interact", InteractLoader, exports.VFXItem);
-var version = "2.5.0-alpha.0";
+var version = "2.5.0-alpha.1";
 logger.info("Core version: " + version + ".");
 
 exports.AbstractPlugin = AbstractPlugin;
@@ -31633,6 +31654,7 @@ exports.Composition = Composition;
 exports.DEFAULT_FONTS = DEFAULT_FONTS;
 exports.DEFAULT_FPS = DEFAULT_FPS;
 exports.Database = Database;
+exports.Deferred = Deferred;
 exports.Downloader = Downloader;
 exports.EFFECTS_COPY_MESH_NAME = EFFECTS_COPY_MESH_NAME;
 exports.EVENT_TYPE_CLICK = EVENT_TYPE_CLICK;