@galacean/effects-specification 2.0.0-alpha.1 → 2.0.0-alpha.10

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/{dist/src → es}/binary.d.ts

@@ -19,7 +19,7 @@ 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' | '';
 /**
  * 线上二进制地址
  */

package/es/binary.js

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

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

@@ -0,0 +1,5 @@
+export declare class BuiltinObjectGUID {
+    static readonly WhiteTexture = "whitetexture00000000000000000000";
+    static readonly PBRShader = "pbr00000000000000000000000000000";
+    static readonly UnlitShader = "unlit000000000000000000000000000";
+}

package/es/buitin-object-guid.js

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

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

@@ -24,7 +24,7 @@ export interface DataPath {
 export interface EffectsObjectData {
     id: string;
     name?: string;
-    dataType: string;
+    dataType: DataType;
 }
 export interface ComponentData extends EffectsObjectData {
     item: DataPath;
@@ -43,8 +43,8 @@ export interface Vector4Data {
 }
 export interface MaterialTextureProperty {
     texture: DataPath;
-    offset: Vector2Data;
-    scale: Vector2Data;
+    offset?: Vector2Data;
+    scale?: Vector2Data;
 }
 export interface MaterialData extends EffectsObjectData {
     shader: DataPath;
@@ -52,6 +52,7 @@ export interface MaterialData extends EffectsObjectData {
     zWrite?: boolean;
     zTest?: boolean;
     stringTags: Record<string, string>;
+    macros: string[];
     ints: Record<string, number>;
     floats: Record<string, number>;
     vector4s: Record<string, Vector4Data>;
@@ -62,8 +63,46 @@ export interface GeometryData extends EffectsObjectData {
     vertexData: VertexData;
     indexFormat: number;
     indexOffset: number;
+    /**
+     * 模型绘制模式，默认为 GeometryType.TRIANGLES（三角形）
+     * @default GeometryType.TRIANGLES
+     */
+    mode: GeometryType;
+    /**
+     * 存放 position, uv, normal, indices 的打包数据
+     */
     buffer: string;
 }
+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[];

package/es/components.js

@@ -0,0 +1,52 @@
+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["TextComponent"] = "TextComponent";
+    // FIXME: 先完成ECS的场景转换，后面移到spec中
+    DataType["MeshComponent"] = "MeshComponent";
+    DataType["SkyboxComponent"] = "SkyboxComponent";
+    DataType["LightComponent"] = "LightComponent";
+    DataType["CameraComponent"] = "CameraComponent";
+    DataType["ModelPluginComponent"] = "ModelPluginComponent";
+    DataType["TreeComponent"] = "TreeComponent";
+})(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 = {}));

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

@@ -4,11 +4,11 @@ export declare enum CameraClipMode {
     /**
      * 剪裁上下
      */
-    portrait,
+    portrait = 1,
     /**
      * 剪裁左右
      */
-    landscape
+    landscape = 0
 }
 /**
  * 相机属性
@@ -48,27 +48,27 @@ export declare enum CompositionEndBehavior {
     /**
      * 销毁
      */
-    destroy,
+    destroy = 0,
     /**
      * 暂停
      */
-    pause,
+    pause = 1,
     /**
      * 重播
      */
-    restart,
+    restart = 5,
     /**
      * 无限播放
      */
-    forward,
+    forward = 2,
     /**
      * 销毁并保留最后一帧
      */
-    pause_destroy,
+    pause_destroy = 3,
     /**
      * 冻结
      */
-    freeze
+    freeze = 4
 }
 /**
  * 合成信息

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;

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

@@ -1,12 +1,15 @@
 import type { RenderLevel } from './type';
-import type { StringTemplate } from './text';
 import type { BinaryPointer } from './binary';
+import type { DataType } from './components';
 export interface TextureFormatOptions {
     format?: GLenum;
     internalFormat?: GLenum;
     type?: GLenum;
 }
 export interface TextureConfigOptionsBase {
+    generateMipmap?: boolean;
+    id?: string;
+    dataType?: DataType.Texture;
     name?: string;
     wrapS?: GLenum;
     wrapT?: GLenum;
@@ -41,29 +44,23 @@ export type SerializedTexture2D = SerializedTexture2DImageSource | SerializedTex
 export type SerializedTextureSource = SerializedTexture2D | SerializedTextureCube;
 export type TextureJSONOptions = SerializedTextureSource;
 export type TextureDefine = TextureJSONOptions;
-export interface TemplateContentBase {
-    x?: number;
-    y?: number;
+/**
+ * 动态换图类型
+ * @since 1.1.0
+ */
+export declare enum BackgroundType {
+    video = "video",
+    image = "image"
+}
+export interface TemplateContent {
     variables: Record<string, number | string>;
     /**
-     * 当template宽高和image不相同时，会对template进行缩放，使其和image相同。
+     * 当 template 宽高和 image 不相同时，会对 template 进行缩放，使其和 image 相同。
      */
     width: number;
     height: number;
-}
-export interface TemplateContentV1 extends TemplateContentBase {
-    /**
-     * 贴图属性，svg 字段
-     */
-    content: string;
-    asImage?: boolean;
-    backgroundWidth: number;
-    backgroundHeight: number;
-}
-export interface TemplateContentV2 extends TemplateContentBase {
-    v: 2;
-    content?: StringTemplate;
     background?: {
+        type: BackgroundType;
         name: string;
         url: string;
     };
@@ -72,6 +69,7 @@ export interface TemplateContentV2 extends TemplateContentBase {
  * 纹理贴图属性
  */
 export interface Image {
+    id: string;
     /**
      * 纹理贴图地址
      */
@@ -103,7 +101,7 @@ export interface Image {
  * 模板贴图属性
  */
 export interface TemplateImage extends Image {
-    template: TemplateContentV1 | TemplateContentV2;
+    template: TemplateContent;
 }
 /**
  * 压缩贴图属性
@@ -117,7 +115,3 @@ export interface CompressedImage extends Image {
         pvrtc?: string;
     };
 }
-export interface VideoImage extends Image {
-    type: 'video';
-    loop?: boolean;
-}

package/es/image.js

@@ -0,0 +1,9 @@
+/**
+ * 动态换图类型
+ * @since 1.1.0
+ */
+export var BackgroundType;
+(function (BackgroundType) {
+    BackgroundType["video"] = "video";
+    BackgroundType["image"] = "image";
+})(BackgroundType || (BackgroundType = {}));

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

@@ -1,4 +1,3 @@
-export * from 'uuid/dist/esm-browser/v4';
 export * from './type';
 export * from './composition';
 export * from './image';
@@ -16,10 +15,12 @@ export * from './item/particle-shape';
 export * from './item/plugin-item';
 export * from './item/sprite-item';
 export * from './item/spine-item';
-export * from './item/filter-item';
+export * from './item/effect-item';
 export * from './item/text-item';
 export * from './item/model';
+export * from './vfx-item-data';
 export * from './binary';
 export * from './text';
 export * from './components';
 export * from './vfx-item-data';
+export * from './buitin-object-guid';

package/es/index.js

@@ -0,0 +1,26 @@
+export * from './type';
+export * from './composition';
+export * from './image';
+export * from './constants';
+export * from './number-expression';
+export * from './scene';
+export * from './item';
+export * from './item/base-item';
+export * from './item/camera-item';
+export * from './item/composition-item';
+export * from './item/interact-item';
+export * from './item/null-item';
+export * from './item/particle-item';
+export * from './item/particle-shape';
+export * from './item/plugin-item';
+export * from './item/sprite-item';
+export * from './item/spine-item';
+export * from './item/effect-item';
+export * from './item/text-item';
+export * from './item/model';
+export * from './vfx-item-data';
+export * from './binary';
+export * from './text';
+export * from './components';
+export * from './vfx-item-data';
+export * from './buitin-object-guid';

package/{dist/src → es}/item/base-item.d.ts

@@ -1,21 +1,24 @@
-import type { FilterContent } from './filter-item';
+import type { BinaryEnv } from '../binary';
 import type { vec3, vec4 } from '../number-expression';
 import type { ItemType, RenderLevel } from '../type';
 import type { CameraContent } from './camera-item';
 import type { CompositionContent } from './composition-item';
+import type { EffectContent } from './effect-item';
 import type { InteractContent } from './interact-item';
+import type { ModelLightContent, ModelMeshItemContent, ModelTreeContent, SkyboxContent } from './model';
 import type { NullContent } from './null-item';
 import type { ParticleContent } from './particle-item';
 import type { PluginContent } from './plugin-item';
+import type { SpineContent } from './spine-item';
 import type { SpriteContent } from './sprite-item';
 import type { TextContent } from './text-item';
 export declare enum ItemEndBehavior {
-    destroy,
-    loop,
-    freeze
+    destroy = 0,
+    loop = 5,
+    freeze = 4
 }
 export declare enum ParentItemEndBehavior {
-    destroyChildren
+    destroyChildren = 6
 }
 export interface BaseItem {
     /**
@@ -123,4 +126,4 @@ export interface TransformData {
     size?: Vector2Data;
     anchor?: Vector2Data;
 }
-export type BaseContent = SpriteContent | ParticleContent | NullContent | InteractContent | PluginContent | CompositionContent | CameraContent | FilterContent | TextContent | any;
+export type BaseContent = SpriteContent | ParticleContent | NullContent | InteractContent | PluginContent | CompositionContent | CameraContent | TextContent | SpineContent | EffectContent | ModelTreeContent<BinaryEnv> | ModelMeshItemContent<BinaryEnv> | ModelLightContent | SkyboxContent<BinaryEnv> | any;

package/es/item/base-item.js

@@ -0,0 +1,11 @@
+import { END_BEHAVIOR_DESTROY, END_BEHAVIOR_DESTROY_CHILDREN, END_BEHAVIOR_FREEZE, END_BEHAVIOR_RESTART, } from '../constants';
+export var ItemEndBehavior;
+(function (ItemEndBehavior) {
+    ItemEndBehavior[ItemEndBehavior["destroy"] = 0] = "destroy";
+    ItemEndBehavior[ItemEndBehavior["loop"] = 5] = "loop";
+    ItemEndBehavior[ItemEndBehavior["freeze"] = 4] = "freeze";
+})(ItemEndBehavior || (ItemEndBehavior = {}));
+export var ParentItemEndBehavior;
+(function (ParentItemEndBehavior) {
+    ParentItemEndBehavior[ParentItemEndBehavior["destroyChildren"] = 6] = "destroyChildren";
+})(ParentItemEndBehavior || (ParentItemEndBehavior = {}));

package/{dist/src → es}/item/camera-item.d.ts

@@ -35,7 +35,7 @@ export interface CameraContent {
          */
         clipMode?: CameraClipMode;
         /**
-         * 默认不提供，等于canvas width/height
+         * 默认不提供，等于 canvas width/height
          */
         aspect?: number;
     };

package/es/item/camera-item.js

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

package/es/item/composition-item.js

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

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

@@ -0,0 +1,35 @@
+import type { ItemType, PositionOverLifetime, RotationOverLifetime, SizeOverLifetime } from '../type';
+import type { BaseItem, ItemEndBehavior } from './base-item';
+/**
+ * 特效元素
+ */
+export interface EffectItem extends BaseItem {
+    type: ItemType.effect;
+    content: EffectContent;
+    endBehavior: ItemEndBehavior;
+}
+/**
+ * 特效元素属性
+ */
+export interface EffectContent {
+    /**
+     * 特效元素材质数据索引组
+     */
+    materials: number[];
+    /**
+     * 特效元素几何数据索引
+     */
+    geometry: number;
+    /**
+     * 特效元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 特效元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 特效元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+}

package/es/item/effect-item.js

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

package/es/item/interact-item.js

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

package/es/item/model/binary.js

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

package/{dist/src → es}/item/model/camera.d.ts

@@ -32,25 +32,41 @@ export interface ModelCameraItem extends BaseItem {
     content: ModelCameraContent;
     endBehavior: ItemEndBehavior;
 }
+export declare enum CameraType {
+    orthographic = "orthographic",
+    perspective = "perspective"
+}
 export interface ModelCameraComponentData extends ComponentData {
+    /**
+     * 相机类型，默认是透视相机
+     */
+    type?: CameraType;
     /**
      * 视角属性
      */
-    fov: number;
+    fov?: number;
     /**
      * 相机远平面
      */
-    far: number;
+    far?: number;
     /**
      * 相机近平面
      */
-    near: number;
+    near?: number;
     /**
      * 默认不提供，等于 canvas 的 `width/height`
      */
     aspect?: number;
+    /**
+     * x轴上范围（正交相机）
+     */
+    xmag?: number;
+    /**
+     * y轴上范围（正交相机）
+     */
+    ymag?: number;
     /**
      * 相机剪裁模式
      */
-    clipMode: CameraClipMode;
+    clipMode?: CameraClipMode;
 }

package/es/item/model/camera.js

@@ -0,0 +1,5 @@
+export var CameraType;
+(function (CameraType) {
+    CameraType["orthographic"] = "orthographic";
+    CameraType["perspective"] = "perspective";
+})(CameraType || (CameraType = {}));

package/es/item/model/index.js

@@ -0,0 +1,35 @@
+export * from './skybox';
+export * from './light';
+export * from './mesh';
+export * from './tree';
+export * from './camera';
+export * from './material';
+export * from './binary';
+export * from './render';
+/***
+ * 一个 meshItem 打包出来的 json 案例：
+ *
+ * {
+ *   type:'mesh',
+ *   pluginName:'model',
+ *   content:{
+ *     options:{
+ *       skins:{},
+ *       primitives:[
+ *         {
+ *           material:{
+ *           baseColorFactor:[0,0.5,1,1],
+ *           baseColorTexture: {
+ *              magFilter:33071,
+ *              imageFileId:[0,556,1342]
+ *            }
+ *           },
+ *           geometry:[0,0,556]
+ *         }
+ *       ]
+ *     }
+ *
+ *   }
+ * }
+ * bins:[{url:'https://to/some/bin'}]
+ */

package/es/item/model/light.js

@@ -0,0 +1,19 @@
+export var LightType;
+(function (LightType) {
+    /**
+     * 点光源
+     */
+    LightType["point"] = "point";
+    /**
+     * 聚光灯
+     */
+    LightType["spot"] = "spot";
+    /**
+     * 方向光
+     */
+    LightType["directional"] = "directional";
+    /**
+     * 环境光
+     */
+    LightType["ambient"] = "ambient";
+})(LightType || (LightType = {}));

package/{dist/src → es}/item/model/material.d.ts

@@ -13,9 +13,9 @@ export declare enum MaterialType {
     hair = "hair"
 }
 export declare enum MaterialBlending {
-    opaque = 100,
-    masked = 101,
-    translucent = 102,
+    opaque = 100,// 不透明
+    masked = 101,// 遮罩
+    translucent = 102,// 半透明
     additive = 103
 }
 export type MaterialOptions<T extends BinaryEnv> = MaterialUnlitOptions<T> | MaterialPBROptions<T>;

package/es/item/model/material.js

@@ -0,0 +1,16 @@
+// 材质类型
+export var MaterialType;
+(function (MaterialType) {
+    MaterialType["unlit"] = "unlit";
+    MaterialType["pbr"] = "pbr";
+    // 头发材质，在 pbr 材质基础上扩展
+    MaterialType["hair"] = "hair";
+})(MaterialType || (MaterialType = {}));
+// 混合模式
+export var MaterialBlending;
+(function (MaterialBlending) {
+    MaterialBlending[MaterialBlending["opaque"] = 100] = "opaque";
+    MaterialBlending[MaterialBlending["masked"] = 101] = "masked";
+    MaterialBlending[MaterialBlending["translucent"] = 102] = "translucent";
+    MaterialBlending[MaterialBlending["additive"] = 103] = "additive";
+})(MaterialBlending || (MaterialBlending = {}));