@galacean/effects-specification 2.0.0-alpha.9 → 2.0.0-beta.0

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

@@ -1,20 +1,40 @@
+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 {
     /**
@@ -53,7 +73,7 @@ export interface BaseItem {
      * 元素结束行为
      * @default destroy
      */
-    endBehavior: ItemEndBehavior | ParentItemEndBehavior;
+    endBehavior: EndBehavior | ParentItemEndBehavior;
     /**
      * 元素播放延时（单位秒）
      * @default 0
@@ -122,4 +142,4 @@ export interface TransformData {
     size?: Vector2Data;
     anchor?: Vector2Data;
 }
-export type BaseContent = SpriteContent | ParticleContent | NullContent | InteractContent | PluginContent | CompositionContent | CameraContent | 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 {
     /**
@@ -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/{dist/src → es}/item/effect-item.d.ts

@@ -1,12 +1,12 @@
 import type { ItemType, PositionOverLifetime, RotationOverLifetime, SizeOverLifetime } from '../type';
-import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { BaseItem, EndBehavior } from './base-item';
 /**
  * 特效元素
  */
 export interface EffectItem extends BaseItem {
     type: ItemType.effect;
     content: EffectContent;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 /**
  * 特效元素属性

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,5 +1,5 @@
 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';
@@ -66,7 +66,7 @@ export interface ModelMeshItem<T extends BinaryEnv> extends BaseItem {
     type: ItemType.mesh;
     pluginName: 'model';
     content: ModelMeshItemContent<T>;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 export interface PrimitiveData {
     geometry: DataPath;
@@ -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 {};

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

@@ -85,3 +85,13 @@ export interface ModelAnimationComponentData extends ComponentData {
      */
     animations: ModelAnimationData[];
 }
+export interface AnimationComponentData extends ComponentData {
+    /**
+     * 默认动画索引，-1表示不播放动画
+     */
+    animation?: number;
+    /**
+     * glTF中所有的动画数据
+     */
+    animationClips: DataPath[];
+}

package/es/item/model/tree.js

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

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

@@ -0,0 +1,46 @@
+import type { RGBAColorValue } from '../number-expression';
+import type { ColorOverLifetime, ItemType, PositionOverLifetime, RotationOverLifetime, SizeOverLifetime } from '../type';
+import type { BaseItem } from './base-item';
+/**
+ * 空节点元素
+ */
+export interface NullItem extends BaseItem {
+    /**
+     * 元素类型（指定为 null）
+     */
+    type: ItemType.null;
+    /**
+     * 空节点元素渲染信息
+     */
+    content: NullContent;
+}
+/**
+ * 空节点元素渲染属性
+ */
+export interface NullContent {
+    /**
+     * 空节点元素基础属性
+     */
+    options: {
+        /**
+         * 空节点元素基础颜色
+         */
+        startColor?: RGBAColorValue;
+    };
+    /**
+     * 空节点元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 空节点元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 空节点元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 空节点元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+}

package/es/item/null-item.js

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

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

@@ -1,6 +1,6 @@
 import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, SplitParameter } from '../type';
 import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, FixedVec3Expression, ColorExpression, FunctionExpression } from '../number-expression';
-import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { BaseItem, EndBehavior } from './base-item';
 import type { ParticleShape } from './particle-shape';
 import type { ComponentData } from '../components';
 /**
@@ -21,14 +21,14 @@ export declare enum ParticleInteractionBehavior {
  */
 export interface ParticleItem extends BaseItem {
     /**
-     * 元素类型[指定为particle]
+     * 元素类型（指定为 particle）
      */
     type: ItemType.particle;
     /**
      * 粒子元素渲染信息
      */
     content: ParticleContent;
-    endBehavior: ItemEndBehavior;
+    endBehavior: EndBehavior;
 }
 /**
  * 发射器参数
@@ -57,7 +57,7 @@ export interface ParticleEmission {
          */
         cycles?: number;
         /**
-         * 爆发时间间隔，单位秒
+         * 爆发时间间隔（单位：秒）
          * @default 0
          */
         interval?: number;
@@ -71,15 +71,15 @@ export interface ParticleEmission {
          */
         index: number;
         /**
-         * x方向偏移值
+         * x 方向偏移值
          */
         x: number;
         /**
-         * y方向偏移值
+         * y 方向偏移值
          */
         y: number;
         /**
-         * z方向偏移值
+         * z 方向偏移值
          */
         z: number;
     }[];
@@ -90,15 +90,15 @@ export interface ParticlePositionOverLifetime {
      */
     asMovement?: boolean;
     /**
-     * x轴位置变化信息
+     * x 轴位置变化信息
      */
     linearX?: NumberExpression;
     /**
-     * y轴位置变化信息
+     * y 轴位置变化信息
      */
     linearY?: NumberExpression;
     /**
-     * z轴位置变化信息
+     * z 轴位置变化信息
      */
     linearZ?: NumberExpression;
     /**
@@ -106,15 +106,15 @@ export interface ParticlePositionOverLifetime {
      */
     asRotation?: boolean;
     /**
-     * x轴环绕角度变化信息
+     * x 轴环绕角度变化信息
      */
     orbitalX?: NumberExpression;
     /**
-     * y轴环绕角度变化信息
+     * y 轴环绕角度变化信息
      */
     orbitalY?: NumberExpression;
     /**
-     * z轴环绕角度变化信息
+     * z 轴环绕角度变化信息
      */
     orbitalZ?: NumberExpression;
     /**
@@ -137,7 +137,7 @@ export interface ParticlePositionOverLifetime {
      */
     forceCurve?: FunctionExpression;
     /**
-     * 增加一个初速度，匀速直线运动，direction为运动方向
+     * 增加一个初速度，匀速直线运动，direction 为运动方向
      * @default 0
      */
     startSpeed?: NumberExpression;
@@ -146,7 +146,7 @@ export interface ParticlePositionOverLifetime {
      */
     speedOverLifetime?: FixedNumberExpression;
     /**
-     * 增加一个重力，gravity为重力方向，gravityModifier为重力大小
+     * 增加一个重力，gravity 为重力方向，gravityModifier 为重力大小
      * @default 0
      */
     gravity?: vec3;
@@ -165,15 +165,15 @@ export interface ParticleRotationOverLifetime {
      */
     asRotation?: boolean;
     /**
-     * x轴旋转函数
+     * x 轴旋转函数
      */
     x?: NumberExpression;
     /**
-     * y轴旋转函数
+     * y 轴旋转函数
      */
     y?: NumberExpression;
     /**
-     * z轴旋转函数（不分轴时，变化z）
+     * z 轴旋转函数（不分轴时，变化 z）
      */
     z?: NumberExpression;
 }
@@ -187,11 +187,11 @@ export interface ParticleSizeOverLifetime {
      */
     size?: NumberExpression;
     /**
-     * x轴大小变化信息（分轴模式）
+     * x 轴大小变化信息（分轴模式）
      */
     x?: NumberExpression;
     /**
-     * y轴大小变化信息（分轴模式）
+     * y 轴大小变化信息（分轴模式）
      */
     y?: NumberExpression;
 }