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

package/README.md

@@ -8,15 +8,7 @@
 
 ``` bash
 # 1. Install dependencies (first time)
-npm install
+pnpm install
 # 2. Build
-npm run build
+pnpm run build
 ```
-
-## Testing
-
-``` bash
-npm run test
-```
-
-> Open browser and open: http://localhost:9003/test/

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

@@ -0,0 +1,26 @@
+import type { EffectsObjectData } from './components';
+import type { FixedNumberExpression, FixedVec3Expression, FixedQuatExpression } from './number-expression';
+export interface AnimationClipData extends EffectsObjectData {
+    positionCurves: PositionCurveData[];
+    rotationCurves: RotationCurveData[];
+    scaleCurves: ScaleCurveData[];
+    floatCurves: FloatCurveData[];
+}
+export interface PositionCurveData {
+    path: string;
+    keyFrames: FixedVec3Expression;
+}
+export interface RotationCurveData {
+    path: string;
+    keyFrames: FixedQuatExpression;
+}
+export interface ScaleCurveData {
+    path: string;
+    keyFrames: FixedVec3Expression;
+}
+export interface FloatCurveData {
+    path: string;
+    property: string;
+    className: string;
+    keyFrames: FixedNumberExpression;
+}

package/es/animation-clip-data.js

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

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

@@ -1,3 +1,4 @@
+import type { DataType } from './components';
 import type { RenderLevel } from './type';
 import type { ValueType } from './number-expression';
 /**
@@ -19,12 +20,13 @@ import type { ValueType } from './number-expression';
  */
 export type BinaryPointerContent = [index: number, start?: number, byteLength?: number, type?: BinaryType];
 export type BinaryPointer = [ValueType.BINARY, BinaryPointerContent];
-export type BinaryType = 'u8' | 'i8' | 'i16' | 'u16' | 'f32' | 'u32' | 'i32' | 'f64' | string;
+export type BinaryType = 'u8' | 'i8' | 'i16' | 'u16' | 'f32' | 'u32' | 'i32' | 'f64' | '';
 /**
  * 线上二进制地址
  */
 export interface BinaryFile {
     url: string;
+    dataType: DataType.BinaryAsset;
     renderLevel?: RenderLevel;
 }
 export type BinaryEnv = 'studio' | 'runtime' | 'json';

package/es/binary.js

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

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

@@ -0,0 +1,5 @@
+export declare const BuiltinObjectGUID: {
+    WhiteTexture: string;
+    PBRShader: string;
+    UnlitShader: string;
+};

package/es/buitin-object-guid.js

@@ -0,0 +1,5 @@
+export const BuiltinObjectGUID = {
+    WhiteTexture: 'whitetexture00000000000000000000',
+    PBRShader: 'pbr00000000000000000000000000000',
+    UnlitShader: 'unlit000000000000000000000000000',
+};

package/es/components.d.ts

@@ -0,0 +1,204 @@
+import type { Vector2Data } from './item/base-item';
+export declare enum DataType {
+    VFXItemData = "VFXItemData",
+    EffectComponent = "EffectComponent",
+    Material = "Material",
+    Shader = "Shader",
+    SpriteComponent = "SpriteComponent",
+    ParticleSystem = "ParticleSystem",
+    InteractComponent = "InteractComponent",
+    CameraController = "CameraController",
+    Geometry = "Geometry",
+    Texture = "Texture",
+    AnimationClip = "AnimationClip",
+    TextComponent = "TextComponent",
+    BinaryAsset = "BinaryAsset",
+    TrackAsset = "TrackAsset",
+    TimelineAsset = "TimelineAsset",
+    ObjectBindingTrack = "ObjectBindingTrack",
+    TransformTrack = "TransformTrack",
+    SpriteColorTrack = "SpriteColorTrack",
+    ActivationTrack = "ActivationTrack",
+    SubCompositionTrack = "SubCompositionTrack",
+    TransformPlayableAsset = "TransformPlayableAsset",
+    SpriteColorPlayableAsset = "SpriteColorPlayableAsset",
+    ActivationPlayableAsset = "ActivationPlayableAsset",
+    SubCompositionPlayableAsset = "SubCompositionPlayableAsset",
+    MeshComponent = "MeshComponent",
+    SkyboxComponent = "SkyboxComponent",
+    LightComponent = "LightComponent",
+    CameraComponent = "CameraComponent",
+    ModelPluginComponent = "ModelPluginComponent",
+    TreeComponent = "TreeComponent",
+    AnimationComponent = "AnimationComponent",
+    SpineComponent = "SpineComponent",
+    TimelineClip = "TimelineClip"
+}
+export interface DataPath {
+    id: string;
+}
+export interface EffectsObjectData {
+    id: string;
+    name?: string;
+    dataType: DataType;
+}
+export interface ComponentData extends EffectsObjectData {
+    item: DataPath;
+}
+export interface ColorData {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export interface Vector4Data {
+    x: number;
+    y: number;
+    z: number;
+    w: number;
+}
+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>;
+}
+export interface GeometryData extends EffectsObjectData {
+    vertexData: VertexData;
+    indexFormat: IndexFormatType;
+    indexOffset: number;
+    subMeshes: SubMesh[];
+    /**
+     * 模型绘制模式，默认为 GeometryType.TRIANGLES（三角形）
+     * @default GeometryType.TRIANGLES
+     */
+    mode: GeometryType;
+    /**
+     * 存放 position, uv, normal, indices 的打包数据
+     */
+    buffer: string;
+    /**
+     * 所有的骨骼名称
+     */
+    boneNames?: string[];
+    rootBoneName?: string;
+    inverseBindMatrices?: number[];
+}
+export interface SubMesh {
+    offset: number;
+    indexCount?: number;
+    vertexCount: number;
+}
+export declare enum GeometryType {
+    /**
+     * Draw single points.
+     */
+    POINTS = 0,
+    /**
+     * Draw lines. Each vertex connects to the one after it.
+     */
+    LINES = 1,
+    /**
+     * Draw lines. Each set of two vertices is treated as a separate line segment.
+     */
+    LINE_LOOP = 2,
+    /**
+     * Draw a connected group of line segments from the first vertex to the last.
+     */
+    LINE_STRIP = 3,
+    /**
+     * Draw triangles. Each set of three vertices creates a separate triangle.
+     */
+    TRIANGLES = 4,
+    /**
+     * Draw a connected strip of triangles.
+     */
+    TRIANGLE_STRIP = 5,
+    /**
+     * Draw a connected group of triangles. Each vertex connects to the previous and the first vertex in the fan.
+     */
+    TRIANGLE_FAN = 6
+}
+export interface VertexData {
+    vertexCount: number;
+    channels: VertexChannel[];
+}
+export declare enum VertexFormatType {
+    Float16 = 0,
+    Float32 = 1,
+    Int8 = 2,
+    Int16 = 3,
+    Int32 = 4,
+    UInt8 = 5,
+    UInt16 = 6,
+    UInt32 = 7
+}
+export declare enum IndexFormatType {
+    None = -1,
+    UInt8 = 0,
+    UInt16 = 1,
+    UInt32 = 2
+}
+export interface VertexChannel {
+    semantic: string;
+    offset: number;
+    format: VertexFormatType;
+    dimension: number;
+    normalize?: boolean;
+}
+export declare enum VertexBufferSemantic {
+    Position = "POSITION",
+    Uv = "TEXCOORD0",
+    Uv2 = "TEXCOORD1",
+    Normal = "NORMAL",
+    Tangent = "TANGENT",
+    Color = "COLOR",
+    Joints = "JOINTS",
+    Weights = "WEIGHTS",
+    PositionBS0 = "POSITION_BS0",
+    PositionBS1 = "POSITION_BS1",
+    PositionBS2 = "POSITION_BS2",
+    PositionBS3 = "POSITION_BS3",
+    PositionBS4 = "POSITION_BS4",
+    PositionBS5 = "POSITION_BS5",
+    PositionBS6 = "POSITION_BS6",
+    PositionBS7 = "POSITION_BS7",
+    NormalBS0 = "NORMAL_BS0",
+    NormalBS1 = "NORMAL_BS1",
+    NormalBS2 = "NORMAL_BS2",
+    NormalBS3 = "NORMAL_BS3",
+    TangentBS0 = "TANGENT_BS0",
+    TangentBS1 = "TANGENT_BS1",
+    TangentBS2 = "TANGENT_BS2",
+    TangentBS3 = "TANGENT_BS3"
+}
+export interface ShaderData extends EffectsObjectData {
+    vertex: string;
+    fragment: string;
+    properties?: string;
+}
+export interface EffectComponentData extends ComponentData {
+    _priority: number;
+    materials: DataPath[];
+    geometry: DataPath;
+}
+export interface EffectsPackageData {
+    fileSummary: FileSummary;
+    exportObjects: EffectsObjectData[];
+}
+export interface FileSummary {
+    guid: string;
+    assetType: string;
+}

package/es/components.js

@@ -0,0 +1,129 @@
+export var DataType;
+(function (DataType) {
+    DataType["VFXItemData"] = "VFXItemData";
+    DataType["EffectComponent"] = "EffectComponent";
+    DataType["Material"] = "Material";
+    DataType["Shader"] = "Shader";
+    DataType["SpriteComponent"] = "SpriteComponent";
+    DataType["ParticleSystem"] = "ParticleSystem";
+    DataType["InteractComponent"] = "InteractComponent";
+    DataType["CameraController"] = "CameraController";
+    DataType["Geometry"] = "Geometry";
+    DataType["Texture"] = "Texture";
+    DataType["AnimationClip"] = "AnimationClip";
+    DataType["TextComponent"] = "TextComponent";
+    DataType["BinaryAsset"] = "BinaryAsset";
+    // Timeline
+    DataType["TrackAsset"] = "TrackAsset";
+    DataType["TimelineAsset"] = "TimelineAsset";
+    DataType["ObjectBindingTrack"] = "ObjectBindingTrack";
+    DataType["TransformTrack"] = "TransformTrack";
+    DataType["SpriteColorTrack"] = "SpriteColorTrack";
+    DataType["ActivationTrack"] = "ActivationTrack";
+    DataType["SubCompositionTrack"] = "SubCompositionTrack";
+    DataType["TransformPlayableAsset"] = "TransformPlayableAsset";
+    DataType["SpriteColorPlayableAsset"] = "SpriteColorPlayableAsset";
+    DataType["ActivationPlayableAsset"] = "ActivationPlayableAsset";
+    DataType["SubCompositionPlayableAsset"] = "SubCompositionPlayableAsset";
+    // FIXME: 先完成ECS的场景转换，后面移到spec中
+    DataType["MeshComponent"] = "MeshComponent";
+    DataType["SkyboxComponent"] = "SkyboxComponent";
+    DataType["LightComponent"] = "LightComponent";
+    DataType["CameraComponent"] = "CameraComponent";
+    DataType["ModelPluginComponent"] = "ModelPluginComponent";
+    DataType["TreeComponent"] = "TreeComponent";
+    DataType["AnimationComponent"] = "AnimationComponent";
+    DataType["SpineComponent"] = "SpineComponent";
+    // Non-EffectObject
+    DataType["TimelineClip"] = "TimelineClip";
+})(DataType || (DataType = {}));
+export var GeometryType;
+(function (GeometryType) {
+    /**
+     * Draw single points.
+     */
+    GeometryType[GeometryType["POINTS"] = 0] = "POINTS";
+    /**
+     * Draw lines. Each vertex connects to the one after it.
+     */
+    GeometryType[GeometryType["LINES"] = 1] = "LINES";
+    /**
+     * Draw lines. Each set of two vertices is treated as a separate line segment.
+     */
+    GeometryType[GeometryType["LINE_LOOP"] = 2] = "LINE_LOOP";
+    /**
+     * Draw a connected group of line segments from the first vertex to the last.
+     */
+    GeometryType[GeometryType["LINE_STRIP"] = 3] = "LINE_STRIP";
+    /**
+     * Draw triangles. Each set of three vertices creates a separate triangle.
+     */
+    GeometryType[GeometryType["TRIANGLES"] = 4] = "TRIANGLES";
+    /**
+     * Draw a connected strip of triangles.
+     */
+    GeometryType[GeometryType["TRIANGLE_STRIP"] = 5] = "TRIANGLE_STRIP";
+    /**
+     * Draw a connected group of triangles. Each vertex connects to the previous and the first vertex in the fan.
+     */
+    GeometryType[GeometryType["TRIANGLE_FAN"] = 6] = "TRIANGLE_FAN";
+})(GeometryType || (GeometryType = {}));
+export var VertexFormatType;
+(function (VertexFormatType) {
+    VertexFormatType[VertexFormatType["Float16"] = 0] = "Float16";
+    VertexFormatType[VertexFormatType["Float32"] = 1] = "Float32";
+    VertexFormatType[VertexFormatType["Int8"] = 2] = "Int8";
+    VertexFormatType[VertexFormatType["Int16"] = 3] = "Int16";
+    VertexFormatType[VertexFormatType["Int32"] = 4] = "Int32";
+    VertexFormatType[VertexFormatType["UInt8"] = 5] = "UInt8";
+    VertexFormatType[VertexFormatType["UInt16"] = 6] = "UInt16";
+    VertexFormatType[VertexFormatType["UInt32"] = 7] = "UInt32";
+})(VertexFormatType || (VertexFormatType = {}));
+export var IndexFormatType;
+(function (IndexFormatType) {
+    IndexFormatType[IndexFormatType["None"] = -1] = "None";
+    IndexFormatType[IndexFormatType["UInt8"] = 0] = "UInt8";
+    IndexFormatType[IndexFormatType["UInt16"] = 1] = "UInt16";
+    IndexFormatType[IndexFormatType["UInt32"] = 2] = "UInt32";
+})(IndexFormatType || (IndexFormatType = {}));
+// BINORMAL[n]	Binormal	float4
+// BLENDINDICES[n]	混合索引	uint
+// BLENDWEIGHT[n]	混合权重	FLOAT
+// COLOR[n]	漫射和反射颜色	float4
+// NORMAL[n]	法向矢量	float4
+// POSITION[n]	对象空间中的顶点位置。	float4
+// POSITIONT	变换的顶点位置。	float4
+// PSIZE[n]	点大小	FLOAT
+// TANGENT[n]	正切	float4
+// TEXCOORD[n]	纹理坐标	float4
+// POSITION_BS[n]	Blend Shape 空间中的顶点位置	float4
+// NORMAL_BS[n]	Blend Shape 空间中的法向矢量	float4
+// TANGENT_BS[n]	Blend Shape 空间中的正切矢量	float4
+export var VertexBufferSemantic;
+(function (VertexBufferSemantic) {
+    VertexBufferSemantic["Position"] = "POSITION";
+    VertexBufferSemantic["Uv"] = "TEXCOORD0";
+    VertexBufferSemantic["Uv2"] = "TEXCOORD1";
+    VertexBufferSemantic["Normal"] = "NORMAL";
+    VertexBufferSemantic["Tangent"] = "TANGENT";
+    VertexBufferSemantic["Color"] = "COLOR";
+    VertexBufferSemantic["Joints"] = "JOINTS";
+    VertexBufferSemantic["Weights"] = "WEIGHTS";
+    //
+    VertexBufferSemantic["PositionBS0"] = "POSITION_BS0";
+    VertexBufferSemantic["PositionBS1"] = "POSITION_BS1";
+    VertexBufferSemantic["PositionBS2"] = "POSITION_BS2";
+    VertexBufferSemantic["PositionBS3"] = "POSITION_BS3";
+    VertexBufferSemantic["PositionBS4"] = "POSITION_BS4";
+    VertexBufferSemantic["PositionBS5"] = "POSITION_BS5";
+    VertexBufferSemantic["PositionBS6"] = "POSITION_BS6";
+    VertexBufferSemantic["PositionBS7"] = "POSITION_BS7";
+    VertexBufferSemantic["NormalBS0"] = "NORMAL_BS0";
+    VertexBufferSemantic["NormalBS1"] = "NORMAL_BS1";
+    VertexBufferSemantic["NormalBS2"] = "NORMAL_BS2";
+    VertexBufferSemantic["NormalBS3"] = "NORMAL_BS3";
+    VertexBufferSemantic["TangentBS0"] = "TANGENT_BS0";
+    VertexBufferSemantic["TangentBS1"] = "TANGENT_BS1";
+    VertexBufferSemantic["TangentBS2"] = "TANGENT_BS2";
+    VertexBufferSemantic["TangentBS3"] = "TANGENT_BS3";
+})(VertexBufferSemantic || (VertexBufferSemantic = {}));

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

@@ -1,14 +1,14 @@
-import type { Item } from './item';
 import type { DataPath } from './components';
+import type { Item } from './item';
 export declare enum CameraClipMode {
     /**
      * 剪裁上下
      */
-    portrait,
+    portrait = 1,
     /**
      * 剪裁左右
      */
-    landscape
+    landscape = 0
 }
 /**
  * 相机属性
@@ -48,32 +48,29 @@ export declare enum CompositionEndBehavior {
     /**
      * 销毁
      */
-    destroy,
+    destroy = 0,
     /**
      * 暂停
      */
-    pause,
+    pause = 1,
     /**
      * 重播
      */
-    restart,
+    restart = 5,
     /**
      * 无限播放
      */
-    forward,
+    forward = 2,
     /**
      * 销毁并保留最后一帧
      */
-    pause_destroy,
+    pause_destroy = 3,
     /**
      * 冻结
      */
-    freeze
+    freeze = 4
 }
-/**
- * 合成信息
- */
-export interface Composition {
+interface CompositionBase {
     /**
      * 合成ID
      */
@@ -99,10 +96,6 @@ export interface Composition {
      * 合成相机信息
      */
     camera: CameraOptions;
-    /**
-     * 元素信息
-     */
-    items: Item[];
     /**
      * 合成视窗预览大小
      * 如果没有提供，默认为 player 的 container 大小
@@ -115,46 +108,39 @@ export interface Composition {
     fallbackImage?: string;
 }
 /**
- * 合成数据
+ * 合成信息
  */
-export interface CompositionData {
-    /**
-     * 合成ID
-     */
-    id: string;
-    /**
-     * 合成名称
-     */
-    name: string;
-    /**
-     * 合成持续时间
-     */
-    duration: number;
+export interface Composition extends CompositionBase {
     /**
-     * 合成开始播放的时间，单位妙
-     * @default 0
+     * 元素信息
      */
-    startTime?: number;
+    items: Item[];
+}
+/**
+ * 合成数据
+ */
+export interface CompositionData extends CompositionBase {
     /**
-     * 合成结束行为
+     * 元素信息
      */
-    endBehavior: CompositionEndBehavior;
+    items: DataPath[];
     /**
-     * 合成相机信息
+     * 时间轴资产（TimelineAssetData）
      */
-    camera: CameraOptions;
+    timelineAsset: DataPath;
     /**
-     * 元素信息
+     * 轨道的场景绑定
      */
-    items: DataPath[];
+    sceneBindings: SceneBindingData[];
+}
+export interface SceneBindingData {
     /**
-     * 合成视窗预览大小
-     * 如果没有提供，默认为 player 的 container 大小
-     * @default [0,0]
+     * 绑定的轨道资产（TrackAssetData）
      */
-    previewSize?: [width: number, height: number];
+    key: DataPath;
     /**
-     * 降级图
+     * 被绑定的场景对象（VFXItemData）
      */
-    fallbackImage?: string;
+    value: DataPath;
 }
+export {};

package/es/composition.js

@@ -0,0 +1,42 @@
+import { CAMERA_CLIP_MODE_NORMAL, CAMERA_CLIP_MODE_VERTICAL, END_BEHAVIOR_DESTROY, END_BEHAVIOR_FORWARD, END_BEHAVIOR_FREEZE, END_BEHAVIOR_PAUSE, END_BEHAVIOR_PAUSE_AND_DESTROY, END_BEHAVIOR_RESTART, } from './constants';
+export var CameraClipMode;
+(function (CameraClipMode) {
+    /**
+     * 剪裁上下
+     */
+    CameraClipMode[CameraClipMode["portrait"] = 1] = "portrait";
+    /**
+     * 剪裁左右
+     */
+    CameraClipMode[CameraClipMode["landscape"] = 0] = "landscape";
+})(CameraClipMode || (CameraClipMode = {}));
+/**
+ * 结束行为
+ */
+export var CompositionEndBehavior;
+(function (CompositionEndBehavior) {
+    /**
+     * 销毁
+     */
+    CompositionEndBehavior[CompositionEndBehavior["destroy"] = 0] = "destroy";
+    /**
+     * 暂停
+     */
+    CompositionEndBehavior[CompositionEndBehavior["pause"] = 1] = "pause";
+    /**
+     * 重播
+     */
+    CompositionEndBehavior[CompositionEndBehavior["restart"] = 5] = "restart";
+    /**
+     * 无限播放
+     */
+    CompositionEndBehavior[CompositionEndBehavior["forward"] = 2] = "forward";
+    /**
+     * 销毁并保留最后一帧
+     */
+    CompositionEndBehavior[CompositionEndBehavior["pause_destroy"] = 3] = "pause_destroy";
+    /**
+     * 冻结
+     */
+    CompositionEndBehavior[CompositionEndBehavior["freeze"] = 4] = "freeze";
+})(CompositionEndBehavior || (CompositionEndBehavior = {}));

package/es/constants.js

@@ -0,0 +1,11 @@
+export const END_BEHAVIOR_DESTROY = 0;
+export const END_BEHAVIOR_PAUSE = 1;
+export const END_BEHAVIOR_FORWARD = 2;
+export const END_BEHAVIOR_PAUSE_AND_DESTROY = 3;
+export const END_BEHAVIOR_FREEZE = 4;
+export const END_BEHAVIOR_RESTART = 5;
+export const END_BEHAVIOR_DESTROY_CHILDREN = 6;
+export const CAMERA_CLIP_MODE_VERTICAL = 1;
+export const CAMERA_CLIP_MODE_NORMAL = 0;
+export const MESSAGE_ITEM_PHRASE_BEGIN = 2;
+export const MESSAGE_ITEM_PHRASE_END = 1;