@galacean/effects-specification 2.0.0-alpha.16 → 2.0.0-alpha.18

package/es/composition.d.ts

@@ -70,10 +70,7 @@ export declare enum CompositionEndBehavior {
      */
     freeze = 4
 }
-/**
- * 合成信息
- */
-export interface Composition {
+interface CompositionBase {
     /**
      * 合成ID
      */
@@ -99,10 +96,6 @@ export interface Composition {
      * 合成相机信息
      */
     camera: CameraOptions;
-    /**
-     * 元素信息
-     */
-    items: Item[];
     /**
      * 合成视窗预览大小
      * 如果没有提供，默认为 player 的 container 大小
@@ -115,48 +108,22 @@ export interface Composition {
     fallbackImage?: string;
 }
 /**
- * 合成数据
+ * 合成信息
  */
-export interface CompositionData {
-    /**
-     * 合成ID
-     */
-    id: string;
-    /**
-     * 合成名称
-     */
-    name: string;
-    /**
-     * 合成持续时间
-     */
-    duration: number;
-    /**
-     * 合成开始播放的时间，单位妙
-     * @default 0
-     */
-    startTime?: number;
-    /**
-     * 合成结束行为
-     */
-    endBehavior: CompositionEndBehavior;
+export interface Composition extends CompositionBase {
     /**
-     * 合成相机信息
+     * 元素信息
      */
-    camera: CameraOptions;
+    items: Item[];
+}
+/**
+ * 合成数据
+ */
+export interface CompositionData extends CompositionBase {
     /**
      * 元素信息
      */
     items: DataPath[];
-    /**
-     * 合成视窗预览大小
-     * 如果没有提供，默认为 player 的 container 大小
-     * @default [0,0]
-     */
-    previewSize?: [width: number, height: number];
-    /**
-     * 降级图
-     */
-    fallbackImage?: string;
     /**
      * 时间轴资产（TimelineAssetData）
      */
@@ -176,3 +143,4 @@ export interface SceneBindingData {
      */
     value: DataPath;
 }
+export {};

package/es/image.d.ts

@@ -75,8 +75,8 @@ export interface Image {
      */
     url: string;
     /**
-     * webp 地址
-     * 如果运行时支持 webp，则尽量使用 webp
+     * WebP 地址
+     * 如果运行时支持 WebP，则优先使用 WebP
      */
     webp?: string;
     /**
@@ -91,8 +91,8 @@ export interface Image {
      */
     mipmap?: boolean;
     /**
-     * 图片Y轴的方向，如果Y轴向上（与OpenGL相同）则为 1
-     * 如果Y轴向下（与OpenGL相反）则为 -1 ，图片再绘制数据模板的时候需要翻转绘制
+     * 图片 Y 轴的方向，如果 Y 轴向上（与 OpenGL 相同）则为 1
+     * 如果 Y 轴向下（与 OpenGL 相反）则为 -1，图片再绘制数据模板的时候需要翻转绘制
      * @default 1
      */
     oriY?: 1 | -1;

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

@@ -50,15 +50,15 @@ export interface CameraContent {
 }
 export interface CameraPositionOverLifetime {
     /**
-     * x轴位置变化信息
+     * x 轴位置变化信息
      */
     linearX?: FixedNumberExpression;
     /**
-     * y轴位置变化信息
+     * y 轴位置变化信息
      */
     linearY?: FixedNumberExpression;
     /**
-     * z轴位置变化信息
+     * z 轴位置变化信息
      */
     linearZ?: FixedNumberExpression;
     /**

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

@@ -7,7 +7,7 @@ import type { PositionOverLifetime } from '../type';
  */
 export interface CompositionItem extends BaseItem {
     /**
-     * 元素类型[指定为composition]
+     * 元素类型（指定为 composition）
      */
     type: ItemType.composition;
     /**
@@ -25,7 +25,7 @@ export interface CompositionContent {
      */
     options: {
         /**
-         * 引用的合成id
+         * 引用的合成 ID
          */
         refId: string;
         /**

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

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

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

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

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

@@ -21,7 +21,7 @@ export declare enum ParticleInteractionBehavior {
  */
 export interface ParticleItem extends BaseItem {
     /**
-     * 元素类型[指定为particle]
+     * 元素类型（指定为 particle）
      */
     type: ItemType.particle;
     /**
@@ -57,7 +57,7 @@ export interface ParticleEmission {
          */
         cycles?: number;
         /**
-         * 爆发时间间隔，单位秒
+         * 爆发时间间隔（单位：秒）
          * @default 0
          */
         interval?: number;
@@ -71,15 +71,15 @@ export interface ParticleEmission {
          */
         index: number;
         /**
-         * x方向偏移值
+         * x 方向偏移值
          */
         x: number;
         /**
-         * y方向偏移值
+         * y 方向偏移值
          */
         y: number;
         /**
-         * z方向偏移值
+         * z 方向偏移值
          */
         z: number;
     }[];
@@ -90,15 +90,15 @@ export interface ParticlePositionOverLifetime {
      */
     asMovement?: boolean;
     /**
-     * x轴位置变化信息
+     * x 轴位置变化信息
      */
     linearX?: NumberExpression;
     /**
-     * y轴位置变化信息
+     * y 轴位置变化信息
      */
     linearY?: NumberExpression;
     /**
-     * z轴位置变化信息
+     * z 轴位置变化信息
      */
     linearZ?: NumberExpression;
     /**
@@ -106,15 +106,15 @@ export interface ParticlePositionOverLifetime {
      */
     asRotation?: boolean;
     /**
-     * x轴环绕角度变化信息
+     * x 轴环绕角度变化信息
      */
     orbitalX?: NumberExpression;
     /**
-     * y轴环绕角度变化信息
+     * y 轴环绕角度变化信息
      */
     orbitalY?: NumberExpression;
     /**
-     * z轴环绕角度变化信息
+     * z 轴环绕角度变化信息
      */
     orbitalZ?: NumberExpression;
     /**
@@ -137,7 +137,7 @@ export interface ParticlePositionOverLifetime {
      */
     forceCurve?: FunctionExpression;
     /**
-     * 增加一个初速度，匀速直线运动，direction为运动方向
+     * 增加一个初速度，匀速直线运动，direction 为运动方向
      * @default 0
      */
     startSpeed?: NumberExpression;
@@ -146,7 +146,7 @@ export interface ParticlePositionOverLifetime {
      */
     speedOverLifetime?: FixedNumberExpression;
     /**
-     * 增加一个重力，gravity为重力方向，gravityModifier为重力大小
+     * 增加一个重力，gravity 为重力方向，gravityModifier 为重力大小
      * @default 0
      */
     gravity?: vec3;
@@ -165,15 +165,15 @@ export interface ParticleRotationOverLifetime {
      */
     asRotation?: boolean;
     /**
-     * x轴旋转函数
+     * x 轴旋转函数
      */
     x?: NumberExpression;
     /**
-     * y轴旋转函数
+     * y 轴旋转函数
      */
     y?: NumberExpression;
     /**
-     * z轴旋转函数（不分轴时，变化z）
+     * z 轴旋转函数（不分轴时，变化 z）
      */
     z?: NumberExpression;
 }
@@ -187,11 +187,11 @@ export interface ParticleSizeOverLifetime {
      */
     size?: NumberExpression;
     /**
-     * x轴大小变化信息（分轴模式）
+     * x 轴大小变化信息（分轴模式）
      */
     x?: NumberExpression;
     /**
-     * y轴大小变化信息（分轴模式）
+     * y 轴大小变化信息（分轴模式）
      */
     y?: NumberExpression;
 }

package/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/spine-item.d.ts

@@ -53,7 +53,7 @@ export interface PluginSpineOption {
        */
     activeSkin: string;
     /**
-       * 当前使用的动画列表，1.5之前为 string
+       * 当前使用的动画列表，1.5 之前为 string
        */
     activeAnimation: string[] | string;
     /**

package/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/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.d.ts

@@ -9,8 +9,6 @@ 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 | CameraItem | TextItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;

package/es/number-expression.d.ts

@@ -50,7 +50,7 @@ export declare enum ValueType {
      */
     SHAPE_SPLITS = 11,
     /**
-     *直线路径
+     * 直线路径
      */
     LINEAR_PATH = 12,
     /**

package/es/number-expression.js

@@ -52,7 +52,7 @@ export var ValueType;
      */
     ValueType[ValueType["SHAPE_SPLITS"] = 11] = "SHAPE_SPLITS";
     /**
-     *直线路径
+     * 直线路径
      */
     ValueType[ValueType["LINEAR_PATH"] = 12] = "LINEAR_PATH";
     /**

package/es/scene.d.ts

@@ -1,10 +1,10 @@
-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';
 /**
@@ -119,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[]>;
     /**
@@ -156,17 +156,14 @@ export interface JSONScene {
     fonts?: FontBase[] | FontDefine[];
     /**
      * spine 资源
-     * @version 1.5
      */
     spines?: SpineResource[];
     /**
      * 二进制文件地址
-     * @version 1.3
      */
     bins?: BinaryFile[];
     /**
      * textures 配置
-     * 从 v1.3 开始，images 数组会对应创建 textures 数组
      */
     textures?: TextureDefine[];
     /**
@@ -193,4 +190,8 @@ export interface JSONScene {
      * 动画数据
      */
     animations: AnimationClipData[];
+    /**
+     * 分类外的资产数据
+     */
+    miscs: EffectsObjectData[];
 }

package/es/text.d.ts

@@ -50,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 模式下，会显示所有文本，存在文本超过边界框的情况。
@@ -127,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,
     /**
@@ -137,7 +91,7 @@ export declare enum TextAlignment {
     middle = 1,
     /**
      * text alignment ends with（x,y) from left direction
-     * 从(x,y)结束最后一个字符，向左边延伸
+     * 从 (x,y) 结束最后一个字符，向左边延伸
      */
     right = 2
 }

package/es/text.js

@@ -32,7 +32,7 @@ export var TextAlignment;
 (function (TextAlignment) {
     /**
      * text alignment starts from（x,y) to right direction
-     * 从(x,y)开始第一个字符，向右边延伸
+     * 从 (x,y) 开始第一个字符，向右边延伸
      */
     TextAlignment[TextAlignment["left"] = 0] = "left";
     /**
@@ -42,7 +42,7 @@ export var TextAlignment;
     TextAlignment[TextAlignment["middle"] = 1] = "middle";
     /**
      * text alignment ends with（x,y) from left direction
-     * 从(x,y)结束最后一个字符，向左边延伸
+     * 从 (x,y) 结束最后一个字符，向左边延伸
      */
     TextAlignment[TextAlignment["right"] = 2] = "right";
 })(TextAlignment || (TextAlignment = {}));

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

@@ -3,7 +3,7 @@ export interface TimelineClipData {
     start?: number;
     duration?: number;
     /**
-       * 可播放资产（PlayableAssetData）
-       */
+     * 可播放资产（PlayableAssetData）
+     */
     asset: DataPath;
 }

package/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;
     /**

package/es/vfx-item-data.d.ts

@@ -3,9 +3,9 @@ import type { ItemEndBehavior, ParentItemEndBehavior, BaseContent, TransformData
 import type { ItemType, RenderLevel } from './type';
 export interface VFXItemData extends EffectsObjectData {
     /**
-     * 元素 id
-     * 非预合成的元素 id 为 int 类型的数字字符串
-     * 预合成元素 id 为 `'{ref元素id}+{合成内id}'` 字符串
+     * 元素 ID
+     * 非预合成的元素 ID 为 int 类型的数字字符串
+     * 预合成元素 ID 为 `'{ref 元素 ID}+{合成内 ID}'` 字符串
      */
     id: string;
     /**
@@ -17,14 +17,13 @@ export interface VFXItemData extends EffectsObjectData {
      */
     duration: number;
     /**
-     * 元素类型，string 类型
+     * 元素类型，String 类型
      * Galacean Effects 内部元素使用 int 数字字符串
      * plugin 模块实现者自由实现命名
-     * 2022.12更新: spine: "spine", 陀螺仪: "5"
      */
     type: ItemType;
     /**
-     * 父节点ID
+     * 父节点 ID
      * 如果父节点无法找到，播放将直接报错
      */
     parentId?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.0.0-alpha.16",
+  "version": "2.0.0-alpha.18",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",