@galacean/effects-specification 2.7.2 → 2.8.0

package/es/{animation-clip-data.d.ts → animation/animation-clip-data.d.ts}

@@ -1,5 +1,6 @@
-import type { EffectsObjectData } from './effects-object-data';
-import type { ColorCurveValue, Vector3CurveValue, BezierValue, BezierCurvePath, BezierCurveQuat } from './number-expression';
+import type { EffectsObjectData } from '../effects-object-data';
+import type { ColorCurveValue, Vector3CurveValue, BezierValue, BezierCurvePath, BezierCurveQuat } from '../number-expression';
+import type { AnimationEventInfoData } from './animation-event';
 export interface AnimationClipData extends EffectsObjectData {
     duration?: number;
     positionCurves?: PositionCurveData[];
@@ -8,6 +9,7 @@ export interface AnimationClipData extends EffectsObjectData {
     scaleCurves?: ScaleCurveData[];
     floatCurves?: AnimationCurveFloatData[];
     colorCurves?: AnimationCurveColorData[];
+    events?: AnimationEventInfoData[];
 }
 export interface PositionCurveData {
     path: string;

package/es/animation/animation-event.d.ts

@@ -0,0 +1,5 @@
+export interface AnimationEventInfoData {
+    name: string;
+    startTime: number;
+    duration?: number;
+}

package/es/animation/animation-event.js

@@ -0,0 +1,4 @@
+// export interface AnimationEventData {
+//   typeName?: string,
+// }
+export {};

package/es/animation/index.d.ts

@@ -0,0 +1,2 @@
+export * from './animation-clip-data';
+export * from './animation-event';

package/es/animation/index.js

@@ -0,0 +1,2 @@
+export * from './animation-clip-data';
+export * from './animation-event';

package/es/buitin-object-guid.d.ts

@@ -1,6 +1,6 @@
 export declare const BuiltinObjectGUID: {
     WhiteTexture: string;
-    TransparentTexture: string;
+    EmptyTexture: string;
     PBRShader: string;
     UnlitShader: string;
 };

package/es/buitin-object-guid.js

@@ -1,6 +1,6 @@
 export const BuiltinObjectGUID = {
     WhiteTexture: 'whitetexture00000000000000000000',
-    TransparentTexture: 'transparenttexture00000000000000000000',
+    EmptyTexture: 'emptyTexture00000000000000000000',
     PBRShader: 'pbr00000000000000000000000000000',
     UnlitShader: 'unlit000000000000000000000000000',
 };

package/es/components/frame-component-data.d.ts

@@ -0,0 +1,7 @@
+import type { ComponentData } from './component-data';
+import type { ColorData } from '../math/color-data';
+import type { DataType } from 'src/data-type';
+export interface FrameComponentData extends ComponentData {
+    dataType: DataType.FrameComponent;
+    color?: ColorData;
+}

package/es/components/frame-component-data.js

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

package/es/components/index.d.ts

@@ -1,3 +1,6 @@
 export * from './component-data';
 export * from './post-process-volume-data';
 export * from './ffd-data';
+export * from './frame-component-data';
+export * from './maskable-graphic-data';
+export * from './orientation-component-data';

package/es/components/index.js

@@ -1,3 +1,6 @@
 export * from './component-data';
 export * from './post-process-volume-data';
 export * from './ffd-data';
+export * from './frame-component-data';
+export * from './maskable-graphic-data';
+export * from './orientation-component-data';

package/es/components/maskable-graphic-data.d.ts

@@ -0,0 +1,7 @@
+import type { ComponentData } from './component-data';
+import type { RendererOptions } from '../type';
+import type { MaskOptions } from '../item/base-item';
+export interface MaskableGraphicData extends ComponentData {
+    renderer: RendererOptions;
+    mask?: MaskOptions;
+}

package/es/components/maskable-graphic-data.js

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

package/es/components/orientation-component-data.d.ts

@@ -0,0 +1,7 @@
+import type { ComponentData } from './component-data';
+import type { PluginGyroscopeTarget } from '../type';
+export interface OrientationComponentData extends ComponentData {
+    options: {
+        targets?: PluginGyroscopeTarget[];
+    };
+}

package/es/components/orientation-component-data.js

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

package/es/composition.d.ts

@@ -78,6 +78,7 @@ interface CompositionBase {
 }
 /**
  * 合成信息
+ * @deprecated
  */
 export interface Composition extends CompositionBase {
     /**
@@ -93,6 +94,10 @@ export interface CompositionData extends CompositionBase {
      * @description 组件数据
      */
     components: DataPath[];
+    /**
+     * 合成的子节点列表
+     */
+    children?: DataPath[];
 }
 /**
  * 合成组件数据

package/es/data-type.d.ts

@@ -51,6 +51,7 @@ export declare enum DataType {
     AnimationGraphAsset = "AnimationGraphAsset",
     CompositionComponent = "CompositionComponent",
     FFDComponent = "FFDComponent",
+    FrameComponent = "FrameComponent",
     Animator = "Animator",
     TimelineClip = "TimelineClip"
 }

package/es/data-type.js

@@ -55,6 +55,7 @@ export var DataType;
     DataType["AnimationGraphAsset"] = "AnimationGraphAsset";
     DataType["CompositionComponent"] = "CompositionComponent";
     DataType["FFDComponent"] = "FFDComponent";
+    DataType["FrameComponent"] = "FrameComponent";
     DataType["Animator"] = "Animator";
     // Non-EffectObject
     DataType["TimelineClip"] = "TimelineClip";

package/es/index.d.ts

@@ -24,7 +24,7 @@ export * from './item/video-item';
 export * from './item/audio-item';
 export * from './item/model';
 export * from './vfx-item-data';
-export * from './animation-clip-data';
+export * from './animation';
 export * from './binary';
 export * from './text';
 export * from './components';
@@ -41,4 +41,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_6'];
+export declare const LATEST_VERSION = JSONSceneVersion['3_7'];

package/es/index.js

@@ -24,7 +24,7 @@ export * from './item/video-item';
 export * from './item/audio-item';
 export * from './item/model';
 export * from './vfx-item-data';
-export * from './animation-clip-data';
+export * from './animation';
 export * from './binary';
 export * from './text';
 export * from './components';

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

@@ -2,6 +2,7 @@ import type { BaseItem, EndBehavior } from './base-item';
 import type { ItemType, RotationOverLifetime } from '../type';
 import type { FixedNumberExpression, FixedVec3Expression } from '../number-expression';
 import type { CameraClipMode } from '../composition';
+import type { ComponentData } from '../components/component-data';
 export interface CameraItem extends BaseItem {
     /**
      * 元素类型[指定为model]
@@ -67,3 +68,5 @@ export interface CameraPositionOverLifetime {
      */
     path?: FixedVec3Expression;
 }
+export interface CameraControllerData extends ComponentData, CameraContent {
+}

package/es/item/model/tree.d.ts

@@ -95,3 +95,5 @@ export interface AnimationComponentData extends ComponentData {
      */
     animationClips: DataPath[];
 }
+export interface ModelTreeComponentData<T extends BinaryEnv> extends ComponentData, ModelTreeContent<T> {
+}

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

@@ -1,4 +1,4 @@
-import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, SplitParameter, ObscuredMode } from '../type';
+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, MaskOptions } from './base-item';
 import type { ParticleShape } from './particle-shape';
@@ -229,6 +229,10 @@ export interface ParticleTextureSheetAnimation extends TextureSheetAnimation {
     animationDuration: NumberExpression;
 }
 export interface ParticleOptions {
+    /**
+     * 发射循环开关
+     */
+    looping?: boolean;
     /**
      * 最大粒子数
      */
@@ -417,8 +421,4 @@ export interface ParticleTrail {
      * 拖尾+图层绑定同一个父节点时使用
      */
     parentAffectsPosition?: boolean;
-    /**
-     * 拖尾蒙版属性，传入表示需要被遮挡/反向遮挡
-     */
-    mask?: ObscuredMode;
 }

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

@@ -1,7 +1,6 @@
 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';
 import type { TextSizeMode } from '../text';
 /**
  * 富文本元素
@@ -21,10 +20,6 @@ export interface RichTextItem extends BaseItem {
  * 富文本元素参数
  */
 export interface RichTextContentOptions extends BaseTextContentOptions {
-    /**
-     * 富文本元素大小
-     */
-    size?: vec2;
     /**
      * 文本框宽度，用来排版和控制文本溢出行为
      */

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

@@ -1,7 +1,7 @@
 import type { BaseItem, EndBehavior, MaskOptions } 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';
+import type { ComponentData, DataPath } from '../components';
 /**
  * 图层元素
  */
@@ -79,4 +79,8 @@ export interface SpriteContent {
  * 图层组件属性
  */
 export interface SpriteComponentData extends ComponentData, SpriteContent {
+    /**
+     * 自定义几何体数据
+     */
+    geometry?: DataPath;
 }

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

@@ -1,7 +1,7 @@
 import type { BaseItem, EndBehavior, MaskOptions } 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, TextVerticalAlign } from '../text';
+import type { FontStyle, TextAlignment, TextBaseline, TextOverflow, TextWeight, TextVerticalAlign, TextSizeMode } from '../text';
 import type { ComponentData } from '../components';
 /**
  * 文本元素
@@ -29,15 +29,10 @@ export interface TextContentOptions extends BaseTextContentOptions {
      */
     textHeight?: number;
     /**
-     * 自适应宽高开关（和文本固定宽度冲突）
-     * @default false
+     * 文本自动调整尺寸模式
+     * @default TextSizeMode.fixed
      */
-    autoWidth?: boolean;
-    /**
-     * 自适应宽高开关（和文本固定高度冲突）
-     * @default false
-     */
-    autoHeight?: boolean;
+    autoResize?: TextSizeMode;
 }
 export interface BaseTextContentOptions {
     /**

package/es/number-expression.d.ts

@@ -27,11 +27,13 @@ export declare enum ValueType {
      */
     LINE = 5,
     /**
-     * 曲线
+     * 曲线（Hermite 曲线）
+     * @deprecated 使用 BEZIER_CURVE 替代，此类型仅用于旧数据迁移兼容
      */
     CURVE = 6,
     /**
      * 贝塞尔路径
+     * @deprecated 使用 BEZIER_CURVE_PATH 替代，此类型仅用于旧数据迁移兼容
      */
     BEZIER_PATH = 7,
     /**
@@ -129,6 +131,10 @@ export type mat4 = [
 export type FunctionExpression = LineValue | CurveValue | BezierValue;
 export type FixedNumberExpression = ConstantNumber | LineValue | CurveValue | BezierValue;
 export type NumberExpression = FixedNumberExpression | RandomValue;
+/**
+ * 固定 vec3 表达式
+ * @deprecated BezierPath 和 LinearPath 仅用于旧数据迁移兼容，推荐使用 BezierCurvePath
+ */
 export type FixedVec3Expression = ConstantVec3 | BezierPath | LinearPath | BezierCurvePath;
 export type FixedQuatExpression = BezierCurveQuat;
 /**
@@ -151,11 +157,13 @@ export type RandomValue = [type: ValueType.RANDOM, value: [min: number, max: num
 export type LineValue = [type: ValueType.LINE, value: [time: number, value: number][]];
 export type CurveEasingPoint = [time: number, value: number, tanIn: number, tanOut: number];
 /**
- * 曲线段数值
+ * 曲线段数值（Hermite 曲线）
+ * @deprecated 使用 BezierValue 替代，此类型仅用于旧数据迁移兼容
  */
 export type CurveValue = [type: ValueType.CURVE, value: CurveEasingPoint[]];
 /**
  * 贝塞尔路径数值
+ * @deprecated 使用 BezierCurvePath 替代，此类型仅用于旧数据迁移兼容
  */
 export type BezierPath = [type: ValueType.BEZIER_PATH, value: BezierPathValue];
 export type BezierPathValue = [

package/es/number-expression.js

@@ -28,11 +28,13 @@ export var ValueType;
      */
     ValueType[ValueType["LINE"] = 5] = "LINE";
     /**
-     * 曲线
+     * 曲线（Hermite 曲线）
+     * @deprecated 使用 BEZIER_CURVE 替代，此类型仅用于旧数据迁移兼容
      */
     ValueType[ValueType["CURVE"] = 6] = "CURVE";
     /**
      * 贝塞尔路径
+     * @deprecated 使用 BEZIER_CURVE_PATH 替代，此类型仅用于旧数据迁移兼容
      */
     ValueType[ValueType["BEZIER_PATH"] = 7] = "BEZIER_PATH";
     /**

package/es/scene.d.ts

@@ -6,13 +6,13 @@ import type { FontBase, FontDefine } from './text';
 import type { BinaryFile } from './binary';
 import type { ComponentData } from './components';
 import type { VFXItemData } from './vfx-item-data';
-import type { AnimationClipData } from './animation-clip-data';
 import type { AssetBase, ImageSource, VideoInfo } from './assets';
 import type { RenderSettings } from './render-settings';
 import type { EffectsObjectData } from './effects-object-data';
 import type { MaterialData } from './material-data';
 import type { GeometryData } from './geometry-data';
 import type { ShaderData } from './shader-data';
+import type { AnimationClipData } from './animation';
 /**
  * JSON 版本
  */
@@ -35,12 +35,13 @@ export declare enum JSONSceneVersion {
     '3_4' = "3.4",// 动画状态机
     '3_5' = "3.5",// 网格形状变化动画、矢量图形填充/描边渐变色
     '3_6' = "3.6",// 支持 KTX2 纹理、H265 视频格式、文本增强
-    'LATEST' = "3.6"
+    '3_7' = "3.7",// 文本 autoSize、元素子节点
+    'LATEST' = "3.7"
 }
 /**
  * runtime 2.0 之前的场景信息
  * 素材信息存放于统一数据结构中
- * @deprecated
+ * @deprecated 使用 JSONScene 代替
  */
 export interface JSONSceneLegacy {
     /************** 文件版本不是 Player 版本，应用于文件变更后在 editor/player 中加载时的分类处理 **************/

package/es/scene.js

@@ -21,5 +21,6 @@ export var JSONSceneVersion;
     JSONSceneVersion["3_4"] = "3.4";
     JSONSceneVersion["3_5"] = "3.5";
     JSONSceneVersion["3_6"] = "3.6";
-    JSONSceneVersion["LATEST"] = "3.6";
+    JSONSceneVersion["3_7"] = "3.7";
+    JSONSceneVersion["LATEST"] = "3.7";
 })(JSONSceneVersion || (JSONSceneVersion = {}));

package/es/type.d.ts

@@ -448,6 +448,7 @@ export interface RendererOptions {
     texture?: DataPath;
     /**
      * 蒙版形状，索引到 scene 的 shapes 中
+     * @deprecated runtime 2.0 后迁移到 SpriteComponentData.geometry
      */
     shape?: number | ShapeGeometry;
     /**

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

@@ -23,6 +23,15 @@ export interface VFXItemData extends EffectsObjectData {
      * plugin 模块实现者自由实现命名
      */
     type: ItemType;
+    /**
+     * 元素结束行为
+     * @default destroy
+     */
+    endBehavior: EndBehavior;
+    /**
+     * 元素的组件数据
+     */
+    components: DataPath[];
     /**
      * 父节点 ID
      * 如果父节点无法找到，播放将直接报错
@@ -35,40 +44,39 @@ export interface VFXItemData extends EffectsObjectData {
      */
     visible?: boolean;
     /**
-     * 元素结束行为
-     * @default destroy
+     * 元素渲染等级
      */
-    endBehavior: EndBehavior;
+    renderLevel?: RenderLevel;
+    /**
+     * 元素的基础位置
+     */
+    transform?: TransformData;
+    /**
+     * 元素的子节点列表
+     */
+    children?: DataPath[];
     /**
      * 元素播放延时（单位秒）
      * @default 0
+     * @deprecated
      */
     delay?: number;
     /**
      * 元素渲染信息属性
+     * @deprecated
      */
     content: BaseContent;
-    /**
-     * 元素渲染等级
-     */
-    renderLevel?: RenderLevel;
     /**
      * 元素的插件模块名，如果不指定，则和 type 相同
      * 从数组的 plugins 中获取 name
      * 例如：pn:1, plugins:["model@1.0",'spine@1.0']
      * pn 实际为 spine
+     * @deprecated
      */
     pn?: number;
     /**
      * 元素的插件模块名, 优先级高于 pn
+     * @deprecated
      */
     pluginName?: string;
-    /**
-     * 元素的基础位置
-     */
-    transform?: TransformData;
-    /**
-     * 元素的组件数据
-     */
-    components: DataPath[];
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "description": "Galacean Effects JSON Specification",
   "module": "./es/index.js",
   "main": "./es/index.js",
@@ -15,6 +15,17 @@
       "types": "./es/index.d.ts"
     }
   },
+  "scripts": {
+    "prebuild": "pnpm clean",
+    "build": "pnpm build:lib",
+    "build:lib": "tsc -b tsconfig.build.json",
+    "lint": "eslint src --ext .ts,.mjs",
+    "lint:fix": "eslint src --fix --quiet --ext .ts,.mjs",
+    "check:ts": "tsc -b tsconfig.check.json",
+    "clean": "rimraf es/**",
+    "prepare": "husky install",
+    "prepublishOnly": "npm run build"
+  },
   "browserslist": [
     "iOS 9"
   ],
@@ -32,19 +43,14 @@
     "rimraf": "^3.0.2",
     "typescript": "^5.3.3"
   },
+  "engines": {
+    "node": "18",
+    "pnpm": "8"
+  },
   "author": "Ant Group CO., Ltd.",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
-  },
-  "scripts": {
-    "prebuild": "pnpm clean",
-    "build": "pnpm build:lib",
-    "build:lib": "tsc -b tsconfig.build.json",
-    "lint": "eslint src --ext .ts,.mjs",
-    "lint:fix": "eslint src --fix --quiet --ext .ts,.mjs",
-    "check:ts": "tsc -b tsconfig.check.json",
-    "clean": "rimraf es/**"
   }
-}
+}