@galacean/effects-specification 2.1.0-beta.0 → 2.2.0-alpha.0

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

@@ -0,0 +1,82 @@
+import type { ComponentData, DataPath } from '../components';
+import type { RGBAColorValue } from '../number-expression';
+import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, InteractBehavior, RendererOptions, ItemType } from '../type';
+import type { BaseItem, EndBehavior } from './base-item';
+/**
+ * 视频元素
+ */
+export interface VideoItem extends BaseItem {
+    /**
+     * 元素类型（指定为 video）
+     */
+    type: ItemType.video;
+    /**
+     * 视频元素渲染信息
+     */
+    content: VideoComponentData;
+    endBehavior: EndBehavior;
+}
+export interface VideoContentOptions {
+    /**
+     * 元素基础颜色
+     * @default [255,255,255,255]
+     */
+    startColor?: RGBAColorValue;
+    /**
+     * 视频链接，索引到 scene 中的 videos 数组
+     */
+    video: DataPath;
+    /**
+     * 视频播放速度
+     * @default 1
+     */
+    playbackRate?: number;
+    /**
+     * 是否静音播放
+     * @default false
+     */
+    muted?: boolean;
+    /**
+     * 视频音量大小
+     * @default 1
+     */
+    volume?: number;
+}
+/**
+ * 视频组件属性
+ */
+export interface VideoComponentData extends ComponentData {
+    /**
+     * 视频元素基础属性
+     */
+    options: VideoContentOptions;
+    /**
+     * 视频元素材质渲染属性
+     */
+    renderer: RendererOptions;
+    /**
+     * 视频元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 视频元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 视频元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 视频元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 视频元素交互
+     */
+    interaction?: {
+        /**
+         * 交互行为
+         */
+        behavior: InteractBehavior;
+    };
+}

package/es/item/video-item.js

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

package/es/item.d.ts

@@ -8,7 +8,10 @@ import type { ModelCameraItem, ModelLightItem, ModelMeshItem, ModelSkyboxItem, M
 import type { CameraItem } from './item/camera-item';
 import type { CompositionItem } from './item/composition-item';
 import type { TextItem } from './item/text-item';
+import type { VideoItem } from './item/video-item';
+import type { AudioItem } from './item/audio-item';
+import type { RichTextItem } from './item/rich-text-item';
 /**
  * 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'>;
+export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | CameraItem | TextItem | RichTextItem | VideoItem | AudioItem | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;

package/es/material-data.d.ts

@@ -0,0 +1,21 @@
+import type { DataPath } from './components';
+import type { EffectsObjectData } from './effects-object-data';
+import type { Vector4Data, ColorData, Vector2Data } from './math';
+export interface MaterialTextureProperty {
+    texture: DataPath;
+    offset?: Vector2Data;
+    scale?: Vector2Data;
+}
+export interface MaterialData extends EffectsObjectData {
+    shader: DataPath;
+    blending?: boolean;
+    zWrite?: boolean;
+    zTest?: boolean;
+    stringTags: Record<string, string>;
+    macros: string[];
+    ints: Record<string, number>;
+    floats: Record<string, number>;
+    vector4s: Record<string, Vector4Data>;
+    colors: Record<string, ColorData>;
+    textures: Record<string, MaterialTextureProperty>;
+}

package/es/material-data.js

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

package/es/math/color-data.d.ts

@@ -0,0 +1,6 @@
+export interface ColorData {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}

package/es/math/color-data.js

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

package/es/math/index.d.ts

@@ -0,0 +1,2 @@
+export * from './color-data';
+export * from './vector-data';

package/es/math/index.js

@@ -0,0 +1,2 @@
+export * from './color-data';
+export * from './vector-data';

package/es/math/vector-data.d.ts

@@ -0,0 +1,15 @@
+export interface Vector4Data {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+export interface Vector3Data {
+    x: number;
+    y: number;
+    z: number;
+}
+export interface Vector2Data {
+    x: number;
+    y: number;
+}

package/es/math/vector-data.js

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

package/es/number-expression.d.ts

@@ -1,3 +1,4 @@
+import type { ColorCurveData, Vector4CurveData } from './curve-data';
 /*********************************************/
 /*********************************************/
 export declare enum ValueType {
@@ -72,7 +73,15 @@ export declare enum ValueType {
     /**
      * 贝塞尔曲线四元数
      */
-    BEZIER_CURVE_QUAT = 23
+    BEZIER_CURVE_QUAT = 23,
+    /**
+     * 颜色曲线
+     */
+    COLOR_CURVE = 24,
+    /**
+     * Vector4 曲线
+     */
+    VECTOR4_CURVE = 25
 }
 export type vec2 = [x: number, y: number];
 export type vec3 = [x: number, y: number, z: number];
@@ -263,6 +272,14 @@ export type BezierCurvePath = [type: ValueType.BEZIER_CURVE_PATH, value: BezierC
  * 贝塞尔曲线路径关键帧
  */
 export type BezierCurveQuat = [type: ValueType.BEZIER_CURVE_QUAT, value: BezierCurveQuatValue];
+/**
+ * 颜色贝塞尔曲线
+ */
+export type ColorCurveValue = [type: ValueType.COLOR_CURVE, value: ColorCurveData];
+/**
+ * Vector4 贝塞尔曲线
+ */
+export type Vector4CurveValue = [type: ValueType.VECTOR4_CURVE, value: Vector4CurveData];
 /*********************************************/
 /*********************************************/
 export type ColorExpression = RGBAColor | GradientColor | RGBAColors;

package/es/number-expression.js

@@ -75,6 +75,14 @@ export var ValueType;
      * 贝塞尔曲线四元数
      */
     ValueType[ValueType["BEZIER_CURVE_QUAT"] = 23] = "BEZIER_CURVE_QUAT";
+    /**
+     * 颜色曲线
+     */
+    ValueType[ValueType["COLOR_CURVE"] = 24] = "COLOR_CURVE";
+    /**
+     * Vector4 曲线
+     */
+    ValueType[ValueType["VECTOR4_CURVE"] = 25] = "VECTOR4_CURVE";
 })(ValueType || (ValueType = {}));
 /**
  * 关键帧类型

package/es/render-settings.d.ts

@@ -0,0 +1,4 @@
+export interface RenderSettings {
+    postProcessingEnabled: boolean;
+    supportsHDR: boolean;
+}

package/es/render-settings.js

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

package/es/scene.d.ts

@@ -1,12 +1,18 @@
 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 { PlayerVersion, ShapeGeometry } from './type';
+import type { TextureDefine } from './texture';
 import type { FontBase, FontDefine } from './text';
 import type { BinaryFile } from './binary';
-import type { ComponentData, EffectsObjectData, GeometryData, MaterialData, ShaderData } from './components';
+import type { ComponentData } from './components';
 import type { VFXItemData } from './vfx-item-data';
 import type { AnimationClipData } from './animation-clip-data';
+import type { AssetBase, ImageSource } 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';
 /**
  * runtime 2.0 之前的场景信息
  * 素材信息存放于统一数据结构中
@@ -50,7 +56,7 @@ export interface JSONSceneLegacy {
     /**
      * 贴图信息
      */
-    images: (TemplateImage | Image | CompressedImage)[];
+    images: ImageSource[];
     /**
      * 根据合成ID，每个合成用到的 image 的数组索引
      */
@@ -62,7 +68,7 @@ export interface JSONSceneLegacy {
     /**
      * 蒙版形状信息
      */
-    shapes: Shape[];
+    shapes: ShapeGeometry[];
     /**
      * 插件类型信息
      * 'model@1.0'
@@ -97,6 +103,10 @@ export interface JSONSceneLegacy {
  * 如果是内置模块，但是需要额外的代码引入，比如滤镜则会加入 requires 数组中
  */
 export type SceneRequire = 'filter';
+export declare enum JSONSceneVersion {
+    '3.0' = "3.0",
+    'LATEST' = "3.1"
+}
 /**
  * 场景信息
  * 素材信息存放于统一数据结构中
@@ -107,8 +117,9 @@ export interface JSONScene {
      * JSON 版本
      *
      * 3.0 EC 改造、移除滤镜元素
+     * 3.1 音视频
      */
-    version: string;
+    version: JSONSceneVersion;
     /**
      * 播放器版本信息
      */
@@ -127,11 +138,15 @@ export interface JSONScene {
      * 渲染所需合成列表
      */
     compositions: CompositionData[];
+    /**
+     * 渲染配置
+     */
+    renderSettings?: RenderSettings;
     /******************************** 以下皆为可复用信息，加载在对应 Manager 中 *******************************/
     /**
      * 贴图信息
      */
-    images: (TemplateImage | Image | CompressedImage)[];
+    images: ImageSource[];
     /**
      * 根据合成 ID，每个合成用到的 image 的数组索引
      */
@@ -143,7 +158,7 @@ export interface JSONScene {
     /**
      * 蒙版形状信息
      */
-    shapes: Shape[];
+    shapes: ShapeGeometry[];
     /**
      * 插件类型信息
      * 'model@1.0'
@@ -154,6 +169,16 @@ export interface JSONScene {
      * 数据模板下掉可以不要 FontBase[]
      */
     fonts?: FontBase[] | FontDefine[];
+    /**
+     * 视频资源
+     * @since 2.0.0
+     */
+    videos?: AssetBase[];
+    /**
+     * 音频资源
+     * @since 2.0.0
+     */
+    audios?: AssetBase[];
     /**
      * 二进制文件地址
      */

package/es/scene.js

@@ -1 +1,5 @@
-export {};
+export var JSONSceneVersion;
+(function (JSONSceneVersion) {
+    JSONSceneVersion["3.0"] = "3.0";
+    JSONSceneVersion["LATEST"] = "3.1";
+})(JSONSceneVersion || (JSONSceneVersion = {}));

package/es/shader-data.d.ts

@@ -0,0 +1,6 @@
+import type { EffectsObjectData } from './effects-object-data';
+export interface ShaderData extends EffectsObjectData {
+    vertex: string;
+    fragment: string;
+    properties?: string;
+}

package/es/shader-data.js

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

package/es/shape/custom-shape-data.d.ts

@@ -0,0 +1,68 @@
+import type { TransformData } from '../item/base-item';
+import type { Vector2Data } from '../math';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+import type { ShapePrimitiveType } from './shape-primitive-type';
+/**
+ * 自定义形状点
+ */
+export interface CustomShapePoint {
+    /**
+     * 顶点索引
+     */
+    point: number;
+    /**
+     * 入射点索引
+     */
+    easingIn: number;
+    /**
+     * 出射点索引
+     */
+    easingOut: number;
+}
+/**
+ * 自定义形状参数
+ */
+export interface CustomShape {
+    /**
+     * 点索引 - 用于构成闭合图形
+     */
+    indexes: CustomShapePoint[];
+    /**
+     * 是否为闭合图形 - 用于Stroke
+     */
+    close: boolean;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}
+/**
+ * 自定义图形组件
+ */
+export interface CustomShapeData extends ShapeComponentData {
+    /**
+     * 矢量类型 - 形状
+     */
+    type: ShapePrimitiveType.Custom;
+    /**
+     * 路径点
+     */
+    points: Vector2Data[];
+    /**
+     * 入射控制点
+     */
+    easingIns: Vector2Data[];
+    /**
+     * 入射控制点
+     */
+    easingOuts: Vector2Data[];
+    /**
+     * 自定义形状
+     */
+    shapes: CustomShape[];
+}

package/es/shape/custom-shape-data.js

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

package/es/shape/ellipse-data.d.ts

@@ -0,0 +1,28 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+import type { ShapePrimitiveType } from './shape-primitive-type';
+/**
+ * 椭圆组件参数
+ */
+export interface EllipseData extends ShapeComponentData {
+    type: ShapePrimitiveType.Ellipse;
+    /**
+     * x 轴半径
+     * -- TODO 后续完善类型
+     * -- TODO 可以看一下用xRadius/yRadius 还是 width/height
+     */
+    xRadius: number;
+    /**
+     * y 轴半径
+     */
+    yRadius: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/ellipse-data.js

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

package/es/shape/index.d.ts

@@ -0,0 +1,9 @@
+export * from './custom-shape-data';
+export * from './ellipse-data';
+export * from './polygon-data';
+export * from './rectangle-data';
+export * from './shape-component-data';
+export * from './shape-fill-param';
+export * from './shape-primitive-type';
+export * from './shape-stroke-param';
+export * from './star-data';

package/es/shape/index.js

@@ -0,0 +1,9 @@
+export * from './custom-shape-data';
+export * from './ellipse-data';
+export * from './polygon-data';
+export * from './rectangle-data';
+export * from './shape-component-data';
+export * from './shape-fill-param';
+export * from './shape-primitive-type';
+export * from './shape-stroke-param';
+export * from './star-data';

package/es/shape/polygon-data.d.ts

@@ -0,0 +1,28 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+/**
+ * 多边形参数
+ */
+export interface PolygonData extends ShapeComponentData {
+    /**
+     * 顶点数
+     */
+    pointCount: number;
+    /**
+     * 外切圆半径
+     */
+    radius: number;
+    /**
+     * 角点圆度
+     */
+    roundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/polygon-data.js

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

package/es/shape/rectangle-data.d.ts

@@ -0,0 +1,28 @@
+import type { TransformData } from '../item/base-item';
+import type { ShapeComponentData } from './shape-component-data';
+import type { ShapeFillParam } from './shape-fill-param';
+/**
+ * 矩形参数
+ */
+export interface RectangleData extends ShapeComponentData {
+    /**
+     * 宽度
+     */
+    width: number;
+    /**
+     * 高度
+     */
+    height: number;
+    /**
+     * 角点元素
+     */
+    roundness: number;
+    /**
+     * 填充属性
+     */
+    fill?: ShapeFillParam;
+    /**
+     * 空间变换
+     */
+    transform?: TransformData;
+}

package/es/shape/rectangle-data.js

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

package/es/shape/shape-component-data.d.ts

@@ -0,0 +1,16 @@
+import type { ComponentData } from '../components/component-data';
+import type { ShapePrimitiveType } from './shape-primitive-type';
+import type { ShapeStrokeParam } from './shape-stroke-param';
+/**
+ * 矢量图形组件
+ */
+export interface ShapeComponentData extends ComponentData {
+    /**
+     * 矢量类型
+     */
+    type: ShapePrimitiveType;
+    /**
+     * 描边属性
+     */
+    stroke?: ShapeStrokeParam;
+}

package/es/shape/shape-component-data.js

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

package/es/shape/shape-fill-param.d.ts

@@ -0,0 +1,10 @@
+import type { ColorData } from '../math/color-data';
+/**
+ * 矢量填充参数
+ */
+export interface ShapeFillParam {
+    /**
+     * 填充颜色
+     */
+    color: ColorData;
+}

package/es/shape/shape-fill-param.js

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

package/es/shape/shape-primitive-type.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 矢量图形类型
+ */
+export declare enum ShapePrimitiveType {
+    /**
+     * 自定义图形
+     */
+    Custom = 0,
+    /**
+     * 矩形
+     */
+    Rectangle = 1,
+    /**
+     * 椭圆
+     */
+    Ellipse = 2,
+    /**
+     * 多边形
+     */
+    Polygon = 3,
+    /**
+     * 星形
+     */
+    Star = 4
+}

package/es/shape/shape-primitive-type.js

@@ -0,0 +1,26 @@
+/**
+ * 矢量图形类型
+ */
+export var ShapePrimitiveType;
+(function (ShapePrimitiveType) {
+    /**
+     * 自定义图形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Custom"] = 0] = "Custom";
+    /**
+     * 矩形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Rectangle"] = 1] = "Rectangle";
+    /**
+     * 椭圆
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Ellipse"] = 2] = "Ellipse";
+    /**
+     * 多边形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Polygon"] = 3] = "Polygon";
+    /**
+     * 星形
+     */
+    ShapePrimitiveType[ShapePrimitiveType["Star"] = 4] = "Star";
+})(ShapePrimitiveType || (ShapePrimitiveType = {}));

package/es/shape/shape-stroke-param.d.ts

@@ -0,0 +1,26 @@
+import type { ColorData } from '../math/color-data';
+export declare enum ShapeConnectType {
+}
+export declare enum ShapePointType {
+}
+/**
+ * 矢量描边参数
+ */
+export interface ShapeStrokeParam {
+    /**
+     * 线宽
+     */
+    width: number;
+    /**
+     * 线颜色
+     */
+    color: ColorData;
+    /**
+     * 连接类型
+     */
+    connectType: ShapeConnectType;
+    /**
+     * 点类型
+     */
+    pointType: ShapePointType;
+}

package/es/shape/shape-stroke-param.js

@@ -0,0 +1,8 @@
+// 本期无该功能 待补充
+export var ShapeConnectType;
+(function (ShapeConnectType) {
+})(ShapeConnectType || (ShapeConnectType = {}));
+// @待补充
+export var ShapePointType;
+(function (ShapePointType) {
+})(ShapePointType || (ShapePointType = {}));