@galacean/effects-specification 1.0.1 → 2.0.0-alpha.0

package/dist/src/item/model/light.d.ts

@@ -1,6 +1,7 @@
 import type { RGBAColorValue } from '../../numberExpression';
 import type { BaseItem, ItemEndBehavior } from '../base-item';
 import type { RotationOverLifetime, PositionOverLifetime, ItemType } from '../../type';
+import type { ColorData, ComponentData } from '../../components';
 export interface ModelLightBaseOptions {
     /**
      * 挂靠的父节点
@@ -70,3 +71,49 @@ export interface ModelLightItem extends BaseItem {
     content: ModelLightContent;
     endBehavior: ItemEndBehavior;
 }
+export declare enum LightType {
+    /**
+     * 点光源
+     */
+    point = "point",
+    /**
+     * 聚光灯
+     */
+    spot = "spot",
+    /**
+     * 方向光
+     */
+    directional = "directional",
+    /**
+     * 环境光
+     */
+    ambient = "ambient"
+}
+export interface ModelLightComponentData extends ComponentData {
+    lightType: LightType;
+    /**
+     * 灯光颜色，线性空间
+     * @default [255,255,255]
+     */
+    color: ColorData;
+    /**
+     * 灯光强度
+     * @default 1
+     */
+    intensity: number;
+    /**
+     * 点光源和聚光灯
+     * @default Infinity
+     */
+    range?: number;
+    /**
+     * 聚光灯
+     * @default 0
+     */
+    innerConeAngle?: number;
+    /**
+     * 聚光灯
+     * @default 45度
+     */
+    outerConeAngle?: number;
+}

package/dist/src/item/model/mesh.d.ts

@@ -5,6 +5,7 @@ import type { GeometryPointer } from './binary';
 import type { vec3 } from '../../numberExpression';
 import type { InteractBehavior, ItemType } from '../../type';
 import type { ModelAnimationTrackDataPointer } from './binary';
+import type { ComponentData, DataPath, GeometryData, MaterialData } from '../../components';
 export type BufferType = WebGLRenderingContext['FLOAT'] | WebGLRenderingContext['INT'] | WebGLRenderingContext['SHORT'] | WebGLRenderingContext['BYTE'] | WebGLRenderingContext['UNSIGNED_INT'] | WebGLRenderingContext['UNSIGNED_SHORT'] | WebGLRenderingContext['UNSIGNED_BYTE'];
 export interface PrimitiveOptions<T extends BinaryEnv> {
     geometry: GeometryPointer<T>;
@@ -67,3 +68,29 @@ export interface ModelMeshItem<T extends BinaryEnv> extends BaseItem {
     content: ModelMeshItemContent<T>;
     endBehavior: ItemEndBehavior;
 }
+export interface PrimitiveData {
+    geometry: GeometryData;
+    material: MaterialData;
+}
+export interface SkinData {
+    name?: string;
+    joints: DataPath[];
+    skeleton?: DataPath;
+    inverseBindMatrices: number[];
+}
+export interface MorphData {
+    weights: number[];
+}
+export interface ModelMeshComponentData extends ComponentData {
+    hide?: boolean;
+    /**
+     * 蒙皮数据
+     */
+    skin?: SkinData;
+    /**
+     * Morph数据
+     */
+    morph?: MorphData;
+    primitives: PrimitiveData[];
+    interaction?: ModelItemBounding;
+}

package/dist/src/item/model/skybox.d.ts

@@ -2,6 +2,7 @@ import type { BaseItem, ItemEndBehavior } from '../base-item';
 import type { BinaryEnv } from '../../binary';
 import type { SkyboxCubeTexturePointer } from './binary';
 import type { ItemType } from 'src/type';
+import type { ComponentData, DataPath } from '../../components';
 export interface SkyboxOptions<T extends BinaryEnv> {
     renderable: boolean;
     intensity: number;
@@ -48,3 +49,47 @@ export interface ModelSkyboxItem<T extends BinaryEnv> extends BaseItem {
  * },
  * bins:[{url:'https://big/bin/'}]
  */
+export interface SkyboxComponentOptions {
+    renderable: boolean;
+    intensity: number;
+    reflectionsIntensity: number;
+    irradianceCoeffs?: number[];
+    diffuseImage?: DataPath;
+    specularImage: DataPath;
+    specularImageSize: number;
+    specularMipCount: number;
+}
+export interface SkyboxComponentData extends ComponentData {
+    /**
+     * Skybox 是否渲染，UI显示"可见"
+     */
+    renderable: boolean;
+    /**
+     * Diffuse 强度，UI显示"环境光强度"
+     */
+    intensity: number;
+    /**
+     * Specular 强度，UI显示"环境反射强度"
+     */
+    reflectionsIntensity: number;
+    /**
+     * SH 系数，先不在UI面板上显示（原先为二维数组，注意兼容性！！！）
+     */
+    irradianceCoeffs?: number[];
+    /**
+     * 漫反射贴图，UI显示"漫反射贴图"
+     */
+    diffuseImage?: DataPath;
+    /**
+     * 高光贴图，UI显示"高光贴图"
+     */
+    specularImage: DataPath;
+    /**
+     * 高光贴图大小，UI不显示
+     */
+    specularImageSize: number;
+    /**
+     * 高光贴图 mipmap 数，UI不显示
+     */
+    specularMipCount: number;
+}

package/dist/src/item/model/tree.d.ts

@@ -2,6 +2,7 @@ import type { BinaryEnv } from '../../binary';
 import type { ModelAnimationTrackDataPointer } from './binary';
 import type { BaseItem, BaseItemTransform } from '../base-item';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ItemType } from '../../type';
+import type { ComponentData, DataPath } from '../../components';
 export interface TreeNodeOptions {
     name?: string;
     transform?: BaseItemTransform;
@@ -63,3 +64,24 @@ export interface ModelTreeItem<T extends BinaryEnv> extends BaseItem {
     type: ItemType.tree;
     content: ModelTreeContent<T>;
 }
+export interface ModelAnimationTrackData {
+    item: DataPath;
+    input: number[];
+    output: number[];
+    path: 'translation' | 'rotation' | 'scale' | 'weights';
+    interpolation: 'LINEAR' | 'STEP' | 'CUBICSPLINE';
+}
+export interface ModelAnimationData {
+    name?: string;
+    tracks: ModelAnimationTrackData[];
+}
+export interface ModelAnimationComponentData extends ComponentData {
+    /**
+     * 默认动画索引，-1表示不播放动画
+     */
+    animation?: number;
+    /**
+     * 3D场景树中所有的动画数据
+     */
+    animations: ModelAnimationData[];
+}

package/dist/src/item/null-item.d.ts

@@ -1,6 +1,7 @@
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType } from '../type';
 import type { RGBAColorValue } from '../numberExpression';
 import type { BaseItem } from './base-item';
+import type { ComponentData, DataPath, EffectsObjectData } from '../components';
 /**
  * 空节点元素
  */
@@ -44,3 +45,50 @@ export interface NullContent {
      */
     colorOverLifetime?: ColorOverLifetime;
 }
+export interface TimelineComponentData extends ComponentData {
+    /**
+     * 轨道数据
+     */
+    tracks: TrackAssetData[];
+}
+export interface PlayableAssetData {
+    dataType: string;
+}
+export interface TrackAssetData extends PlayableAssetData {
+    clips: TimelineClipData[];
+}
+export interface TimelineClipData {
+    start: number;
+    duration: number;
+    clipAsset: DataPath;
+}
+export interface TransformAnimationPlayableAssetData extends PlayableAssetData {
+    animationClip: DataPath;
+}
+export interface SpriteColorAnimationPlayableAssetData extends PlayableAssetData {
+    animationClip: DataPath;
+}
+export interface TransformAnimationClipData extends EffectsObjectData {
+    /**
+     * 空节点元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 空节点元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 空节点元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+}
+export interface SpriteColorAnimationClipData extends EffectsObjectData {
+    /**
+     * 空节点元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 图层初始颜色
+     */
+    startColor?: RGBAColorValue;
+}

package/dist/src/item/particle-item.d.ts

@@ -3,6 +3,7 @@ import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, Fixe
 import type { BaseItem, ItemEndBehavior } from './base-item';
 import type { ParticleShape } from './particle-shape';
 import type { DistortionFilterParams } from './filter-item';
+import type { ComponentData } from 'src/components';
 /**
  * 粒子交互行为
  */
@@ -335,6 +336,77 @@ export interface ParticleContent {
     };
     filter?: DistortionFilterParams;
 }
+/**
+ * 粒子元素渲染属性
+ */
+export interface ParticleSystemData extends ComponentData {
+    splits?: SplitParameter[];
+    /**
+     * 粒子元素基础属性
+     */
+    options: ParticleOptions;
+    /**
+     * 粒子元素材质渲染属性
+     */
+    renderer: RendererOptions;
+    /**
+     * 粒子元素发射器形状属性
+     */
+    shape?: ParticleShape;
+    /**
+     * 粒子元素发射参数属性
+     */
+    emission: ParticleEmission;
+    /**
+     * 粒子元素大小变化属性
+     */
+    sizeOverLifetime?: ParticleSizeOverLifetime;
+    /**
+     * 发射器 transform 变化
+     */
+    emitterTransform?: {
+        /**
+         * 位置变化
+         */
+        path?: FixedVec3Expression;
+    };
+    positionOverLifetime?: ParticlePositionOverLifetime;
+    /**
+     * 粒子元素旋转变化属性
+     */
+    rotationOverLifetime?: ParticleRotationOverLifetime;
+    /**
+     * 粒子元素色彩变化属性
+     */
+    colorOverLifetime?: ParticleColorOverLifetime;
+    /**
+     * 粒子元素贴图变化属性
+     */
+    textureSheetAnimation?: ParticleTextureSheetAnimation;
+    /**
+     * 粒子元素拖尾参数
+     */
+    trails?: ParticleTrail;
+    /**
+     * 粒子元素交互参数
+     */
+    interaction?: {
+        /**
+         * 交互行为
+         */
+        behavior?: ParticleInteractionBehavior;
+        /**
+         * 重叠元素响应开关
+         */
+        multiple?: boolean;
+        /**
+         * ray cast 射线拾取时 sphere 的半径
+         * @default 0.4
+         */
+        radius?: number;
+    };
+    filter?: DistortionFilterParams;
+}
 /**
  * 粒子拖尾参数
  */

package/dist/src/item/sprite-item.d.ts

@@ -1,6 +1,7 @@
 import type { BaseItem, ItemEndBehavior } from './base-item';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, SplitParameter, InteractBehavior } from '../type';
 import type { RGBAColorValue } from '../numberExpression';
+import type { ComponentData } from 'src/components';
 /**
  * 图层元素
  */
@@ -69,3 +70,50 @@ export interface SpriteContent {
         behavior: InteractBehavior;
     };
 }
+/**
+ * 图层组件属性
+ */
+export interface SpriteComponentData extends ComponentData {
+    /**
+     * added by loader
+     * @default null
+     */
+    splits?: SplitParameter[];
+    /**
+     * 图层元素基础属性
+     */
+    options: SpriteContentOptions;
+    /**
+     * 图层元素材质渲染属性
+     */
+    renderer: RendererOptions;
+    /**
+     * 图层元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 图层元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 图层元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 图层元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 图层元素贴图变化属性
+     */
+    textureSheetAnimation?: TextureSheetAnimation;
+    /**
+     * 图层交互
+     */
+    interaction?: {
+        /**
+         * 交互行为
+         */
+        behavior: InteractBehavior;
+    };
+}

package/dist/src/item/text-item.d.ts

@@ -2,6 +2,7 @@ import type { BaseItem, ItemEndBehavior } from './base-item';
 import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, InteractBehavior } from '../type';
 import type { RGBAColorValue } from '../numberExpression';
 import type { FontStyle, TextAlignment, TextBaseline, TextOverflow, TextWeight } from 'src/text';
+import type { ComponentData } from 'src/components';
 /**
  * 文本元素
  */
@@ -170,3 +171,45 @@ export interface TextContent {
         behavior: InteractBehavior;
     };
 }
+/**
+ * 文本元素渲染属性
+ */
+export interface TextComponentData extends ComponentData {
+    /**
+     * 文本元素基础属性
+     */
+    options: TextContentOptions;
+    /**
+     * 文本元素材质渲染属性
+     */
+    renderer: RendererOptions;
+    /**
+     * 文本元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 文本元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 文本元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 文本元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 文本元素贴图变化属性
+     */
+    textureSheetAnimation?: TextureSheetAnimation;
+    /**
+     * 图层交互
+     */
+    interaction?: {
+        /**
+         * 交互行为
+         */
+        behavior: InteractBehavior;
+    };
+}

package/dist/src/scene.d.ts

@@ -4,6 +4,8 @@ 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 { VFXItemData } from './vfx-item-data';
 /**
  * 场景信息
  * 素材信息存放于统一数据结构中
@@ -13,8 +15,8 @@ export interface JSONScene {
     /**
      * JSON 版本
      *
-     * 1.1 增加数据模板 https://yuque.antfin.com/ndl7nd/mars/ib13fw
-     * 1.2 增加 anchor https://yuque.antfin.com/ndl7nd/mars/dyccyr
+     * 1.1 增加数据模板
+     * 1.2 增加 anchor
      * 1.3 增加二进制文件格式
      * 1.5 增加 Spine 数据
      * 2.0 改造升级
@@ -91,3 +93,106 @@ export interface JSONScene {
  * 如果是内置模块，但是需要额外的代码引入，比如滤镜则会加入 requires 数组中
  */
 export type SceneRequire = 'filter';
+/**
+ * 2.0 场景信息
+ * 素材信息存放于统一数据结构中
+ */
+export interface JSONSceneVersion3 {
+    /************** 文件版本不是 Player 版本，应用于文件变更后在 editor/player 中加载时的分类处理 **************/
+    /**
+     * JSON 版本
+     *
+     * 1.1 增加数据模板
+     * 1.2 增加 anchor
+     * 1.3 增加二进制文件格式
+     * 1.5 增加 Spine 数据
+     * 2.0 改造升级
+     * 2.1 增加文本元素
+     * 2.2 数据类型兼容
+     */
+    version: string;
+    /**
+     * 播放器版本信息
+     */
+    playerVersion: PlayerVersion;
+    /**
+     * 类型为 Galacean Effects
+     */
+    type: string;
+    /*************************************** 用于加载 json 后复原合成 **************************************/
+    /**
+     * 选中合成ID
+     * 如果没有设置，选择合成中的第一个
+     */
+    compositionId?: string;
+    /**
+     * 渲染所需合成列表
+     */
+    compositions: Composition[];
+    /******************************** 以下皆为可复用信息，加载在对应 Manager 中 *******************************/
+    /**
+     * 贴图信息
+     */
+    images: (TemplateImage | Image | CompressedImage)[];
+    /**
+     * 根据合成ID，每个合成用到的 image 的数组索引
+     */
+    imgUsage?: Record<string, number[]>;
+    /**
+     * 根据合成id，每个合成用到的 bin 的数组索引
+     */
+    binUsage?: Record<string, number[]>;
+    /**
+     * 蒙版形状信息
+     */
+    shapes: Shape[];
+    /**
+     * 插件类型信息
+     * '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[];
+    /**
+     * 元素数据
+     */
+    items: VFXItemData[];
+    /**
+     * 组件数据
+     */
+    components: ComponentData[];
+    /**
+     * 材质数据
+     */
+    materials: MaterialData[];
+    /**
+     * 着色器数据
+     */
+    shaders: ShaderData[];
+    /**
+     * 几何体数据
+     */
+    geometries: GeometryData[];
+}

package/dist/src/vfx-item-data.d.ts

@@ -0,0 +1,74 @@
+import type { ComponentData, EffectsObjectData } from './components';
+import type { ItemEndBehavior, ParentItemEndBehavior, BaseContent, TransformData } from './item/base-item';
+import type { ItemType, RenderLevel } from './type';
+export interface VFXItemData extends EffectsObjectData {
+    /**
+     * 元素 id
+     * 非预合成的元素 id 为 int 类型的数字字符串
+     * 预合成元素 id 为 `'{ref元素id}+{合成内id}'` 字符串
+     */
+    id: string;
+    /**
+     * 元素名称
+     */
+    name: string;
+    /**
+     * 元素时常，单位秒
+     */
+    duration: number;
+    /**
+     * 元素类型，string 类型
+     * Galacean Effects 内部元素使用 int 数字字符串
+     * plugin 模块实现者自由实现命名
+     * 2022.12更新: spine: "spine", 陀螺仪: "5"
+     */
+    type: ItemType | string;
+    /**
+     * 父节点ID
+     * 如果父节点无法找到，播放将直接报错
+     */
+    parentId?: string;
+    /**
+     * 元素可视状态
+     * 如果为 true 或者不存在时，元素可见
+     * 仅当为 false 时，元素不被创建
+     */
+    visible?: boolean;
+    /**
+     * 元素结束行为
+     * @default destroy
+     */
+    endBehavior: ItemEndBehavior | ParentItemEndBehavior;
+    /**
+     * 元素播放延时（单位秒）
+     * @default 0
+     */
+    delay?: number;
+    /**
+     * 元素渲染信息属性
+     */
+    content: BaseContent;
+    /**
+     * 元素渲染等级
+     */
+    renderLevel?: RenderLevel;
+    /**
+     * 元素的插件模块名，如果不指定，则和 type 相同
+     * 从数组的 plugins 中获取 name
+     * 例如：pn:1, plugins:["model@1.0",'spine@1.0']
+     * pn 实际为 spine
+     */
+    pn?: number;
+    /**
+     * 元素的插件模块名, 优先级高于 pn
+     */
+    pluginName?: string;
+    /**
+     * 元素的基础位置
+     */
+    transform?: TransformData;
+    /**
+     * 元素的组件数据
+     */
+    components: ComponentData[];
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "1.0.1",
+  "version": "2.0.0-alpha.0",
   "description": "Galacean Effects JSON Specification",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",