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

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 {};

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

@@ -1,9 +1,3 @@
-import type { RGBAColor } from './number-expression';
-export interface StringTemplate {
-    fonts: FontBase[];
-    texts: Text[];
-    colors: RGBAColor[];
-}
 /**
  * 字体资源
  * @version 2.3
@@ -56,52 +50,6 @@ export interface FontBase {
      */
     letterSpace?: number;
 }
-export interface Text {
-    x: number;
-    y: number;
-    /**
-     * 变量名
-     */
-    n?: string;
-    /**
-     * content,
-     * 文字内容，如果包含 $var$ 样式，内容将被替换
-     */
-    t: string;
-    /**
-     * width, if not provide use canvas.measureText() to get width
-     * 文字最大宽度，如果不设置，由系统进行计算
-     */
-    w?: number;
-    /**
-     * font, index to fonts array
-     * 字体，指向字体数组
-     * @default 0
-     */
-    f?: number;
-    /**
-     * textAlignment
-     * 字体排列
-     * @default 0
-     */
-    a?: TextAlignment;
-    /**
-     * index to color array
-     * 字体颜色，指向数组
-     */
-    c?: number;
-    /**
-     * 当文字超过最大宽度时，文字的表现行为
-     * 仅当设置文字最大宽度后生效
-     * @default 0
-     */
-    of?: TextOverflow;
-    /**
-     * 当文字overflow为ellipsis时的替换符号
-     * @default ".."
-     */
-    et?: string;
-}
 export declare enum TextOverflow {
     /**
      * display 模式下，会显示所有文本，存在文本超过边界框的情况。
@@ -133,7 +81,7 @@ export declare enum TextBaseline {
 export declare enum TextAlignment {
     /**
      * text alignment starts from（x,y) to right direction
-     * 从(x,y)开始第一个字符，向右边延伸
+     * 从 (x,y) 开始第一个字符，向右边延伸
      */
     left = 0,
     /**
@@ -143,7 +91,7 @@ export declare enum TextAlignment {
     middle = 1,
     /**
      * text alignment ends with（x,y) from left direction
-     * 从(x,y)结束最后一个字符，向左边延伸
+     * 从 (x,y) 结束最后一个字符，向左边延伸
      */
     right = 2
 }
@@ -171,7 +119,7 @@ export declare enum FontStyle {
     /**
      * 正常
      */
-    normal = "normal",
+    normal = "normal",// default
     /**
      * 斜体
      */

package/es/text.js

@@ -0,0 +1,84 @@
+export var TextOverflow;
+(function (TextOverflow) {
+    /**
+     * display 模式下，会显示所有文本，存在文本超过边界框的情况。
+     */
+    TextOverflow[TextOverflow["display"] = 0] = "display";
+    /**
+     * clip 模式下，当文本内容超出边界框时，多余的会被截断。
+     */
+    TextOverflow[TextOverflow["clip"] = 1] = "clip";
+    /**
+     * ellipsis 模式下，会使用（...）来代替超出边界框的内容。
+     */
+    TextOverflow[TextOverflow["ellipsis"] = 2] = "ellipsis";
+})(TextOverflow || (TextOverflow = {}));
+export var TextBaseline;
+(function (TextBaseline) {
+    /**
+     * 文本顶对齐。
+     */
+    TextBaseline[TextBaseline["top"] = 0] = "top";
+    /**
+     * 文本垂直居中对齐。
+     */
+    TextBaseline[TextBaseline["middle"] = 1] = "middle";
+    /**
+     * 文本底对齐。
+     */
+    TextBaseline[TextBaseline["bottom"] = 2] = "bottom";
+})(TextBaseline || (TextBaseline = {}));
+export var TextAlignment;
+(function (TextAlignment) {
+    /**
+     * text alignment starts from（x,y) to right direction
+     * 从 (x,y) 开始第一个字符，向右边延伸
+     */
+    TextAlignment[TextAlignment["left"] = 0] = "left";
+    /**
+     * (x,y) is middle position of text, where (left + right)/2 =(x,y)
+     * (x,y) 为文字中间位置，（最左位置 + 最右位置)/2 = (x,y)
+     */
+    TextAlignment[TextAlignment["middle"] = 1] = "middle";
+    /**
+     * text alignment ends with（x,y) from left direction
+     * 从 (x,y) 结束最后一个字符，向左边延伸
+     */
+    TextAlignment[TextAlignment["right"] = 2] = "right";
+})(TextAlignment || (TextAlignment = {}));
+/**
+ * 文本字重
+ */
+export var TextWeight;
+(function (TextWeight) {
+    /**
+     * 正常
+     */
+    TextWeight["normal"] = "normal";
+    /**
+     * 粗体
+     */
+    TextWeight["bold"] = "bold";
+    /**
+     * 瘦体
+     */
+    TextWeight["lighter"] = "lighter";
+})(TextWeight || (TextWeight = {}));
+/**
+ * 文本样式
+ */
+export var FontStyle;
+(function (FontStyle) {
+    /**
+     * 正常
+     */
+    FontStyle["normal"] = "normal";
+    /**
+     * 斜体
+     */
+    FontStyle["italic"] = "italic";
+    /**
+     * 倾斜体
+     */
+    FontStyle["oblique"] = "oblique";
+})(FontStyle || (FontStyle = {}));

package/es/timeline/index.d.ts

@@ -0,0 +1,5 @@
+export * from './track/track-asset-data';
+export * from './playables/sprite-color-playable-asset-data';
+export * from './timeline-asset-data';
+export * from './timeline-clip-data';
+export * from './playables/transform-playable-asset-data';

package/es/timeline/index.js

@@ -0,0 +1,5 @@
+export * from './track/track-asset-data';
+export * from './playables/sprite-color-playable-asset-data';
+export * from './timeline-asset-data';
+export * from './timeline-clip-data';
+export * from './playables/transform-playable-asset-data';

package/es/timeline/playables/sprite-color-playable-asset-data.d.ts

@@ -0,0 +1,8 @@
+import type { DataType, EffectsObjectData } from '../../components';
+import type { RGBAColorValue } from '../../number-expression';
+import type { ColorOverLifetime } from '../../type';
+export interface SpriteColorPlayableAssetData extends EffectsObjectData {
+    dataType: DataType.SpriteColorPlayableAsset;
+    colorOverLifetime?: ColorOverLifetime;
+    startColor?: RGBAColorValue;
+}

package/es/timeline/playables/sprite-color-playable-asset-data.js

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

package/es/timeline/playables/transform-playable-asset-data.d.ts

@@ -0,0 +1,17 @@
+import type { DataType, EffectsObjectData } from '../../components';
+import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime } from '../../type';
+export interface TransformPlayableAssetData extends EffectsObjectData {
+    dataType: DataType.TransformPlayableAsset;
+    /**
+     * 元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+}

package/es/timeline/playables/transform-playable-asset-data.js

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

package/es/timeline/timeline-asset-data.d.ts

@@ -0,0 +1,8 @@
+import type { EffectsObjectData, DataPath, DataType } from '../components';
+export interface TimelineAssetData extends EffectsObjectData {
+    dataType: DataType.TimelineAsset;
+    /**
+     * 轨道数据（TrackAssetData）
+     */
+    tracks: DataPath[];
+}

package/es/timeline/timeline-asset-data.js

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

package/es/timeline/timeline-clip-data.d.ts

@@ -0,0 +1,11 @@
+import type { EndBehavior } from '../item/base-item';
+import type { DataPath } from '../components';
+export interface TimelineClipData {
+    start?: number;
+    duration?: number;
+    endBehavior?: EndBehavior;
+    /**
+     * 可播放资产（PlayableAssetData）
+     */
+    asset: DataPath;
+}

package/es/timeline/timeline-clip-data.js

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

package/es/timeline/track/track-asset-data.d.ts

@@ -0,0 +1,9 @@
+import type { DataPath, EffectsObjectData } from '../../components';
+import type { TimelineClipData } from '../timeline-clip-data';
+export interface TrackAssetData extends EffectsObjectData {
+    /**
+     * 子轨道数据（TrackAssetData）
+     */
+    children: DataPath[];
+    clips: TimelineClipData;
+}

package/es/timeline/track/track-asset-data.js

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

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

@@ -4,11 +4,11 @@ import type { FixedVec3Expression, vec2, vec3, GradientColor, ShapePoints, Shape
  */
 export interface PlayerVersion {
     /**
-     * Web端版本号
+     * Web 端版本号
      */
     web: string;
     /**
-     * Native端版本号
+     * Native 端版本号
      */
     native: string;
 }
@@ -72,15 +72,15 @@ export interface SizeOverLifetime {
      */
     size?: FixedNumberExpression;
     /**
-     * x轴大小变化信息（分轴模式）
+     * x 轴大小变化信息（分轴模式）
      */
     x?: FixedNumberExpression;
     /**
-     * y轴大小变化信息（分轴模式）
+     * y 轴大小变化信息（分轴模式）
      */
     y?: FixedNumberExpression;
     /**
-     * z轴大小变化信息（分轴模式）
+     * z 轴大小变化信息（分轴模式）
      */
     z?: FixedNumberExpression;
 }
@@ -118,15 +118,15 @@ export interface PositionOverLifetime {
      */
     asMovement?: boolean;
     /**
-     * x轴位置变化信息
+     * x 轴位置变化信息
      */
     linearX?: FixedNumberExpression;
     /**
-     * y轴位置变化信息
+     * y 轴位置变化信息
      */
     linearY?: FixedNumberExpression;
     /**
-     * z轴位置变化信息
+     * z 轴位置变化信息
      */
     linearZ?: FixedNumberExpression;
     /**
@@ -134,15 +134,15 @@ export interface PositionOverLifetime {
      */
     asRotation?: boolean;
     /**
-     * x轴环绕角度变化信息
+     * x 轴环绕角度变化信息
      */
     orbitalX?: FixedNumberExpression;
     /**
-     * y轴环绕角度变化信息
+     * y 轴环绕角度变化信息
      */
     orbitalY?: FixedNumberExpression;
     /**
-     * z轴环绕角度变化信息
+     * z 轴环绕角度变化信息
      */
     orbitalZ?: FixedNumberExpression;
     /**
@@ -512,10 +512,6 @@ export declare enum ItemType {
      * 预合成元素
      */
     composition = "7",
-    /**
-     * 滤镜图层
-     */
-    filter = "8",
     /**
      * Spine 元素
      */
@@ -543,7 +539,11 @@ export declare enum ItemType {
     /**
      * 特效元素
      */
-    effect = "effect"
+    effect = "effect",
+    /**
+     * 节点元素
+     */
+    node = "node"
 }
 /**
  * 渲染模式
@@ -616,21 +616,37 @@ export interface PluginGyroscopeTarget {
      */
     name: string;
     /**
-     * x轴最小值
+     * x 轴位移最小值
      */
     xMin: number;
     /**
-     * x轴最大值
+     * x 轴位移最大值
      */
     xMax: number;
     /**
-     * y轴最小值
+     * y 轴位移最小值
      */
     yMin: number;
     /**
-     * y轴最大值
+     * y 轴位移最大值
      */
     yMax: number;
+    /**
+     * 绕 x 轴（水平）旋转角度最小值
+     */
+    hMin: number;
+    /**
+     * 绕 x 轴（水平）旋转角度最大值
+     */
+    hMax: number;
+    /**
+     * 绕 y 轴（垂直）旋转角度最小值
+     */
+    vMin: number;
+    /**
+     * 绕 y 轴（垂直）旋转角度最大值
+     */
+    vMax: number;
 }
 /**
  * 二维蒙版形状属性
@@ -645,3 +661,12 @@ export interface ShapeGeometry {
      */
     s: ShapeSplits;
 }
+export declare enum RenderType {
+    Opaque = "Opaque",
+    Transparent = "Transparent"
+}
+export declare enum RenderFace {
+    Both = "Both",
+    Back = "Back",
+    Front = "Front"
+}