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

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,13 +69,14 @@ export interface TemplateContentV2 extends TemplateContentBase {
  * 纹理贴图属性
  */
 export interface Image {
+    id: string;
     /**
      * 纹理贴图地址
      */
     url: string;
     /**
-     * webp 地址
-     * 如果运行时支持 webp，则尽量使用 webp
+     * WebP 地址
+     * 如果运行时支持 WebP，则优先使用 WebP
      */
     webp?: string;
     /**
@@ -93,8 +91,8 @@ export interface Image {
      */
     mipmap?: boolean;
     /**
-     * 图片Y轴的方向，如果Y轴向上（与OpenGL相同）则为 1
-     * 如果Y轴向下（与OpenGL相反）则为 -1 ，图片再绘制数据模板的时候需要翻转绘制
+     * 图片 Y 轴的方向，如果 Y 轴向上（与 OpenGL 相同）则为 1
+     * 如果 Y 轴向下（与 OpenGL 相反）则为 -1，图片再绘制数据模板的时候需要翻转绘制
      * @default 1
      */
     oriY?: 1 | -1;
@@ -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,11 +15,14 @@ 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 './animation-clip-data';
 export * from './binary';
 export * from './text';
 export * from './components';
 export * from './vfx-item-data';
+export * from './buitin-object-guid';
+export * from './timeline';

package/es/index.js

@@ -0,0 +1,28 @@
+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 './animation-clip-data';
+export * from './binary';
+export * from './text';
+export * from './components';
+export * from './vfx-item-data';
+export * from './buitin-object-guid';
+export * from './timeline';

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

@@ -1,21 +1,40 @@
-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
+/**
+ * 结束行为
+ */
+export declare enum EndBehavior {
+    /**
+     * 销毁
+     */
+    destroy = 0,
+    /**
+     * 重播
+     */
+    restart = 5,
+    /**
+     * 无限播放
+     */
+    forward = 2,
+    /**
+     * 冻结
+     */
+    freeze = 4
 }
 export declare enum ParentItemEndBehavior {
-    destroyChildren
+    destroyChildren = 6
 }
 export interface BaseItem {
     /**
@@ -54,7 +73,7 @@ export interface BaseItem {
      * 元素结束行为
      * @default destroy
      */
-    endBehavior: ItemEndBehavior | ParentItemEndBehavior;
+    endBehavior: EndBehavior | ParentItemEndBehavior;
     /**
      * 元素播放延时（单位秒）
      * @default 0
@@ -123,4 +142,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,27 @@
+import { END_BEHAVIOR_DESTROY, END_BEHAVIOR_DESTROY_CHILDREN, END_BEHAVIOR_FORWARD, END_BEHAVIOR_FREEZE, END_BEHAVIOR_RESTART, } from '../constants';
+/**
+ * 结束行为
+ */
+export var EndBehavior;
+(function (EndBehavior) {
+    /**
+     * 销毁
+     */
+    EndBehavior[EndBehavior["destroy"] = 0] = "destroy";
+    /**
+     * 重播
+     */
+    EndBehavior[EndBehavior["restart"] = 5] = "restart";
+    /**
+     * 无限播放
+     */
+    EndBehavior[EndBehavior["forward"] = 2] = "forward";
+    /**
+     * 冻结
+     */
+    EndBehavior[EndBehavior["freeze"] = 4] = "freeze";
+})(EndBehavior || (EndBehavior = {}));
+export var ParentItemEndBehavior;
+(function (ParentItemEndBehavior) {
+    ParentItemEndBehavior[ParentItemEndBehavior["destroyChildren"] = 6] = "destroyChildren";
+})(ParentItemEndBehavior || (ParentItemEndBehavior = {}));

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

@@ -1,4 +1,4 @@
-import type { BaseItem, ItemEndBehavior } from './base-item';
+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';
@@ -11,7 +11,7 @@ export interface CameraItem extends BaseItem {
      * 相机元素渲染信息
      */
     content: CameraContent;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 export interface CameraContent {
     /**
@@ -35,7 +35,7 @@ export interface CameraContent {
          */
         clipMode?: CameraClipMode;
         /**
-         * 默认不提供，等于canvas width/height
+         * 默认不提供，等于 canvas width/height
          */
         aspect?: number;
     };
@@ -50,15 +50,15 @@ export interface CameraContent {
 }
 export interface CameraPositionOverLifetime {
     /**
-     * x轴位置变化信息
+     * x 轴位置变化信息
      */
     linearX?: FixedNumberExpression;
     /**
-     * y轴位置变化信息
+     * y 轴位置变化信息
      */
     linearY?: FixedNumberExpression;
     /**
-     * z轴位置变化信息
+     * z 轴位置变化信息
      */
     linearZ?: FixedNumberExpression;
     /**

package/es/item/camera-item.js

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

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

@@ -1,4 +1,4 @@
-import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { BaseItem, EndBehavior } from './base-item';
 import type { SizeOverLifetime, RotationOverLifetime, ColorOverLifetime, ItemType } from '../type';
 import type { RGBAColorValue, vec3 } from '../number-expression';
 import type { PositionOverLifetime } from '../type';
@@ -7,14 +7,14 @@ import type { PositionOverLifetime } from '../type';
  */
 export interface CompositionItem extends BaseItem {
     /**
-     * 元素类型[指定为composition]
+     * 元素类型（指定为 composition）
      */
     type: ItemType.composition;
     /**
      * 预合成元素渲染信息
      */
     content: CompositionContent;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 /**
  * 预合成元素
@@ -25,7 +25,7 @@ export interface CompositionContent {
      */
     options: {
         /**
-         * 引用的合成id
+         * 引用的合成 ID
          */
         refId: string;
         /**

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

package/es/item/effect-item.js

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

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

@@ -1,20 +1,20 @@
 import type { InteractBehavior, InteractType, ItemType } from '../type';
 import type { RGBAColor } from '../number-expression';
-import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { BaseItem, EndBehavior } from './base-item';
 import type { ComponentData } from '../components';
 /**
  * 交互元素
  */
 export interface InteractItem extends BaseItem {
     /**
-     * 元素类型[指定为interact]
+     * 元素类型（指定为 interact）
      */
     type: ItemType.interact;
     /**
      * 交互元素渲染信息
      */
     content: InteractContent;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 /**
  * 交互元素渲染属性

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

@@ -1,4 +1,4 @@
-import type { BaseItem, ItemEndBehavior } from '../base-item';
+import type { BaseItem, EndBehavior } from '../base-item';
 import type { CameraClipMode, CameraOptions } from '../../composition';
 import type { RotationOverLifetime, PositionOverLifetime } from '../../type';
 import type { ComponentData } from '../../components';
@@ -30,7 +30,7 @@ export interface ModelCameraItem extends BaseItem {
     type: 'camera';
     pluginName: 'model';
     content: ModelCameraContent;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 export declare enum CameraType {
     orthographic = "orthographic",

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

@@ -1,5 +1,5 @@
 import type { RGBAColorValue } from '../../number-expression';
-import type { BaseItem, ItemEndBehavior } from '../base-item';
+import type { BaseItem, EndBehavior } from '../base-item';
 import type { RotationOverLifetime, PositionOverLifetime, ItemType } from '../../type';
 import type { ColorData, ComponentData } from '../../components';
 export interface ModelLightBaseOptions {
@@ -69,7 +69,7 @@ export interface ModelLightItem extends BaseItem {
     type: ItemType.light;
     pluginName: 'model';
     content: ModelLightContent;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 export declare enum LightType {
     /**

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 = {}));

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

@@ -1,11 +1,11 @@
 import type { BinaryEnv } from '../../binary';
-import type { BaseItem, ItemEndBehavior } from '../base-item';
+import type { BaseItem, EndBehavior } from '../base-item';
 import type { MaterialOptions } from './material';
 import type { GeometryPointer } from './binary';
 import type { vec3 } from '../../number-expression';
 import type { InteractBehavior, ItemType } from '../../type';
 import type { ModelAnimationTrackDataPointer } from './binary';
-import type { ComponentData, DataPath, GeometryData, MaterialData } from '../../components';
+import type { ComponentData, DataPath } 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>;
@@ -66,11 +66,11 @@ export interface ModelMeshItem<T extends BinaryEnv> extends BaseItem {
     type: ItemType.mesh;
     pluginName: 'model';
     content: ModelMeshItemContent<T>;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 export interface PrimitiveData {
-    geometry: GeometryData;
-    material: MaterialData;
+    geometry: DataPath;
+    material: DataPath;
 }
 export interface SkinData {
     name?: string;
@@ -84,13 +84,14 @@ export interface MorphData {
 export interface ModelMeshComponentData extends ComponentData {
     hide?: boolean;
     /**
-     * 蒙皮数据
+     * 骨骼根节点
      */
-    skin?: SkinData;
+    rootBone?: DataPath;
     /**
      * Morph数据
      */
     morph?: MorphData;
-    primitives: PrimitiveData[];
+    geometry: DataPath;
+    materials: DataPath[];
     interaction?: ModelItemBounding;
 }

package/es/item/model/mesh.js

@@ -0,0 +1,5 @@
+export var ModelBoundingType;
+(function (ModelBoundingType) {
+    ModelBoundingType[ModelBoundingType["box"] = 2] = "box";
+    ModelBoundingType[ModelBoundingType["sphere"] = 3] = "sphere";
+})(ModelBoundingType || (ModelBoundingType = {}));

package/es/item/model/render.js

@@ -0,0 +1,42 @@
+/**
+ * 3D渲染模式：将渲染过程中的中间结果输出，主要用于排查渲染效果问题，支持 pbr 和 unlit 材质
+ */
+export var RenderMode3D;
+(function (RenderMode3D) {
+    /**
+     * 正常渲染
+     */
+    RenderMode3D["none"] = "none";
+    /**
+     * 纹理坐标
+     */
+    RenderMode3D["uv"] = "uv";
+    /**
+     * 世界坐标法线
+     */
+    RenderMode3D["normal"] = "normal";
+    /**
+     * 基础颜色
+     */
+    RenderMode3D["basecolor"] = "basecolor";
+    /**
+     * 基础颜色 Alpha
+     */
+    RenderMode3D["alpha"] = "alpha";
+    /**
+     * 金属度
+     */
+    RenderMode3D["metallic"] = "metallic";
+    /**
+     * 粗超度
+     */
+    RenderMode3D["roughness"] = "roughness";
+    /**
+     * 环境遮蔽
+     */
+    RenderMode3D["ao"] = "ao";
+    /**
+     * 自发光
+     */
+    RenderMode3D["emissive"] = "emissive";
+})(RenderMode3D || (RenderMode3D = {}));

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

@@ -1,9 +1,15 @@
-import type { BaseItem, ItemEndBehavior } from '../base-item';
+import type { BaseItem, EndBehavior } from '../base-item';
 import type { BinaryEnv } from '../../binary';
 import type { SkyboxCubeTexturePointer } from './binary';
 import type { ItemType } from '../../type';
-import type { ComponentData, DataPath } from '../../components';
+import type { ComponentData, DataPath, Vector4Data } from '../../components';
 export interface SkyboxOptions<T extends BinaryEnv> {
+    /**
+     * 环境光旋转
+     * UI显示"环境光旋转"
+     * @default { x: 0, y: 0, z: 0, w: 0 }
+     */
+    rotation: Vector4Data;
     renderable: boolean;
     intensity: number;
     reflectionsIntensity: number;
@@ -23,7 +29,7 @@ export interface ModelSkyboxItem<T extends BinaryEnv> extends BaseItem {
     type: ItemType.skybox;
     pluginName: 'model';
     content: SkyboxContent<T>;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 /**
  * 一个 skybox 打包出来：

package/es/item/model/skybox.js

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