@galacean/effects-specification 2.0.0-alpha.2 → 2.0.0-alpha.20

package/{dist/src → es}/item/particle-item.d.ts

@@ -2,7 +2,6 @@ import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, Sp
 import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, FixedVec3Expression, ColorExpression, FunctionExpression } from '../number-expression';
 import type { BaseItem, ItemEndBehavior } from './base-item';
 import type { ParticleShape } from './particle-shape';
-import type { DistortionFilterParams } from './filter-item';
 import type { ComponentData } from '../components';
 /**
  * 粒子交互行为
@@ -22,7 +21,7 @@ export declare enum ParticleInteractionBehavior {
  */
 export interface ParticleItem extends BaseItem {
     /**
-     * 元素类型[指定为particle]
+     * 元素类型（指定为 particle）
      */
     type: ItemType.particle;
     /**
@@ -58,7 +57,7 @@ export interface ParticleEmission {
          */
         cycles?: number;
         /**
-         * 爆发时间间隔，单位秒
+         * 爆发时间间隔（单位：秒）
          * @default 0
          */
         interval?: number;
@@ -72,15 +71,15 @@ export interface ParticleEmission {
          */
         index: number;
         /**
-         * x方向偏移值
+         * x 方向偏移值
          */
         x: number;
         /**
-         * y方向偏移值
+         * y 方向偏移值
          */
         y: number;
         /**
-         * z方向偏移值
+         * z 方向偏移值
          */
         z: number;
     }[];
@@ -91,15 +90,15 @@ export interface ParticlePositionOverLifetime {
      */
     asMovement?: boolean;
     /**
-     * x轴位置变化信息
+     * x 轴位置变化信息
      */
     linearX?: NumberExpression;
     /**
-     * y轴位置变化信息
+     * y 轴位置变化信息
      */
     linearY?: NumberExpression;
     /**
-     * z轴位置变化信息
+     * z 轴位置变化信息
      */
     linearZ?: NumberExpression;
     /**
@@ -107,15 +106,15 @@ export interface ParticlePositionOverLifetime {
      */
     asRotation?: boolean;
     /**
-     * x轴环绕角度变化信息
+     * x 轴环绕角度变化信息
      */
     orbitalX?: NumberExpression;
     /**
-     * y轴环绕角度变化信息
+     * y 轴环绕角度变化信息
      */
     orbitalY?: NumberExpression;
     /**
-     * z轴环绕角度变化信息
+     * z 轴环绕角度变化信息
      */
     orbitalZ?: NumberExpression;
     /**
@@ -138,7 +137,7 @@ export interface ParticlePositionOverLifetime {
      */
     forceCurve?: FunctionExpression;
     /**
-     * 增加一个初速度，匀速直线运动，direction为运动方向
+     * 增加一个初速度，匀速直线运动，direction 为运动方向
      * @default 0
      */
     startSpeed?: NumberExpression;
@@ -147,7 +146,7 @@ export interface ParticlePositionOverLifetime {
      */
     speedOverLifetime?: FixedNumberExpression;
     /**
-     * 增加一个重力，gravity为重力方向，gravityModifier为重力大小
+     * 增加一个重力，gravity 为重力方向，gravityModifier 为重力大小
      * @default 0
      */
     gravity?: vec3;
@@ -166,15 +165,15 @@ export interface ParticleRotationOverLifetime {
      */
     asRotation?: boolean;
     /**
-     * x轴旋转函数
+     * x 轴旋转函数
      */
     x?: NumberExpression;
     /**
-     * y轴旋转函数
+     * y 轴旋转函数
      */
     y?: NumberExpression;
     /**
-     * z轴旋转函数（不分轴时，变化z）
+     * z 轴旋转函数（不分轴时，变化 z）
      */
     z?: NumberExpression;
 }
@@ -188,11 +187,11 @@ export interface ParticleSizeOverLifetime {
      */
     size?: NumberExpression;
     /**
-     * x轴大小变化信息（分轴模式）
+     * x 轴大小变化信息（分轴模式）
      */
     x?: NumberExpression;
     /**
-     * y轴大小变化信息（分轴模式）
+     * y 轴大小变化信息（分轴模式）
      */
     y?: NumberExpression;
 }
@@ -334,7 +333,6 @@ export interface ParticleContent {
          */
         radius?: number;
     };
-    filter?: DistortionFilterParams;
 }
 /**
  * 粒子元素渲染属性
@@ -405,7 +403,6 @@ export interface ParticleSystemData extends ComponentData {
          */
         radius?: number;
     };
-    filter?: DistortionFilterParams;
 }
 /**
  * 粒子拖尾参数

package/es/item/particle-item.js

@@ -0,0 +1,14 @@
+/**
+ * 粒子交互行为
+ */
+export var ParticleInteractionBehavior;
+(function (ParticleInteractionBehavior) {
+    /**
+     * 无
+     */
+    ParticleInteractionBehavior[ParticleInteractionBehavior["none"] = 0] = "none";
+    /**
+     * 移出粒子
+     */
+    ParticleInteractionBehavior[ParticleInteractionBehavior["removeParticle"] = 1] = "removeParticle";
+})(ParticleInteractionBehavior || (ParticleInteractionBehavior = {}));

package/es/item/particle-shape.js

@@ -0,0 +1,19 @@
+export var ShapeArcMode;
+(function (ShapeArcMode) {
+    /**
+     * 随机
+     */
+    ShapeArcMode[ShapeArcMode["RANDOM"] = 0] = "RANDOM";
+    /**
+     * 单向循环
+     */
+    ShapeArcMode[ShapeArcMode["UNIDIRECTIONAL_CYCLE"] = 1] = "UNIDIRECTIONAL_CYCLE";
+    /**
+     * 双向循环
+     */
+    ShapeArcMode[ShapeArcMode["BIDIRECTIONAL_CYCLE"] = 2] = "BIDIRECTIONAL_CYCLE";
+    /**
+     * 均匀爆发
+     */
+    ShapeArcMode[ShapeArcMode["UNIFORM_BURST"] = 3] = "UNIFORM_BURST";
+})(ShapeArcMode || (ShapeArcMode = {}));

package/{dist/src → es}/item/plugin-item.d.ts

@@ -5,7 +5,7 @@ import type { BaseItem, ItemEndBehavior } from './base-item';
  */
 export interface PluginItem extends BaseItem {
     /**
-     * 元素类型[指定为plugin]
+     * 元素类型（指定为 plugin）
      */
     type: ItemType.plugin;
     /**

package/es/item/plugin-item.js

@@ -0,0 +1 @@
+export {};

package/{dist/src → es}/item/spine-item.d.ts

@@ -1,4 +1,5 @@
 import type { BinaryPointer } from '../binary';
+import type { ComponentData, DataPath, DataType } from '../components';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType } from '../type';
 import type { BaseItem, ItemEndBehavior } from './base-item';
 /**
@@ -6,12 +7,12 @@ import type { BaseItem, ItemEndBehavior } from './base-item';
  */
 export interface SpineItem extends BaseItem {
     /**
-       * 元素类型 "spine"
-       */
+     * 元素类型 "spine"
+     */
     type: ItemType.spine;
     /**
-       * 插件元素渲染信息
-       */
+     * 插件元素渲染信息
+     */
     content: SpineContent;
     endBehavior: ItemEndBehavior;
 }
@@ -49,16 +50,16 @@ export interface SpineContent {
  */
 export interface PluginSpineOption {
     /**
-       * 当前使用的皮肤名称
-       */
+     * 当前使用的皮肤名称
+     */
     activeSkin: string;
     /**
-       * 当前使用的动画列表，1.5之前为 string
-       */
+     * 当前使用的动画列表，1.5 之前为 string
+     */
     activeAnimation: string[] | string;
     /**
-       * 在 spines 资源数组中的索引
-       */
+     * 在 spines 资源数组中的索引
+     */
     spine: number;
     /**
      * 默认融合时间
@@ -68,6 +69,13 @@ export interface PluginSpineOption {
      * 动画播放的速度
      */
     speed?: number;
+    /**
+     * 使用的默认大小计算规则
+     * 0 ：除以包围盒大小
+     * 1 : 相机逆投影 + 固定画布大小
+     * @since 1.3.0
+     */
+    resizeRule: number;
 }
 /**
  * spine资源信息
@@ -75,19 +83,35 @@ export interface PluginSpineOption {
 export type skeletonFileType = 'json' | 'skel';
 export interface SpineResource {
     /**
-       * atlas 文件在 `bins` 中的指针
-       */
+     * atlas 文件在 `bins` 中的指针
+     */
     atlas: BinaryPointer;
     /**
-       * 骨骼文件
-       */
+     * 骨骼文件
+     */
     skeleton: BinaryPointer;
     /**
-       * skeleton 文件类型, `.skel/.json`
-       */
+     * skeleton 文件类型, `.skel/.json`
+     */
     skeletonType: skeletonFileType;
     /**
-       * 图像文件在 `scene.textures` 数组中的索引
-       */
+     * 图像文件在 `scene.textures` 数组中的索引
+     */
     images: number[];
 }
+export interface SpineComponent extends ComponentData {
+    dataType: DataType.SpineComponent;
+    options: PluginSpineOption;
+    resource: {
+        atlas: {
+            bins: DataPath;
+            source: [start: number, length?: number];
+        };
+        skeleton: {
+            bins: DataPath;
+            source: [start: number, length?: number];
+        };
+        images: DataPath[];
+        skeletonType: skeletonFileType;
+    };
+}

package/es/item/spine-item.js

@@ -0,0 +1 @@
+export {};

package/{dist/src → es}/item/sprite-item.d.ts

@@ -7,7 +7,7 @@ import type { ComponentData } from '../components';
  */
 export interface SpriteItem extends BaseItem {
     /**
-     * 元素类型[指定为sprite]
+     * 元素类型（指定为 sprite）
      */
     type: ItemType.sprite;
     /**

package/es/item/sprite-item.js

@@ -0,0 +1 @@
+export {};

package/{dist/src → es}/item/text-item.d.ts

@@ -8,7 +8,7 @@ import type { ComponentData } from '../components';
  */
 export interface TextItem extends BaseItem {
     /**
-     * 元素类型[指定为text]
+     * 元素类型（指定为 text）
      */
     type: ItemType.text;
     /**

package/es/item/text-item.js

@@ -0,0 +1 @@
+export {};

package/{dist/src → es}/item.d.ts

@@ -5,13 +5,10 @@ import type { PluginItem } from './item/plugin-item';
 import type { ParticleItem } from './item/particle-item';
 import type { InteractItem } from './item/interact-item';
 import type { ModelCameraItem, ModelLightItem, ModelMeshItem, ModelSkyboxItem, ModelTreeItem } from './item/model';
-import type { FilterItem } from './item/filter-item';
 import type { CameraItem } from './item/camera-item';
 import type { CompositionItem } from './item/composition-item';
 import type { TextItem } from './item/text-item';
 /**
- * Item Interface，
- * 1.0版本
- * 基类，无对应元素
+ * Item 基类，无对应元素
  */
-export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | FilterItem | CameraItem | TextItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;
+export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | CameraItem | TextItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;

package/es/item.js

@@ -0,0 +1 @@
+export {};

package/{dist/src → es}/number-expression.d.ts

@@ -50,7 +50,7 @@ export declare enum ValueType {
      */
     SHAPE_SPLITS = 11,
     /**
-     *直线路径
+     * 直线路径
      */
     LINEAR_PATH = 12,
     /**
@@ -68,7 +68,11 @@ export declare enum ValueType {
     /**
      * 贝塞尔曲线路径
      */
-    BEZIER_CURVE_PATH = 22
+    BEZIER_CURVE_PATH = 22,
+    /**
+     * 贝塞尔曲线四元数
+     */
+    BEZIER_CURVE_QUAT = 23
 }
 export type vec2 = [x: number, y: number];
 export type vec3 = [x: number, y: number, z: number];
@@ -109,6 +113,7 @@ export type FunctionExpression = LineValue | CurveValue | BezierValue;
 export type FixedNumberExpression = ConstantNumber | LineValue | CurveValue | BezierValue;
 export type NumberExpression = FixedNumberExpression | RandomValue;
 export type FixedVec3Expression = ConstantVec3 | BezierPath | LinearPath | BezierCurvePath;
+export type FixedQuatExpression = BezierCurveQuat;
 /**
  * 常数数值
  * [0,5]
@@ -150,12 +155,12 @@ export type LinearPathValue = [
  * 关键帧类型
  */
 export declare enum BezierKeyframeType {
-    AUTO = 0,
-    EASE = 1,
-    EASE_IN = 2,
-    EASE_OUT = 3,
-    LINE = 4,
-    HOLD = 5,
+    AUTO = 0,// 自动
+    EASE = 1,// 缓动
+    EASE_IN = 2,// 缓入
+    EASE_OUT = 3,// 缓出
+    LINE = 4,// 线性 （默认进）
+    HOLD = 5,// 定格
     LINE_OUT = 6
 }
 /**
@@ -246,10 +251,18 @@ export type BezierValue = [type: ValueType.BEZIER_CURVE, value: BezierKeyframeVa
  * 贝塞尔曲线路径关键帧值
  */
 export type BezierCurvePathValue = [easing: BezierKeyframeValue[], points: vec3[], controlePoints: vec3[]];
+/**
+ * 贝塞尔曲线路径关键帧值
+ */
+export type BezierCurveQuatValue = [easing: BezierKeyframeValue[], points: vec4[], controlePoints: vec4[]];
 /**
  * 贝塞尔曲线路径关键帧
  */
 export type BezierCurvePath = [type: ValueType.BEZIER_CURVE_PATH, value: BezierCurvePathValue];
+/**
+ * 贝塞尔曲线路径关键帧
+ */
+export type BezierCurveQuat = [type: ValueType.BEZIER_CURVE_QUAT, value: BezierCurveQuatValue];
 /*********************************************/
 /*********************************************/
 export type ColorExpression = RGBAColor | GradientColor | RGBAColors;

package/es/number-expression.js

@@ -0,0 +1,91 @@
+/*********************************************/
+/*               基本数值属性参数              */
+/*********************************************/
+export var ValueType;
+(function (ValueType) {
+    /**
+     * 常数
+     */
+    ValueType[ValueType["CONSTANT"] = 0] = "CONSTANT";
+    /**
+     * 二维常数向量
+     */
+    ValueType[ValueType["CONSTANT_VEC2"] = 1] = "CONSTANT_VEC2";
+    /**
+     * 三维常数向量
+     */
+    ValueType[ValueType["CONSTANT_VEC3"] = 2] = "CONSTANT_VEC3";
+    /**
+     * 四维常数向量
+     */
+    ValueType[ValueType["CONSTANT_VEC4"] = 3] = "CONSTANT_VEC4";
+    /**
+     * 随机数
+     */
+    ValueType[ValueType["RANDOM"] = 4] = "RANDOM";
+    /**
+     * 直线
+     */
+    ValueType[ValueType["LINE"] = 5] = "LINE";
+    /**
+     * 曲线
+     */
+    ValueType[ValueType["CURVE"] = 6] = "CURVE";
+    /**
+     * 贝塞尔路径
+     */
+    ValueType[ValueType["BEZIER_PATH"] = 7] = "BEZIER_PATH";
+    /**
+     * 颜色
+     */
+    ValueType[ValueType["RGBA_COLOR"] = 8] = "RGBA_COLOR";
+    /**
+     * 渐变色
+     */
+    ValueType[ValueType["GRADIENT_COLOR"] = 9] = "GRADIENT_COLOR";
+    /**
+     * 蒙版形状点集
+     */
+    ValueType[ValueType["SHAPE_POINTS"] = 10] = "SHAPE_POINTS";
+    /**
+     * 蒙版形状切分
+     */
+    ValueType[ValueType["SHAPE_SPLITS"] = 11] = "SHAPE_SPLITS";
+    /**
+     * 直线路径
+     */
+    ValueType[ValueType["LINEAR_PATH"] = 12] = "LINEAR_PATH";
+    /**
+     * 多色
+     */
+    ValueType[ValueType["COLORS"] = 13] = "COLORS";
+    /**
+     * 二进制指针
+     */
+    ValueType[ValueType["BINARY"] = 20] = "BINARY";
+    /**
+     * 贝塞尔曲线
+     */
+    ValueType[ValueType["BEZIER_CURVE"] = 21] = "BEZIER_CURVE";
+    /**
+     * 贝塞尔曲线路径
+     */
+    ValueType[ValueType["BEZIER_CURVE_PATH"] = 22] = "BEZIER_CURVE_PATH";
+    /**
+     * 贝塞尔曲线四元数
+     */
+    ValueType[ValueType["BEZIER_CURVE_QUAT"] = 23] = "BEZIER_CURVE_QUAT";
+})(ValueType || (ValueType = {}));
+/**
+ * 关键帧类型
+ */
+export var BezierKeyframeType;
+(function (BezierKeyframeType) {
+    BezierKeyframeType[BezierKeyframeType["AUTO"] = 0] = "AUTO";
+    BezierKeyframeType[BezierKeyframeType["EASE"] = 1] = "EASE";
+    BezierKeyframeType[BezierKeyframeType["EASE_IN"] = 2] = "EASE_IN";
+    BezierKeyframeType[BezierKeyframeType["EASE_OUT"] = 3] = "EASE_OUT";
+    BezierKeyframeType[BezierKeyframeType["LINE"] = 4] = "LINE";
+    BezierKeyframeType[BezierKeyframeType["HOLD"] = 5] = "HOLD";
+    BezierKeyframeType[BezierKeyframeType["LINE_OUT"] = 6] = "LINE_OUT";
+})(BezierKeyframeType || (BezierKeyframeType = {}));

package/{dist/src → es}/scene.d.ts

@@ -1,11 +1,12 @@
-import type { Composition } from './composition';
+import type { Composition, CompositionData } from './composition';
 import type { SpineResource } from './item/spine-item';
 import type { PlayerVersion, Shape } from './type';
 import type { TemplateImage, Image, CompressedImage, TextureDefine } from './image';
 import type { FontBase, FontDefine } from './text';
 import type { BinaryFile } from './binary';
-import type { ComponentData, GeometryData, MaterialData, ShaderData } from './components';
+import type { ComponentData, EffectsObjectData, GeometryData, MaterialData, ShaderData } from './components';
 import type { VFXItemData } from './vfx-item-data';
+import type { AnimationClipData } from './animation-clip-data';
 /**
  * runtime 2.0 之前的场景信息
  * 素材信息存放于统一数据结构中
@@ -23,8 +24,10 @@ export interface JSONSceneLegacy {
      * 2.0 改造升级
      * 2.1 增加文本元素
      * 2.2 数据类型兼容
+     * 2.3 新增动态视频、陀螺仪支持旋转
+     * 2.4 支持贝塞尔曲线
      */
-    version: '1.0' | '1.1' | '1.2' | '1.3' | '1.5' | '1.8' | '2.0' | '2.1' | '2.2';
+    version: '1.0' | '1.1' | '1.2' | '1.3' | '1.5' | '1.8' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4';
     /**
      * 播放器版本信息
      */
@@ -103,7 +106,7 @@ export interface JSONScene {
     /**
      * JSON 版本
      *
-     * 3.0 EC 改造
+     * 3.0 EC 改造、移除滤镜元素
      */
     version: string;
     /**
@@ -116,25 +119,25 @@ export interface JSONScene {
     type: string;
     /*************************************** 用于加载 json 后复原合成 **************************************/
     /**
-     * 选中合成ID
+     * 选中合成 ID
      * 如果没有设置，选择合成中的第一个
      */
     compositionId?: string;
     /**
      * 渲染所需合成列表
      */
-    compositions: Composition[];
+    compositions: CompositionData[];
     /******************************** 以下皆为可复用信息，加载在对应 Manager 中 *******************************/
     /**
      * 贴图信息
      */
     images: (TemplateImage | Image | CompressedImage)[];
     /**
-     * 根据合成ID，每个合成用到的 image 的数组索引
+     * 根据合成 ID，每个合成用到的 image 的数组索引
      */
     imgUsage?: Record<string, number[]>;
     /**
-     * 根据合成id，每个合成用到的 bin 的数组索引
+     * 根据合成 ID，每个合成用到的 bin 的数组索引
      */
     binUsage?: Record<string, number[]>;
     /**
@@ -146,28 +149,17 @@ export interface JSONScene {
      * 'model@1.0'
      */
     plugins: string[];
-    /**
-     * 保留字段
-     */
-    requires: SceneRequire[];
     /**
      * 字体资源
      * 数据模板下掉可以不要 FontBase[]
      */
     fonts?: FontBase[] | FontDefine[];
-    /**
-     * spine 资源
-     * @version 1.5
-     */
-    spines?: SpineResource[];
     /**
      * 二进制文件地址
-     * @version 1.3
      */
     bins?: BinaryFile[];
     /**
      * textures 配置
-     * 从 v1.3 开始，images 数组会对应创建 textures 数组
      */
     textures?: TextureDefine[];
     /**
@@ -190,4 +182,12 @@ export interface JSONScene {
      * 几何体数据
      */
     geometries: GeometryData[];
+    /**
+     * 动画数据
+     */
+    animations: AnimationClipData[];
+    /**
+     * 分类外的资产数据
+     */
+    miscs: EffectsObjectData[];
 }

package/es/scene.js

@@ -0,0 +1 @@
+export {};