@galacean/effects-specification 2.2.0-beta.0 → 2.3.0-alpha.0

package/es/item/base-item.d.ts

@@ -1,7 +1,8 @@
 import type { BinaryEnv } from '../binary';
+import type { DataPath } from '../components';
 import type { Vector2Data, Vector3Data } from '../math';
 import type { vec3, vec4 } from '../number-expression';
-import type { ItemType, RenderLevel } from '../type';
+import type { ItemType, ObscuredMode, RenderLevel } from '../type';
 import type { CameraContent } from './camera-item';
 import type { CompositionContent } from './composition-item';
 import type { EffectContent } from './effect-item';
@@ -38,6 +39,25 @@ export declare enum EndBehavior {
 export declare enum ParentItemEndBehavior {
     destroyChildren = 6
 }
+/**
+ * 元素被遮挡/反向遮挡，需要时传入
+ */
+export interface ObscuredOptions {
+    mode: ObscuredMode;
+    /**
+     * 指向作为蒙版的组件
+     */
+    ref: DataPath;
+}
+/**
+ * 元素的蒙版行为
+ */
+export interface MaskOptions {
+    /**
+     * 是否作为蒙版
+     */
+    mask?: boolean;
+}
 export interface BaseItem {
     /**
      * 元素 id

package/es/item/effect-item.d.ts

@@ -1,6 +1,6 @@
 import type { ComponentData, DataPath } from '../components';
 import type { ItemType, PositionOverLifetime, RotationOverLifetime, SizeOverLifetime } from '../type';
-import type { BaseItem, EndBehavior } from './base-item';
+import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
 /**
  * 特效元素
  */
@@ -38,4 +38,8 @@ export interface EffectComponentData extends ComponentData {
     _priority: number;
     materials: DataPath[];
     geometry: DataPath;
+    /**
+     * 特效元素蒙版属性，传入表示需要被遮挡/反向遮挡
+     */
+    mask?: ObscuredOptions;
 }

package/es/item/particle-item.d.ts

@@ -1,6 +1,6 @@
-import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, SplitParameter } from '../type';
+import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, SplitParameter, ObscuredMode } from '../type';
 import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, FixedVec3Expression, ColorExpression, FunctionExpression } from '../number-expression';
-import type { BaseItem, EndBehavior } from './base-item';
+import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
 import type { ParticleShape } from './particle-shape';
 import type { ComponentData, DataPath } from '../components';
 /**
@@ -277,6 +277,10 @@ export interface ParticleContent {
      * 粒子元素材质渲染属性
      */
     renderer: RendererOptions;
+    /**
+     * 粒子元素蒙版属性，传入表示需要被遮挡/反向遮挡
+     */
+    mask?: ObscuredOptions;
     /**
      * 粒子元素发射器形状属性
      */
@@ -413,4 +417,8 @@ export interface ParticleTrail {
      * 拖尾+图层绑定同一个父节点时使用
      */
     parentAffectsPosition?: boolean;
+    /**
+     * 拖尾蒙版属性，传入表示需要被遮挡/反向遮挡
+     */
+    mask?: ObscuredMode;
 }

package/es/item/rich-text-item.d.ts

@@ -1,4 +1,4 @@
-import type { BaseItem, EndBehavior } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions } from './base-item';
 import type { ItemType } from '../type';
 import type { BaseTextContentOptions, TextComponentData, TextContent } from './text-item';
 import type { vec2 } from '../number-expression';
@@ -42,4 +42,8 @@ export interface RichTextComponentData extends Omit<TextComponentData, 'options'
      * 富文本元素基础属性
      */
     options: RichTextContentOptions;
+    /**
+     * 富文本元素蒙版属性，传入表示需要作为蒙版/被遮挡/反向遮挡
+     */
+    mask?: MaskOptions;
 }

package/es/item/spine-item.d.ts

@@ -1,8 +1,8 @@
 import type { BinaryPointer } from '../binary';
 import type { ComponentData, DataPath } from '../components';
 import type { DataType } from '../data-type';
-import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType, MaskMode, RenderMode } from '../type';
-import type { BaseItem, EndBehavior } from './base-item';
+import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType, RenderMode } from '../type';
+import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
 /**
  * 插件元素
  */
@@ -121,6 +121,9 @@ export interface SpineComponent extends ComponentData {
     };
     renderer?: {
         renderMode: RenderMode;
-        maskMode: MaskMode;
     };
+    /**
+     * Spine 元素蒙版属性，传入表示需要被遮挡/反向遮挡
+     */
+    mask?: ObscuredOptions;
 }

package/es/item/sprite-item.d.ts

@@ -1,4 +1,4 @@
-import type { BaseItem, EndBehavior } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions, ObscuredOptions } from './base-item';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, SplitParameter, InteractBehavior } from '../type';
 import type { RGBAColorValue } from '../number-expression';
 import type { ComponentData } from '../components';
@@ -40,6 +40,10 @@ export interface SpriteContent {
      * 图层元素材质渲染属性
      */
     renderer: RendererOptions;
+    /**
+     * 图层元素蒙版属性，传入表示需要作为蒙版/被遮挡/反向遮挡
+     */
+    mask?: MaskOptions | ObscuredOptions;
     /**
      * 图层元素大小变化属性
      */

package/es/item/text-item.d.ts

@@ -1,4 +1,4 @@
-import type { BaseItem, EndBehavior } from './base-item';
+import type { BaseItem, EndBehavior, MaskOptions, ObscuredOptions } from './base-item';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, InteractBehavior } from '../type';
 import type { RGBAColorValue } from '../number-expression';
 import type { FontStyle, TextAlignment, TextBaseline, TextOverflow, TextWeight } from '../text';
@@ -143,6 +143,10 @@ export interface TextContent {
      * 文本元素材质渲染属性
      */
     renderer: RendererOptions;
+    /**
+     * 文本元素蒙版属性，传入表示需要作为蒙版/被遮挡/反向遮挡
+     */
+    mask?: MaskOptions | ObscuredOptions;
     /**
      * 文本元素大小变化属性
      */

package/es/item/video-item.d.ts

@@ -1,7 +1,7 @@
 import type { ComponentData, DataPath } from '../components';
 import type { RGBAColorValue } from '../number-expression';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, InteractBehavior, RendererOptions, ItemType } from '../type';
-import type { BaseItem, EndBehavior } from './base-item';
+import type { BaseItem, EndBehavior, ObscuredOptions } from './base-item';
 /**
  * 视频元素
  */
@@ -59,6 +59,10 @@ export interface VideoComponentData extends ComponentData {
      * 视频元素材质渲染属性
      */
     renderer: RendererOptions;
+    /**
+     * 视频元素蒙版属性，传入表示需要被遮挡/反向遮挡
+     */
+    mask?: ObscuredOptions;
     /**
      * 视频元素大小变化属性
      */

package/es/shape/shape-component-data.d.ts

@@ -1,4 +1,5 @@
 import type { ComponentData } from '../components/component-data';
+import type { MaskOptions, ObscuredOptions } from '../item/base-item';
 import type { ShapeFillParam } from './shape-fill-param';
 import type { ShapePrimitiveType } from './shape-primitive-type';
 import type { ShapeStrokeParam } from './shape-stroke-param';
@@ -18,4 +19,8 @@ export interface ShapeComponentData extends ComponentData {
      * 填充属性
      */
     fill?: ShapeFillParam;
+    /**
+     *  蒙版属性，传入表示需要作为蒙版/被遮挡/反向遮挡
+     */
+    mask?: MaskOptions | ObscuredOptions;
 }

package/es/type.d.ts

@@ -1,4 +1,5 @@
 import type { DataPath } from './components';
+import type { ObscuredOptions, MaskOptions } from './item/base-item';
 import type { FixedVec3Expression, vec2, vec3, GradientColor, ShapePoints, ShapeSplits, FixedNumberExpression } from './number-expression';
 /**
  * 播放器版本
@@ -294,17 +295,12 @@ export declare enum SideMode {
     BACK = 1029
 }
 /**
- * 蒙版模式
+ *  元素是否被蒙版遮挡/反向遮挡
  */
-export declare enum MaskMode {
+export declare enum ObscuredMode {
     /**
-     * 无蒙版
-     */
-    NONE = 0,
-    /**
-     * 蒙版
+     * 无
      */
-    MASK = 1,
     /**
      * 被遮挡
      */
@@ -446,11 +442,6 @@ export interface RendererOptions {
      * 贴图，索引到 scene 中的 images 数组
      */
     texture?: DataPath;
-    /**
-     * 蒙版模式
-     * @default none
-     */
-    maskMode?: MaskMode;
     /**
      * 蒙版形状，索引到 scene 的 shapes 中
      */
@@ -463,6 +454,10 @@ export interface RendererOptions {
      * 锚点
      */
     anchor?: vec2;
+    /**
+     * 蒙版属性
+     */
+    mask?: MaskOptions | ObscuredOptions;
 }
 /**
  * 元素类型

package/es/type.js

@@ -69,27 +69,27 @@ export var SideMode;
     SideMode[SideMode["BACK"] = 1029] = "BACK";
 })(SideMode || (SideMode = {}));
 /**
- * 蒙版模式
+ *  元素是否被蒙版遮挡/反向遮挡
  */
-export var MaskMode;
-(function (MaskMode) {
+export var ObscuredMode;
+(function (ObscuredMode) {
     /**
-     * 无蒙版
-     */
-    MaskMode[MaskMode["NONE"] = 0] = "NONE";
-    /**
-     * 蒙版
+     * 无
      */
-    MaskMode[MaskMode["MASK"] = 1] = "MASK";
+    // NONE = 0,
+    // /**
+    //  * 蒙版
+    //  */
+    // MASK = 1,
     /**
      * 被遮挡
      */
-    MaskMode[MaskMode["OBSCURED"] = 2] = "OBSCURED";
+    ObscuredMode[ObscuredMode["OBSCURED"] = 2] = "OBSCURED";
     /**
      * 被反向遮挡
      */
-    MaskMode[MaskMode["REVERSE_OBSCURED"] = 3] = "REVERSE_OBSCURED";
-})(MaskMode || (MaskMode = {}));
+    ObscuredMode[ObscuredMode["REVERSE_OBSCURED"] = 3] = "REVERSE_OBSCURED";
+})(ObscuredMode || (ObscuredMode = {}));
 /**
  * 发射器形状
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.2.0-beta.0",
+  "version": "2.3.0-alpha.0",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",