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

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

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

@@ -5,7 +5,7 @@ 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>;
@@ -69,8 +69,8 @@ export interface ModelMeshItem<T extends BinaryEnv> extends BaseItem {
     endBehavior: ItemEndBehavior;
 }
 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/es/item/model/skybox.js

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

package/es/item/model/tree.js

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

package/es/item/null-item.js

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

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

@@ -2,7 +2,6 @@ import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, Sp
 import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, FixedVec3Expression, ColorExpression, FunctionExpression } from '../number-expression';
 import type { BaseItem, ItemEndBehavior } from './base-item';
 import type { ParticleShape } from './particle-shape';
-import type { DistortionFilterParams } from './filter-item';
 import type { ComponentData } from '../components';
 /**
  * 粒子交互行为
@@ -334,7 +333,6 @@ export interface ParticleContent {
          */
         radius?: number;
     };
-    filter?: DistortionFilterParams;
 }
 /**
  * 粒子元素渲染属性
@@ -405,7 +403,6 @@ export interface ParticleSystemData extends ComponentData {
          */
         radius?: number;
     };
-    filter?: DistortionFilterParams;
 }
 /**
  * 粒子拖尾参数

package/es/item/particle-item.js

@@ -0,0 +1,14 @@
+/**
+ * 粒子交互行为
+ */
+export var ParticleInteractionBehavior;
+(function (ParticleInteractionBehavior) {
+    /**
+     * 无
+     */
+    ParticleInteractionBehavior[ParticleInteractionBehavior["none"] = 0] = "none";
+    /**
+     * 移出粒子
+     */
+    ParticleInteractionBehavior[ParticleInteractionBehavior["removeParticle"] = 1] = "removeParticle";
+})(ParticleInteractionBehavior || (ParticleInteractionBehavior = {}));

package/es/item/particle-shape.js

@@ -0,0 +1,19 @@
+export var ShapeArcMode;
+(function (ShapeArcMode) {
+    /**
+     * 随机
+     */
+    ShapeArcMode[ShapeArcMode["RANDOM"] = 0] = "RANDOM";
+    /**
+     * 单向循环
+     */
+    ShapeArcMode[ShapeArcMode["UNIDIRECTIONAL_CYCLE"] = 1] = "UNIDIRECTIONAL_CYCLE";
+    /**
+     * 双向循环
+     */
+    ShapeArcMode[ShapeArcMode["BIDIRECTIONAL_CYCLE"] = 2] = "BIDIRECTIONAL_CYCLE";
+    /**
+     * 均匀爆发
+     */
+    ShapeArcMode[ShapeArcMode["UNIFORM_BURST"] = 3] = "UNIFORM_BURST";
+})(ShapeArcMode || (ShapeArcMode = {}));

package/es/item/plugin-item.js

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

package/es/item/spine-item.js

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

package/es/item/sprite-item.js

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

package/es/item/text-item.js

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

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

@@ -5,7 +5,6 @@ import type { PluginItem } from './item/plugin-item';
 import type { ParticleItem } from './item/particle-item';
 import type { InteractItem } from './item/interact-item';
 import type { ModelCameraItem, ModelLightItem, ModelMeshItem, ModelSkyboxItem, ModelTreeItem } from './item/model';
-import type { FilterItem } from './item/filter-item';
 import type { CameraItem } from './item/camera-item';
 import type { CompositionItem } from './item/composition-item';
 import type { TextItem } from './item/text-item';
@@ -14,4 +13,4 @@ import type { TextItem } from './item/text-item';
  * 1.0版本
  * 基类，无对应元素
  */
-export type Item = SpriteItem | ParticleItem | NullItem | PluginItem | InteractItem | FilterItem | 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 | ModelMeshItem<'json'> | ModelSkyboxItem<'json'> | ModelTreeItem<'json'> | ModelLightItem | ModelCameraItem | SpineItem | CompositionItem | ModelMeshItem<'studio'> | ModelSkyboxItem<'studio'> | ModelTreeItem<'studio'>;

package/es/item.js

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

package/{dist/src → es}/number-expression.d.ts

@@ -150,12 +150,12 @@ export type LinearPathValue = [
  * 关键帧类型
  */
 export declare enum BezierKeyframeType {
-    AUTO = 0,
-    EASE = 1,
-    EASE_IN = 2,
-    EASE_OUT = 3,
-    LINE = 4,
-    HOLD = 5,
+    AUTO = 0,// 自动
+    EASE = 1,// 缓动
+    EASE_IN = 2,// 缓入
+    EASE_OUT = 3,// 缓出
+    LINE = 4,// 线性 （默认进）
+    HOLD = 5,// 定格
     LINE_OUT = 6
 }
 /**

package/es/number-expression.js

@@ -0,0 +1,87 @@
+/*********************************************/
+/*               基本数值属性参数              */
+/*********************************************/
+export var ValueType;
+(function (ValueType) {
+    /**
+     * 常数
+     */
+    ValueType[ValueType["CONSTANT"] = 0] = "CONSTANT";
+    /**
+     * 二维常数向量
+     */
+    ValueType[ValueType["CONSTANT_VEC2"] = 1] = "CONSTANT_VEC2";
+    /**
+     * 三维常数向量
+     */
+    ValueType[ValueType["CONSTANT_VEC3"] = 2] = "CONSTANT_VEC3";
+    /**
+     * 四维常数向量
+     */
+    ValueType[ValueType["CONSTANT_VEC4"] = 3] = "CONSTANT_VEC4";
+    /**
+     * 随机数
+     */
+    ValueType[ValueType["RANDOM"] = 4] = "RANDOM";
+    /**
+     * 直线
+     */
+    ValueType[ValueType["LINE"] = 5] = "LINE";
+    /**
+     * 曲线
+     */
+    ValueType[ValueType["CURVE"] = 6] = "CURVE";
+    /**
+     * 贝塞尔路径
+     */
+    ValueType[ValueType["BEZIER_PATH"] = 7] = "BEZIER_PATH";
+    /**
+     * 颜色
+     */
+    ValueType[ValueType["RGBA_COLOR"] = 8] = "RGBA_COLOR";
+    /**
+     * 渐变色
+     */
+    ValueType[ValueType["GRADIENT_COLOR"] = 9] = "GRADIENT_COLOR";
+    /**
+     * 蒙版形状点集
+     */
+    ValueType[ValueType["SHAPE_POINTS"] = 10] = "SHAPE_POINTS";
+    /**
+     * 蒙版形状切分
+     */
+    ValueType[ValueType["SHAPE_SPLITS"] = 11] = "SHAPE_SPLITS";
+    /**
+     *直线路径
+     */
+    ValueType[ValueType["LINEAR_PATH"] = 12] = "LINEAR_PATH";
+    /**
+     * 多色
+     */
+    ValueType[ValueType["COLORS"] = 13] = "COLORS";
+    /**
+     * 二进制指针
+     */
+    ValueType[ValueType["BINARY"] = 20] = "BINARY";
+    /**
+     * 贝塞尔曲线
+     */
+    ValueType[ValueType["BEZIER_CURVE"] = 21] = "BEZIER_CURVE";
+    /**
+     * 贝塞尔曲线路径
+     */
+    ValueType[ValueType["BEZIER_CURVE_PATH"] = 22] = "BEZIER_CURVE_PATH";
+})(ValueType || (ValueType = {}));
+/**
+ * 关键帧类型
+ */
+export var BezierKeyframeType;
+(function (BezierKeyframeType) {
+    BezierKeyframeType[BezierKeyframeType["AUTO"] = 0] = "AUTO";
+    BezierKeyframeType[BezierKeyframeType["EASE"] = 1] = "EASE";
+    BezierKeyframeType[BezierKeyframeType["EASE_IN"] = 2] = "EASE_IN";
+    BezierKeyframeType[BezierKeyframeType["EASE_OUT"] = 3] = "EASE_OUT";
+    BezierKeyframeType[BezierKeyframeType["LINE"] = 4] = "LINE";
+    BezierKeyframeType[BezierKeyframeType["HOLD"] = 5] = "HOLD";
+    BezierKeyframeType[BezierKeyframeType["LINE_OUT"] = 6] = "LINE_OUT";
+})(BezierKeyframeType || (BezierKeyframeType = {}));

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

@@ -23,8 +23,10 @@ export interface JSONSceneLegacy {
      * 2.0 改造升级
      * 2.1 增加文本元素
      * 2.2 数据类型兼容
+     * 2.3 新增动态视频、陀螺仪支持旋转
+     * 2.4 支持贝塞尔曲线
      */
-    version: '1.0' | '1.1' | '1.2' | '1.3' | '1.5' | '1.8' | '2.0' | '2.1' | '2.2';
+    version: '1.0' | '1.1' | '1.2' | '1.3' | '1.5' | '1.8' | '2.0' | '2.1' | '2.2' | '2.3' | '2.4';
     /**
      * 播放器版本信息
      */
@@ -103,7 +105,7 @@ export interface JSONScene {
     /**
      * JSON 版本
      *
-     * 3.0 EC 改造
+     * 3.0 EC 改造、移除滤镜元素
      */
     version: string;
     /**
@@ -146,10 +148,6 @@ export interface JSONScene {
      * 'model@1.0'
      */
     plugins: string[];
-    /**
-     * 保留字段
-     */
-    requires: SceneRequire[];
     /**
      * 字体资源
      * 数据模板下掉可以不要 FontBase[]

package/es/scene.js

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

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

@@ -1,9 +1,3 @@
-import type { RGBAColor } from './number-expression';
-export interface StringTemplate {
-    fonts: FontBase[];
-    texts: Text[];
-    colors: RGBAColor[];
-}
 /**
  * 字体资源
  * @version 2.3
@@ -171,7 +165,7 @@ export declare enum FontStyle {
     /**
      * 正常
      */
-    normal = "normal",
+    normal = "normal",// default
     /**
      * 斜体
      */

package/es/text.js

@@ -0,0 +1,84 @@
+export var TextOverflow;
+(function (TextOverflow) {
+    /**
+     * display 模式下，会显示所有文本，存在文本超过边界框的情况。
+     */
+    TextOverflow[TextOverflow["display"] = 0] = "display";
+    /**
+     * clip 模式下，当文本内容超出边界框时，多余的会被截断。
+     */
+    TextOverflow[TextOverflow["clip"] = 1] = "clip";
+    /**
+     * ellipsis 模式下，会使用（...）来代替超出边界框的内容。
+     */
+    TextOverflow[TextOverflow["ellipsis"] = 2] = "ellipsis";
+})(TextOverflow || (TextOverflow = {}));
+export var TextBaseline;
+(function (TextBaseline) {
+    /**
+     * 文本顶对齐。
+     */
+    TextBaseline[TextBaseline["top"] = 0] = "top";
+    /**
+     * 文本垂直居中对齐。
+     */
+    TextBaseline[TextBaseline["middle"] = 1] = "middle";
+    /**
+     * 文本底对齐。
+     */
+    TextBaseline[TextBaseline["bottom"] = 2] = "bottom";
+})(TextBaseline || (TextBaseline = {}));
+export var TextAlignment;
+(function (TextAlignment) {
+    /**
+     * text alignment starts from（x,y) to right direction
+     * 从(x,y)开始第一个字符，向右边延伸
+     */
+    TextAlignment[TextAlignment["left"] = 0] = "left";
+    /**
+     * (x,y) is middle position of text, where (left + right)/2 =(x,y)
+     * (x,y) 为文字中间位置，（最左位置 + 最右位置)/2 = (x,y)
+     */
+    TextAlignment[TextAlignment["middle"] = 1] = "middle";
+    /**
+     * text alignment ends with（x,y) from left direction
+     * 从(x,y)结束最后一个字符，向左边延伸
+     */
+    TextAlignment[TextAlignment["right"] = 2] = "right";
+})(TextAlignment || (TextAlignment = {}));
+/**
+ * 文本字重
+ */
+export var TextWeight;
+(function (TextWeight) {
+    /**
+     * 正常
+     */
+    TextWeight["normal"] = "normal";
+    /**
+     * 粗体
+     */
+    TextWeight["bold"] = "bold";
+    /**
+     * 瘦体
+     */
+    TextWeight["lighter"] = "lighter";
+})(TextWeight || (TextWeight = {}));
+/**
+ * 文本样式
+ */
+export var FontStyle;
+(function (FontStyle) {
+    /**
+     * 正常
+     */
+    FontStyle["normal"] = "normal";
+    /**
+     * 斜体
+     */
+    FontStyle["italic"] = "italic";
+    /**
+     * 倾斜体
+     */
+    FontStyle["oblique"] = "oblique";
+})(FontStyle || (FontStyle = {}));

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

@@ -512,10 +512,6 @@ export declare enum ItemType {
      * 预合成元素
      */
     composition = "7",
-    /**
-     * 滤镜图层
-     */
-    filter = "8",
     /**
      * Spine 元素
      */
@@ -616,21 +612,37 @@ export interface PluginGyroscopeTarget {
      */
     name: string;
     /**
-     * x轴最小值
+     * x 轴位移最小值
      */
     xMin: number;
     /**
-     * x轴最大值
+     * x 轴位移最大值
      */
     xMax: number;
     /**
-     * y轴最小值
+     * y 轴位移最小值
      */
     yMin: number;
     /**
-     * y轴最大值
+     * y 轴位移最大值
      */
     yMax: number;
+    /**
+     * 绕 x 轴（水平）旋转角度最小值
+     */
+    hMin: number;
+    /**
+     * 绕 x 轴（水平）旋转角度最大值
+     */
+    hMax: number;
+    /**
+     * 绕 y 轴（垂直）旋转角度最小值
+     */
+    vMin: number;
+    /**
+     * 绕 y 轴（垂直）旋转角度最大值
+     */
+    vMax: number;
 }
 /**
  * 二维蒙版形状属性
@@ -645,3 +657,12 @@ export interface ShapeGeometry {
      */
     s: ShapeSplits;
 }
+export declare enum RenderType {
+    Opaque = "Opaque",
+    Transparent = "Transparent"
+}
+export declare enum RenderFace {
+    Both = "Both",
+    Back = "Back",
+    Front = "Front"
+}