@galacean/effects-specification 2.2.0-alpha.3 → 2.2.0-alpha.5

package/es/assets.d.ts

@@ -68,12 +68,6 @@ export interface Image extends AssetBase {
      * @default false
      */
     mipmap?: boolean;
-    /**
-     * 图片 Y 轴的方向，如果 Y 轴向上（与 OpenGL 相同）则为 1
-     * 如果 Y 轴向下（与 OpenGL 相反）则为 -1，图片再绘制数据模板的时候需要翻转绘制
-     * @default 1
-     */
-    oriY?: 1 | -1;
 }
 /**
  * 模板贴图属性

package/es/index.d.ts

@@ -40,4 +40,4 @@ export * from './material-data';
 export * from './geometry-data';
 export * from './shader-data';
 export * from './effects-package-data';
-export declare const LATEST_VERSION = JSONSceneVersion['3_1'];
+export declare const LATEST_VERSION = JSONSceneVersion['3_2'];

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 { 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;
     /**
      * 粒子元素发射器形状属性
      */

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

@@ -1,12 +1,13 @@
-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';
 /**
  * 富文本元素
  */
 export interface RichTextItem extends BaseItem {
     /**
-     * 元素类型（指定为 text）
+     * 元素类型（指定为 richtext）
      */
     type: ItemType.richtext;
     /**
@@ -16,13 +17,22 @@ export interface RichTextItem extends BaseItem {
     endBehavior: EndBehavior;
 }
 /**
- * 文本元素渲染属性
+ * 富文本元素参数
+ */
+export interface RichTextContentOptions extends BaseTextContentOptions {
+    /**
+     * 富文本元素大小
+     */
+    size?: vec2;
+}
+/**
+ * 富文本元素渲染属性
  */
 export interface RichTextContent extends Omit<TextContent, 'options'> {
     /**
-     * 文本元素基础属性
+     * 富文本元素基础属性
      */
-    options: BaseTextContentOptions;
+    options: RichTextContentOptions;
 }
 /**
  * 富文本元素渲染属性
@@ -31,5 +41,9 @@ export interface RichTextComponentData extends Omit<TextComponentData, 'options'
     /**
      * 富文本元素基础属性
      */
-    options: BaseTextContentOptions;
+    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';
@@ -18,11 +18,6 @@ export interface TextItem extends BaseItem {
     endBehavior: EndBehavior;
 }
 export interface TextContentOptions extends BaseTextContentOptions {
-    /**
-     * 文本间隔
-     * @default 0
-     */
-    letterSpace?: number;
     /**
      * 文本固定宽度（和自适应宽高冲突）
      * @default 31
@@ -43,14 +38,13 @@ export interface TextContentOptions extends BaseTextContentOptions {
      * @default false
      */
     autoWidth?: boolean;
-    /**
-     * 当文字超过最大宽度时，文字的表现行为
-     * 仅当设置文字最大宽度后生效
-     * @default TextOverflow.display
-     */
-    textOverflow?: TextOverflow;
 }
 export interface BaseTextContentOptions {
+    /**
+     * 文本间隔
+     * @default 0
+     */
+    letterSpace?: number;
     /**
      * 文本内容
      */
@@ -93,7 +87,7 @@ export interface BaseTextContentOptions {
     /**
      * 当文字超过最大宽度时，文字的表现行为
      * 仅当设置文字最大宽度后生效
-     * @default TextOverflow.display
+     * @default TextOverflow.clip
      */
     textOverflow?: TextOverflow;
     /**
@@ -149,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/scene.d.ts

@@ -30,7 +30,8 @@ export declare enum JSONSceneVersion {
     '2_4' = "2.4",// 支持贝塞尔曲线
     '3_0' = "3.0",// EC 改造、移除滤镜元素
     '3_1' = "3.1",// 音视频
-    'LATEST' = "3.1"
+    '3_2' = "3.2",// 矢量动画、透明视频、增加富文本属性
+    'LATEST' = "3.2"
 }
 /**
  * runtime 2.0 之前的场景信息

package/es/scene.js

@@ -16,5 +16,6 @@ export var JSONSceneVersion;
     JSONSceneVersion["2_4"] = "2.4";
     JSONSceneVersion["3_0"] = "3.0";
     JSONSceneVersion["3_1"] = "3.1";
-    JSONSceneVersion["LATEST"] = "3.1";
+    JSONSceneVersion["3_2"] = "3.2";
+    JSONSceneVersion["LATEST"] = "3.2";
 })(JSONSceneVersion || (JSONSceneVersion = {}));

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

@@ -1,7 +1,6 @@
 import type { TransformData } from '../item/base-item';
 import type { Vector2Data } from '../math';
 import type { ShapeComponentData } from './shape-component-data';
-import type { ShapeFillParam } from './shape-fill-param';
 import type { ShapePrimitiveType } from './shape-primitive-type';
 /**
  * 自定义形状点
@@ -32,10 +31,6 @@ export interface CustomShape {
      * 是否为闭合图形 - 用于Stroke
      */
     close: boolean;
-    /**
-     * 填充属性
-     */
-    fill?: ShapeFillParam;
     /**
      * 空间变换
      */

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

@@ -1,6 +1,5 @@
 import type { TransformData } from '../item/base-item';
 import type { ShapeComponentData } from './shape-component-data';
-import type { ShapeFillParam } from './shape-fill-param';
 import type { ShapePrimitiveType } from './shape-primitive-type';
 /**
  * 椭圆组件参数
@@ -17,10 +16,6 @@ export interface EllipseData extends ShapeComponentData {
      * y 轴半径
      */
     yRadius: number;
-    /**
-     * 填充属性
-     */
-    fill?: ShapeFillParam;
     /**
      * 空间变换
      */

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

@@ -1,6 +1,5 @@
 import type { TransformData } from '../item/base-item';
 import type { ShapeComponentData } from './shape-component-data';
-import type { ShapeFillParam } from './shape-fill-param';
 /**
  * 多边形参数
  */
@@ -17,10 +16,6 @@ export interface PolygonData extends ShapeComponentData {
      * 角点圆度
      */
     roundness: number;
-    /**
-     * 填充属性
-     */
-    fill?: ShapeFillParam;
     /**
      * 空间变换
      */

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

@@ -1,6 +1,5 @@
 import type { TransformData } from '../item/base-item';
 import type { ShapeComponentData } from './shape-component-data';
-import type { ShapeFillParam } from './shape-fill-param';
 /**
  * 矩形参数
  */
@@ -17,10 +16,6 @@ export interface RectangleData extends ShapeComponentData {
      * 角点元素
      */
     roundness: number;
-    /**
-     * 填充属性
-     */
-    fill?: ShapeFillParam;
     /**
      * 空间变换
      */

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

@@ -1,4 +1,5 @@
 import type { ComponentData } from '../components/component-data';
+import type { ShapeFillParam } from './shape-fill-param';
 import type { ShapePrimitiveType } from './shape-primitive-type';
 import type { ShapeStrokeParam } from './shape-stroke-param';
 /**
@@ -13,4 +14,8 @@ export interface ShapeComponentData extends ComponentData {
      * 描边属性
      */
     stroke?: ShapeStrokeParam;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
 }

package/es/shape/shape-stroke-param.d.ts

@@ -1,7 +1,19 @@
 import type { ColorData } from '../math/color-data';
-export declare enum ShapeConnectType {
+export declare enum LineCap {
+    /** 默认值。向线条的每个末端添加平直的边缘 */
+    Butt = 0,
+    /** 向线条的每个末端添加圆形线帽 */
+    Round = 1,
+    /** 向线条的每个末端添加正方形线帽 */
+    Square = 2
 }
-export declare enum ShapePointType {
+export declare enum LineJoin {
+    /** 创建圆角 */
+    Round = 0,
+    /** 创建斜角 */
+    Bevel = 1,
+    /** 创建尖角 */
+    Miter = 2
 }
 /**
  * 矢量描边参数
@@ -16,11 +28,11 @@ export interface ShapeStrokeParam {
      */
     color: ColorData;
     /**
-     * 连接类型
+     * 线段端点的样式
      */
-    connectType: ShapeConnectType;
+    cap: LineCap;
     /**
-     * 点类型
+     * 线段连接处的样式
      */
-    pointType: ShapePointType;
+    join: LineJoin;
 }

package/es/shape/shape-stroke-param.js

@@ -1,8 +1,18 @@
-// 本期无该功能 待补充
-export var ShapeConnectType;
-(function (ShapeConnectType) {
-})(ShapeConnectType || (ShapeConnectType = {}));
-// @待补充
-export var ShapePointType;
-(function (ShapePointType) {
-})(ShapePointType || (ShapePointType = {}));
+export var LineCap;
+(function (LineCap) {
+    /** 默认值。向线条的每个末端添加平直的边缘 */
+    LineCap[LineCap["Butt"] = 0] = "Butt";
+    /** 向线条的每个末端添加圆形线帽 */
+    LineCap[LineCap["Round"] = 1] = "Round";
+    /** 向线条的每个末端添加正方形线帽 */
+    LineCap[LineCap["Square"] = 2] = "Square";
+})(LineCap || (LineCap = {}));
+export var LineJoin;
+(function (LineJoin) {
+    /** 创建圆角 */
+    LineJoin[LineJoin["Round"] = 0] = "Round";
+    /** 创建斜角 */
+    LineJoin[LineJoin["Bevel"] = 1] = "Bevel";
+    /** 创建尖角 */
+    LineJoin[LineJoin["Miter"] = 2] = "Miter";
+})(LineJoin || (LineJoin = {}));

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

@@ -1,6 +1,5 @@
 import type { TransformData } from '../item/base-item';
 import type { ShapeComponentData } from './shape-component-data';
-import type { ShapeFillParam } from './shape-fill-param';
 /**
  * 星形参数
  */
@@ -25,10 +24,6 @@ export interface StarData extends ShapeComponentData {
      * 外径点圆度
      */
     outerRoundness: number;
-    /**
-     * 填充属性
-     */
-    fill?: ShapeFillParam;
     /**
      * 空间变换
      */

package/es/text.d.ts

@@ -52,7 +52,7 @@ export interface FontBase {
 }
 export declare enum TextOverflow {
     /**
-     * display 模式下，会显示所有文本，存在文本超过边界框的情况。
+     * display 模式下，会显示所有文本，文本大小会根据边界框调整。
      */
     display = 0,
     /**

package/es/text.js

@@ -1,7 +1,7 @@
 export var TextOverflow;
 (function (TextOverflow) {
     /**
-     * display 模式下，会显示所有文本，存在文本超过边界框的情况。
+     * display 模式下，会显示所有文本，文本大小会根据边界框调整。
      */
     TextOverflow[TextOverflow["display"] = 0] = "display";
     /**

package/es/type.d.ts

@@ -294,17 +294,12 @@ export declare enum SideMode {
     BACK = 1029
 }
 /**
- * 蒙版模式
+ *  元素是否被蒙版遮挡/反向遮挡
  */
-export declare enum MaskMode {
+export declare enum ObscuredMode {
     /**
-     * 无蒙版
-     */
-    NONE = 0,
-    /**
-     * 蒙版
+     * 无
      */
-    MASK = 1,
     /**
      * 被遮挡
      */
@@ -446,11 +441,6 @@ export interface RendererOptions {
      * 贴图，索引到 scene 中的 images 数组
      */
     texture?: DataPath;
-    /**
-     * 蒙版模式
-     * @default none
-     */
-    maskMode?: MaskMode;
     /**
      * 蒙版形状，索引到 scene 的 shapes 中
      */

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-alpha.3",
+  "version": "2.2.0-alpha.5",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",