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

package/es/type.js

@@ -0,0 +1,342 @@
+/*********************************************/
+/*               元素属性参数类型               */
+/*********************************************/
+/**
+ * 渲染等级
+ */
+export var RenderLevel;
+(function (RenderLevel) {
+    RenderLevel["S"] = "S";
+    RenderLevel["APlus"] = "A+";
+    RenderLevel["A"] = "A";
+    RenderLevel["BPlus"] = "B+";
+    RenderLevel["B"] = "B";
+})(RenderLevel || (RenderLevel = {}));
+/**
+ * 混合模式
+ */
+export var BlendingMode;
+(function (BlendingMode) {
+    /**
+     * 普通混合模式
+     */
+    BlendingMode[BlendingMode["ALPHA"] = 0] = "ALPHA";
+    /**
+     * 叠加混合模式
+     */
+    BlendingMode[BlendingMode["ADD"] = 1] = "ADD";
+    /**
+     * 相乘混合模式
+     */
+    BlendingMode[BlendingMode["MULTIPLY"] = 2] = "MULTIPLY";
+    /**
+     * 亮度混合模式
+     */
+    BlendingMode[BlendingMode["BRIGHTNESS"] = 3] = "BRIGHTNESS";
+    /**
+     * 减色混合模式
+     */
+    BlendingMode[BlendingMode["SUBTRACTION"] = 4] = "SUBTRACTION";
+    /**
+     * 强光混合模式
+     */
+    BlendingMode[BlendingMode["STRONG_LIGHT"] = 5] = "STRONG_LIGHT";
+    /**
+     * 弱光混合模式
+     */
+    BlendingMode[BlendingMode["WEAK_LIGHT"] = 6] = "WEAK_LIGHT";
+    /**
+     * 亮度叠加混合模式
+     */
+    BlendingMode[BlendingMode["SUPERPOSITION"] = 7] = "SUPERPOSITION";
+})(BlendingMode || (BlendingMode = {}));
+/**
+ * 单双面模式
+ */
+export var SideMode;
+(function (SideMode) {
+    /**
+     * 双面模式
+     */
+    SideMode[SideMode["DOUBLE"] = 1032] = "DOUBLE";
+    /**
+     * 正面模式
+     */
+    SideMode[SideMode["FRONT"] = 1028] = "FRONT";
+    /**
+     * 背面模式
+     */
+    SideMode[SideMode["BACK"] = 1029] = "BACK";
+})(SideMode || (SideMode = {}));
+/**
+ * 蒙版模式
+ */
+export var MaskMode;
+(function (MaskMode) {
+    /**
+     * 无蒙版
+     */
+    MaskMode[MaskMode["NONE"] = 0] = "NONE";
+    /**
+     * 蒙版
+     */
+    MaskMode[MaskMode["MASK"] = 1] = "MASK";
+    /**
+     * 被遮挡
+     */
+    MaskMode[MaskMode["OBSCURED"] = 2] = "OBSCURED";
+    /**
+     * 被反向遮挡
+     */
+    MaskMode[MaskMode["REVERSE_OBSCURED"] = 3] = "REVERSE_OBSCURED";
+})(MaskMode || (MaskMode = {}));
+/**
+ * 发射器形状
+ */
+export var ShapeType;
+(function (ShapeType) {
+    /**
+     * 没有类型
+     */
+    ShapeType[ShapeType["NONE"] = 0] = "NONE";
+    /**
+     * 圆球
+     */
+    ShapeType[ShapeType["SPHERE"] = 1] = "SPHERE";
+    /**
+     * 圆锥
+     */
+    ShapeType[ShapeType["CONE"] = 2] = "CONE";
+    /**
+     * 半球
+     */
+    ShapeType[ShapeType["HEMISPHERE"] = 3] = "HEMISPHERE";
+    /**
+     * 圆
+     */
+    ShapeType[ShapeType["CIRCLE"] = 4] = "CIRCLE";
+    /**
+     * 圆环
+     */
+    ShapeType[ShapeType["DONUT"] = 5] = "DONUT";
+    /**
+     * 矩形
+     */
+    ShapeType[ShapeType["RECTANGLE"] = 6] = "RECTANGLE";
+    /**
+     * 矩形框
+     */
+    ShapeType[ShapeType["RECTANGLE_EDGE"] = 7] = "RECTANGLE_EDGE";
+    /**
+     * 直线
+     */
+    ShapeType[ShapeType["EDGE"] = 8] = "EDGE";
+    /**
+     * 贴图
+     */
+    ShapeType[ShapeType["TEXTURE"] = 9] = "TEXTURE";
+})(ShapeType || (ShapeType = {}));
+/**
+ * 插件类型
+ */
+export var PluginType;
+(function (PluginType) {
+    /**
+     * 陀螺仪
+     */
+    PluginType[PluginType["GYROSCOPE"] = 0] = "GYROSCOPE";
+    /**
+     * Spine
+     */
+    PluginType[PluginType["SPINE"] = 1] = "SPINE";
+})(PluginType || (PluginType = {}));
+/**
+ * 交互类型
+ */
+export var InteractType;
+(function (InteractType) {
+    /**
+     * 点击
+     */
+    InteractType[InteractType["CLICK"] = 0] = "CLICK";
+    /**
+     * 消息
+     * 前端收到 onMessageItem 回调
+     */
+    InteractType[InteractType["MESSAGE"] = 1] = "MESSAGE";
+    /**
+     * 拖拽
+     */
+    InteractType[InteractType["DRAG"] = 2] = "DRAG";
+})(InteractType || (InteractType = {}));
+/**
+ * 交互行为
+ */
+export var InteractBehavior;
+(function (InteractBehavior) {
+    /**
+     * 无
+     */
+    InteractBehavior[InteractBehavior["NONE"] = 0] = "NONE";
+    /**
+     * 通知
+     */
+    InteractBehavior[InteractBehavior["NOTIFY"] = 1] = "NOTIFY";
+    /**
+     * 重置播放器
+     */
+    InteractBehavior[InteractBehavior["RESUME_PLAYER"] = 2] = "RESUME_PLAYER";
+    /**
+     * 清除元素
+     */
+    InteractBehavior[InteractBehavior["REMOVE"] = 3] = "REMOVE";
+    /**
+     * 暂停播放器
+     */
+    InteractBehavior[InteractBehavior["PAUSE"] = 4] = "PAUSE";
+})(InteractBehavior || (InteractBehavior = {}));
+/**
+ * 元素类型
+ */
+export var ItemType;
+(function (ItemType) {
+    /**
+     * 错误元素
+     */
+    ItemType["base"] = "0";
+    /**
+     * 图层元素
+     */
+    ItemType["sprite"] = "1";
+    /**
+     * 粒子元素
+     */
+    ItemType["particle"] = "2";
+    /**
+     * 空节点元素
+     */
+    ItemType["null"] = "3";
+    /**
+     * 交互元素
+     */
+    ItemType["interact"] = "4";
+    /**
+     * 插件元素
+     */
+    ItemType["plugin"] = "5";
+    /**
+     * 相机元素
+     */
+    ItemType["camera"] = "6";
+    /**
+     * 预合成元素
+     */
+    ItemType["composition"] = "7";
+    /**
+     * Spine 元素
+     */
+    ItemType["spine"] = "spine";
+    /**
+     * Mesh 元素
+     */
+    ItemType["mesh"] = "mesh";
+    /**
+     * 节点树元素
+     */
+    ItemType["tree"] = "tree";
+    /**
+     * 文本元素
+     */
+    ItemType["text"] = "text";
+    /**
+     * 灯光元素
+     */
+    ItemType["light"] = "light";
+    /**
+     * 天空盒元素
+     */
+    ItemType["skybox"] = "skybox";
+    /**
+     * 特效元素
+     */
+    ItemType["effect"] = "effect";
+    /**
+     * 节点元素
+     */
+    ItemType["node"] = "node";
+})(ItemType || (ItemType = {}));
+/**
+ * 渲染模式
+ */
+export var RenderMode;
+(function (RenderMode) {
+    /**
+     * 广告牌模式
+     */
+    RenderMode[RenderMode["BILLBOARD"] = 0] = "BILLBOARD";
+    /**
+     * 网格模式
+     */
+    RenderMode[RenderMode["MESH"] = 1] = "MESH";
+    /**
+     * 垂直广告牌模式
+     */
+    RenderMode[RenderMode["VERTICAL_BILLBOARD"] = 2] = "VERTICAL_BILLBOARD";
+    /**
+     * 水平广告牌模式
+     */
+    RenderMode[RenderMode["HORIZONTAL_BILLBOARD"] = 3] = "HORIZONTAL_BILLBOARD";
+})(RenderMode || (RenderMode = {}));
+/**
+ * 变换中心
+ */
+export var ParticleOrigin;
+(function (ParticleOrigin) {
+    /**
+     * 水平和垂直中点
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_CENTER"] = 0] = "PARTICLE_ORIGIN_CENTER";
+    /**
+     * 水平左侧 垂直顶部
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_LEFT_TOP"] = 1] = "PARTICLE_ORIGIN_LEFT_TOP";
+    /**
+     * 水平左侧 垂直中间
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_LEFT_CENTER"] = 2] = "PARTICLE_ORIGIN_LEFT_CENTER";
+    /**
+     * 水平左侧 垂直底部
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_LEFT_BOTTOM"] = 3] = "PARTICLE_ORIGIN_LEFT_BOTTOM";
+    /**
+     * 水平中间 垂直顶部
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_CENTER_TOP"] = 4] = "PARTICLE_ORIGIN_CENTER_TOP";
+    /**
+     * 水平中间 垂直底部
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_CENTER_BOTTOM"] = 5] = "PARTICLE_ORIGIN_CENTER_BOTTOM";
+    /**
+     * 水平右侧 垂直顶部
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_RIGHT_TOP"] = 6] = "PARTICLE_ORIGIN_RIGHT_TOP";
+    /**
+     * 水平右侧 垂直中间
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_RIGHT_CENTER"] = 7] = "PARTICLE_ORIGIN_RIGHT_CENTER";
+    /**
+     * 水平右侧 垂直底部
+     */
+    ParticleOrigin[ParticleOrigin["PARTICLE_ORIGIN_RIGHT_BOTTOM"] = 8] = "PARTICLE_ORIGIN_RIGHT_BOTTOM";
+})(ParticleOrigin || (ParticleOrigin = {}));
+export var RenderType;
+(function (RenderType) {
+    RenderType["Opaque"] = "Opaque";
+    RenderType["Transparent"] = "Transparent";
+})(RenderType || (RenderType = {}));
+export var RenderFace;
+(function (RenderFace) {
+    RenderFace["Both"] = "Both";
+    RenderFace["Back"] = "Back";
+    RenderFace["Front"] = "Front";
+})(RenderFace || (RenderFace = {}));

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

@@ -1,11 +1,11 @@
-import type { ComponentData, EffectsObjectData } from './components';
-import type { ItemEndBehavior, ParentItemEndBehavior, BaseContent, TransformData } from './item/base-item';
+import type { DataPath, EffectsObjectData } from './components';
+import type { EndBehavior, ParentItemEndBehavior, BaseContent, TransformData } from './item/base-item';
 import type { ItemType, RenderLevel } from './type';
 export interface VFXItemData extends EffectsObjectData {
     /**
-     * 元素 id
-     * 非预合成的元素 id 为 int 类型的数字字符串
-     * 预合成元素 id 为 `'{ref元素id}+{合成内id}'` 字符串
+     * 元素 ID
+     * 非预合成的元素 ID 为 int 类型的数字字符串
+     * 预合成元素 ID 为 `'{ref 元素 ID}+{合成内 ID}'` 字符串
      */
     id: string;
     /**
@@ -17,14 +17,13 @@ export interface VFXItemData extends EffectsObjectData {
      */
     duration: number;
     /**
-     * 元素类型，string 类型
+     * 元素类型，String 类型
      * Galacean Effects 内部元素使用 int 数字字符串
      * plugin 模块实现者自由实现命名
-     * 2022.12更新: spine: "spine", 陀螺仪: "5"
      */
-    type: ItemType | string;
+    type: ItemType;
     /**
-     * 父节点ID
+     * 父节点 ID
      * 如果父节点无法找到，播放将直接报错
      */
     parentId?: string;
@@ -38,7 +37,7 @@ export interface VFXItemData extends EffectsObjectData {
      * 元素结束行为
      * @default destroy
      */
-    endBehavior: ItemEndBehavior | ParentItemEndBehavior;
+    endBehavior: EndBehavior | ParentItemEndBehavior;
     /**
      * 元素播放延时（单位秒）
      * @default 0
@@ -70,5 +69,5 @@ export interface VFXItemData extends EffectsObjectData {
     /**
      * 元素的组件数据
      */
-    components: ComponentData[];
+    components: DataPath[];
 }

package/es/vfx-item-data.js

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

package/package.json

@@ -1,72 +1,51 @@
 {
   "name": "@galacean/effects-specification",
-  "version": "2.0.0-alpha.2",
+  "version": "2.0.0-alpha.21",
   "description": "Galacean Effects JSON Specification",
-  "module": "./dist/index.mjs",
-  "main": "./dist/index.js",
-  "types": "./dist/src/index.d.ts",
+  "module": "./es/index.js",
+  "main": "./es/index.js",
+  "types": "./es/index.d.ts",
   "files": [
-    "dist"
+    "es"
   ],
   "exports": {
     ".": {
-      "import": "./dist/index.mjs",
-      "require": "./dist/index.js",
-      "types": "./dist/src/index.d.ts"
-    },
-    "./dist/fallback": {
-      "import": "./dist/fallback.mjs",
-      "require": "./dist/fallback.js",
-      "types": "./dist/fallback/index.d.ts"
+      "import": "./es/index.js",
+      "require": "./es/index.js",
+      "types": "./es/index.d.ts"
     }
   },
-  "scripts": {
-    "prebuild": "npm run clean:all",
-    "build": "npm run build:dist",
-    "build:dist": "rollup -c",
-    "lint": "eslint {src,fallback,test} --ext .ts,.mjs",
-    "lint:fix": "eslint {src,fallback,test} --fix --quiet --ext .ts,.mjs",
-    "check:ts": "tsc -b tsconfig.check.json",
-    "clean:all": "npm run clean:dist",
-    "clean:dist": "rimraf dist/**",
-    "test": "rollup -c --watch --test",
-    "prepare": "husky install",
-    "prepublishOnly": "npm run build"
-  },
   "browserslist": [
     "iOS 9"
   ],
   "devDependencies": {
     "@commitlint/cli": "^13.2.1",
-    "@commitlint/config-conventional": "^13.2.0",
-    "@rollup/plugin-commonjs": "^21.0.3",
-    "@rollup/plugin-node-resolve": "^13.1.3",
-    "@rollup/plugin-typescript": "^8.3.1",
-    "@types/chai": "^4.3.0",
-    "@types/chai-spies": "^1.0.0",
-    "@types/mocha": "^10.0.1",
-    "@types/node": "^17.0.21",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "chai": "^4.3.6",
-    "chai-spies": "^1.0.0",
-    "eslint": "^8.13.0",
+    "@commitlint/config-conventional": "^18.4.3",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
+    "eslint": "^8.56.0",
     "eslint-plugin-compat": "^4.2.0",
     "eslint-plugin-promise": "^6.1.1",
-    "husky": "^7.0.4",
+    "husky": "^9.0.11",
     "lint-staged": "^11.2.6",
-    "mocha": "^10.2.0",
+    "pnpm": "^8.15.7",
     "rimraf": "^3.0.2",
-    "rollup": "^2.70.1",
-    "rollup-plugin-livereload": "^2.0.5",
-    "rollup-plugin-serve": "^1.1.0",
-    "typescript": "^4.6.2",
-    "uuid": "9.0.1"
+    "typescript": "^5.3.3"
   },
   "author": "Ant Group CO., Ltd.",
   "license": "MIT",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "prebuild": "npm run clean:all",
+    "build": "npm run build:lib",
+    "build:lib": "tsc -b tsconfig.build.json",
+    "lint": "eslint src --ext .ts,.mjs",
+    "lint:fix": "eslint src --fix --quiet --ext .ts,.mjs",
+    "check:ts": "tsc -b tsconfig.check.json",
+    "clean:all": "npm run clean:lib",
+    "clean:lib": "rimraf es/**"
   }
-}
+}

package/dist/fallback/camera.d.ts

@@ -1,2 +0,0 @@
-import type { CameraContent } from '../src/item/camera-item';
-export declare function getStandardCameraContent(model: any): CameraContent;

package/dist/fallback/filter.d.ts

@@ -1,2 +0,0 @@
-import type { FilterParams } from '../src/item/filter-item';
-export declare function getStandardFilterContent(filter: any): FilterParams;

package/dist/fallback/index.d.ts

@@ -1,12 +0,0 @@
-import type { BaseItem, Composition, CompressedImage, Image, JSONScene, ParticleItem, RenderLevel, SpriteItem, TemplateImage, VideoImage, FilterItem } from '../src';
-export * from './utils';
-export declare function getStandardJSON(json: any): JSONScene;
-export declare function getStandardImage(image: any, index: number, imageTags: RenderLevel[]): TemplateImage | Image | CompressedImage | VideoImage;
-export declare function getStandardComposition(composition: any, opt?: {
-    plugins?: string[];
-    requires?: string[];
-}): Composition;
-export declare function getStandardItem(item: any, opt?: {
-    plugins?: string[];
-    requires?: string[];
-}): SpriteItem | ParticleItem | BaseItem | FilterItem;

package/dist/fallback/interact.d.ts

@@ -1,2 +0,0 @@
-import type { InteractContent } from '../src';
-export declare function getStandardInteractContent(ui: any): InteractContent;

package/dist/fallback/migration.d.ts

@@ -1,13 +0,0 @@
-import type { JSONScene, JSONSceneLegacy } from '../src';
-/**
- * 2.1 以下版本数据适配（mars-player@2.4.0 及以上版本支持 2.1 以下数据的适配）
- */
-export declare function version21Migration(json: JSONSceneLegacy): JSONSceneLegacy;
-/**
- * 2.2 以下版本数据适配（mars-player@2.5.0 及以上版本支持 2.2 以下数据的适配）
- */
-export declare function version22Migration(json: JSONSceneLegacy): JSONSceneLegacy;
-/**
- * 3.0 以下版本数据适配（runtime 2.0及以上版本支持）
- */
-export declare function version30Migration(json: JSONSceneLegacy): JSONScene;

package/dist/fallback/particle.d.ts

@@ -1,2 +0,0 @@
-import type { ParticleContent } from '../src';
-export declare function getStandardParticleContent(particle: any): ParticleContent;

package/dist/fallback/sprite.d.ts

@@ -1,3 +0,0 @@
-import type { BaseItemTransform, NullContent, SpriteContent } from '../src';
-export declare function getStandardNullContent(sprite: any, transform: BaseItemTransform): NullContent;
-export declare function getStandardSpriteContent(sprite: any, transform: BaseItemTransform): SpriteContent;

package/dist/fallback/utils.d.ts

@@ -1,36 +0,0 @@
-import type { FixedNumberExpression, RGBAColorValue, ColorExpression, NumberExpression, GradientColor, FixedVec3Expression, vec4, vec3, vec2 } from '../src';
-import { ParticleOrigin } from '../src';
-export declare function arrAdd<T>(arr: T[], item: T): boolean | undefined;
-/**
- * @deprecated 请直接使用 Array.prototype.forEach 或 for...of
- * @param object
- * @param callback
- * @returns the mutated input object
- */
-export declare function forEach<T>(object: null | undefined | {
-    [key: string]: T | Record<any, T>;
-}, callback: (val: T, key: string) => void, thisObj?: any): {
-    [key: string]: T | Record<any, T>;
-} | null | undefined;
-export declare function ensureFixedNumber(a: any): FixedNumberExpression | undefined;
-export declare function ensureFixedNumberWithRandom(a: any, p: number): FixedNumberExpression | undefined;
-export declare function ensureRGBAValue(a: any): RGBAColorValue;
-export declare function ensureColorExpression(a: any, normalized?: boolean): ColorExpression | undefined;
-export declare function ensureNumberExpression(a: any): NumberExpression | undefined;
-export declare function ensureValueGetter(a: any): NumberExpression | any;
-export declare function ensureGradient(a: any, normalized?: boolean): GradientColor | undefined;
-export declare function colorToArr(hex: string | number[], normalized?: boolean): vec4;
-export declare function normalizeColor(a: number[]): number[] | undefined;
-export declare function parsePercent(c: string): number;
-export declare function getGradientColor(color: string | Array<string | number[]>, normalized?: boolean): GradientColor | undefined;
-export declare function ensureFixedVec3(a: any): FixedVec3Expression | undefined;
-export declare function objectValueToNumber(o: Record<string, any>): object;
-export declare function deleteEmptyValue(o: Record<string, any>): object;
-export declare function quatFromXYZRotation(out: vec4 | number[], x: number, y: number, z: number): vec4;
-export declare function rotationZYXFromQuat(out: vec3 | number[], quat: vec4): vec3;
-export declare function generateGUID(): string;
-/**
- * 提取并转换 JSON 数据中的 anchor 值
- */
-export declare function convertAnchor(anchor?: vec2, particleOrigin?: ParticleOrigin): vec2;
-export declare const particleOriginTranslateMap: Record<number, vec2>;