@galacean/effects-specification 0.0.1

package/dist/src/type.d.ts

@@ -0,0 +1,643 @@
+import type { FixedVec3Expression, vec2, vec3, GradientColor, ShapePoints, ShapeSplits, FixedNumberExpression } from './numberExpression';
+/**
+ * 播放器版本
+ */
+export interface PlayerVersion {
+    /**
+     * Web端版本号
+     */
+    web: string;
+    /**
+     * Native端版本号
+     */
+    native: string;
+}
+/*********************************************/
+/*********************************************/
+/**
+ * 模型属性
+ */
+export interface GLTF {
+    /**
+     * 模型序号
+     */
+    id: number;
+    /**
+     * 模型地址
+     */
+    url: string;
+    /**
+     * 是否复用
+     */
+    reuse: boolean;
+}
+/**
+ * 形状属性
+ */
+export interface Shape {
+    /**
+     * 形状 ID
+     */
+    id: number;
+    /**
+     * 形状数据
+     */
+    shape: number[];
+}
+/**
+ * 插件参数
+ */
+export interface Plugin {
+    /**
+     * 插件类型
+     */
+    type: PluginType;
+    /**
+     * 插件版本
+     */
+    version: string;
+}
+/*********************************************/
+/*********************************************/
+/**
+ * 大小变化属性
+ */
+export interface SizeOverLifetime {
+    /**
+     * 分轴变化开关
+     */
+    separateAxes?: boolean;
+    /**
+     * 整体大小变化信息（非分轴模式）
+     */
+    size?: FixedNumberExpression;
+    /**
+     * x轴大小变化信息（分轴模式）
+     */
+    x?: FixedNumberExpression;
+    /**
+     * y轴大小变化信息（分轴模式）
+     */
+    y?: FixedNumberExpression;
+    /**
+     * z轴大小变化信息（分轴模式）
+     */
+    z?: FixedNumberExpression;
+}
+/**
+ * 旋转变化属性
+ */
+export interface RotationOverLifetime {
+    /**
+     * 分轴变化开关
+     */
+    separateAxes?: boolean;
+    /**
+     * 角度模式
+     */
+    asRotation?: boolean;
+    /**
+     * x 轴旋转函数
+     */
+    x?: FixedNumberExpression;
+    /**
+     * y 轴旋转函数
+     */
+    y?: FixedNumberExpression;
+    /**
+     * z 轴旋转函数（不分轴时，变化 z）
+     */
+    z?: FixedNumberExpression;
+}
+/**
+ * 位置变化属性
+ */
+export interface PositionOverLifetime {
+    /**
+     * 路程模式
+     */
+    asMovement?: boolean;
+    /**
+     * x轴位置变化信息
+     */
+    linearX?: FixedNumberExpression;
+    /**
+     * y轴位置变化信息
+     */
+    linearY?: FixedNumberExpression;
+    /**
+     * z轴位置变化信息
+     */
+    linearZ?: FixedNumberExpression;
+    /**
+     * 环绕模式
+     */
+    asRotation?: boolean;
+    /**
+     * x轴环绕角度变化信息
+     */
+    orbitalX?: FixedNumberExpression;
+    /**
+     * y轴环绕角度变化信息
+     */
+    orbitalY?: FixedNumberExpression;
+    /**
+     * z轴环绕角度变化信息
+     */
+    orbitalZ?: FixedNumberExpression;
+    /**
+     * 环绕中心信息
+     */
+    orbCenter?: vec3;
+    /**
+     * 路径
+     * @default [0,0,0]
+     */
+    path?: FixedVec3Expression;
+    /**
+     * 初速度方向
+     */
+    direction?: vec3;
+    /**
+     * 增加一个初速度，匀速直线运动，direction 为运动方向
+     * @default 0
+     */
+    startSpeed?: number;
+    /**
+     * 速度变化信息
+     * @default [ValueType.ConstantNumber, 0]
+     */
+    speedOverLifetime?: FixedNumberExpression;
+    /**
+     * 增加一个重力
+     * gravity 为重力方向，gravityModifier 为重力大小
+     * @default 0
+     */
+    gravity?: vec3;
+    /**
+     * 重力变化信息
+     */
+    gravityOverLifetime?: FixedNumberExpression;
+}
+/**
+ * 颜色变化属性
+ */
+export interface ColorOverLifetime {
+    /**
+     * 颜色属性
+     */
+    color?: GradientColor;
+    /**
+     * 透明度属性变化值
+     */
+    opacity?: FixedNumberExpression;
+}
+/**
+ * 雪碧图/帧动画属性
+ */
+export interface TextureSheetAnimation {
+    /**
+     * 雪碧图行数
+     */
+    row: number;
+    /**
+     * 雪碧图列数
+     */
+    col: number;
+    /**
+     * 帧动画总帧数
+     * 默认 row * col
+     */
+    total?: number;
+    /**
+     * 帧动画开关
+     */
+    animate: boolean;
+}
+/**
+ * 精灵图坐标属性
+ */
+export declare type SplitParameter = [
+    /**
+     * 起点[归一化坐标]
+     */
+    sx: number,
+    /**
+     * 起点[归一化坐标]
+     */
+    sy: number,
+    /**
+     * 宽度[归一化距离]
+     */
+    width: number,
+    /**
+     * 宽度[归一化距离]
+     */
+    height: number,
+    /**
+     * 是否翻转 uv 90 度
+     */
+    flip: 0 | 1
+];
+/*********************************************/
+/*********************************************/
+/**
+ * 渲染等级
+ */
+export declare enum RenderLevel {
+    S = "S",
+    APlus = "A+",
+    A = "A",
+    BPlus = "B+",
+    B = "B"
+}
+/**
+ * 混合模式
+ */
+export declare enum BlendingMode {
+    /**
+     * 普通混合模式
+     */
+    ALPHA = 0,
+    /**
+     * 叠加混合模式
+     */
+    ADD = 1,
+    /**
+     * 相乘混合模式
+     */
+    MULTIPLY = 2,
+    /**
+     * 亮度混合模式
+     */
+    BRIGHTNESS = 3,
+    /**
+     * 减色混合模式
+     */
+    SUBTRACTION = 4,
+    /**
+     * 强光混合模式
+     */
+    STRONG_LIGHT = 5,
+    /**
+     * 弱光混合模式
+     */
+    WEAK_LIGHT = 6,
+    /**
+     * 亮度叠加混合模式
+     */
+    SUPERPOSITION = 7
+}
+/**
+ * 单双面模式
+ */
+export declare enum SideMode {
+    /**
+     * 双面模式
+     */
+    DOUBLE = 1032,
+    /**
+     * 正面模式
+     */
+    FRONT = 1028,
+    /**
+     * 背面模式
+     */
+    BACK = 1029
+}
+/**
+ * 蒙版模式
+ */
+export declare enum MaskMode {
+    /**
+     * 无蒙版
+     */
+    NONE = 0,
+    /**
+     * 蒙版
+     */
+    MASK = 1,
+    /**
+     * 被遮挡
+     */
+    OBSCURED = 2,
+    /**
+     * 被反向遮挡
+     */
+    REVERSE_OBSCURED = 3
+}
+/**
+ * 发射器形状
+ */
+export declare enum ShapeType {
+    /**
+     * 没有类型
+     */
+    NONE = 0,
+    /**
+     * 圆球
+     */
+    SPHERE = 1,
+    /**
+     * 圆锥
+     */
+    CONE = 2,
+    /**
+     * 半球
+     */
+    HEMISPHERE = 3,
+    /**
+     * 圆
+     */
+    CIRCLE = 4,
+    /**
+     * 圆环
+     */
+    DONUT = 5,
+    /**
+     * 矩形
+     */
+    RECTANGLE = 6,
+    /**
+     * 矩形框
+     */
+    RECTANGLE_EDGE = 7,
+    /**
+     * 直线
+     */
+    EDGE = 8,
+    /**
+     * 贴图
+     */
+    TEXTURE = 9
+}
+/**
+ * 插件类型
+ */
+export declare enum PluginType {
+    /**
+     * 陀螺仪
+     */
+    GYROSCOPE = 0,
+    /**
+     * Spine
+     */
+    SPINE = 1
+}
+/**
+ * 交互类型
+ */
+export declare enum InteractType {
+    /**
+     * 点击
+     */
+    CLICK = 0,
+    /**
+     * 消息
+     * 前端收到 onMessageItem 回调
+     */
+    MESSAGE = 1,
+    /**
+     * 拖拽
+     */
+    DRAG = 2
+}
+/**
+ * 交互行为
+ */
+export declare enum InteractBehavior {
+    /**
+     * 无
+     */
+    NONE = 0,
+    /**
+     * 通知
+     */
+    NOTIFY = 1,
+    /**
+     * 重置播放器
+     */
+    RESUME_PLAYER = 2,
+    /**
+     * 清除元素
+     */
+    REMOVE = 3,
+    /**
+     * 暂停播放器
+     */
+    PAUSE = 4
+}
+/**
+ * 基础渲染属性
+ */
+export interface RendererOptions {
+    /**
+     * 渲染模式
+     */
+    renderMode?: RenderMode;
+    /**
+     * 混合模式
+     * @default BlendingMode.ALPHA
+     */
+    blending?: BlendingMode;
+    /**
+     * 单双面模式
+     */
+    side?: SideMode;
+    /**
+     * 是否写入深度缓存
+     * @default false
+     */
+    occlusion?: boolean;
+    /**
+     * 透明像素是否写入深度缓存，occlusion 为 true 时生效
+     * @default false
+     */
+    transparentOcclusion?: boolean;
+    /**
+     * 贴图，索引到 scene 中的 images 数组
+     */
+    texture?: number;
+    /**
+     * 蒙版模式
+     * @default none
+     */
+    maskMode?: MaskMode;
+    /**
+     * 蒙版形状，索引到 scene 的 shapes 中
+     */
+    shape?: number | ShapeGeometry;
+    /**
+     * 旋转中心
+     */
+    particleOrigin?: ParticleOrigin;
+    /**
+     * 锚点
+     */
+    anchor?: vec2;
+}
+/**
+ * 元素类型
+ */
+export declare enum ItemType {
+    /**
+     * 错误元素
+     */
+    base = "0",
+    /**
+     * 图层元素
+     */
+    sprite = "1",
+    /**
+     * 粒子元素
+     */
+    particle = "2",
+    /**
+     * 空节点元素
+     */
+    null = "3",
+    /**
+     * 交互元素
+     */
+    interact = "4",
+    /**
+     * 插件元素
+     */
+    plugin = "5",
+    /**
+     * 相机元素
+     */
+    camera = "6",
+    /**
+     * 预合成元素
+     */
+    composition = "7",
+    /**
+     * 滤镜图层
+     */
+    filter = "8",
+    /**
+     * Spine 元素
+     */
+    spine = "spine",
+    /**
+     * Mesh 元素
+     */
+    mesh = "mesh",
+    /**
+     * 节点树元素
+     */
+    tree = "tree",
+    /**
+     * 文本元素
+     */
+    text = "text",
+    /**
+     * 灯光元素
+     */
+    light = "light",
+    /**
+     * 天空盒元素
+     */
+    skybox = "skybox"
+}
+/**
+ * 渲染模式
+ */
+export declare enum RenderMode {
+    /**
+     * 广告牌模式
+     */
+    BILLBOARD = 0,
+    /**
+     * 网格模式
+     */
+    MESH = 1,
+    /**
+     * 垂直广告牌模式
+     */
+    VERTICAL_BILLBOARD = 2,
+    /**
+     * 水平广告牌模式
+     */
+    HORIZONTAL_BILLBOARD = 3
+}
+/**
+ * 变换中心
+ */
+export declare enum ParticleOrigin {
+    /**
+     * 水平和垂直中点
+     */
+    PARTICLE_ORIGIN_CENTER = 0,
+    /**
+     * 水平左侧 垂直顶部
+     */
+    PARTICLE_ORIGIN_LEFT_TOP = 1,
+    /**
+     * 水平左侧 垂直中间
+     */
+    PARTICLE_ORIGIN_LEFT_CENTER = 2,
+    /**
+     * 水平左侧 垂直底部
+     */
+    PARTICLE_ORIGIN_LEFT_BOTTOM = 3,
+    /**
+     * 水平中间 垂直顶部
+     */
+    PARTICLE_ORIGIN_CENTER_TOP = 4,
+    /**
+     * 水平中间 垂直底部
+     */
+    PARTICLE_ORIGIN_CENTER_BOTTOM = 5,
+    /**
+     * 水平右侧 垂直顶部
+     */
+    PARTICLE_ORIGIN_RIGHT_TOP = 6,
+    /**
+     * 水平右侧 垂直中间
+     */
+    PARTICLE_ORIGIN_RIGHT_CENTER = 7,
+    /**
+     * 水平右侧 垂直底部
+     */
+    PARTICLE_ORIGIN_RIGHT_BOTTOM = 8
+}
+/**
+ * 陀螺仪插件属性
+ */
+export interface PluginGyroscopeTarget {
+    /**
+     * 名称
+     */
+    name: string;
+    /**
+     * x轴最小值
+     */
+    xMin: number;
+    /**
+     * x轴最大值
+     */
+    xMax: number;
+    /**
+     * y轴最小值
+     */
+    yMin: number;
+    /**
+     * y轴最大值
+     */
+    yMax: number;
+}
+/**
+ * 二维蒙版形状属性
+ */
+export interface ShapeGeometry {
+    /**
+     * 贝塞尔点信息[顶点信息 前向控制点 后向控制点]
+     */
+    p: ShapePoints;
+    /**
+     * 差值信息
+     */
+    s: ShapeSplits;
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@galacean/effects-specification",
+  "version": "0.0.1",
+  "description": "Galacean Effects JSON Specification",
+  "module": "./dist/index.mjs",
+  "main": "./dist/index.js",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "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"
+    }
+  },
+  "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"
+  },
+  "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",
+    "eslint-plugin-promise": "^6.1.1",
+    "husky": "^7.0.4",
+    "lint-staged": "^11.2.6",
+    "mocha": "^10.2.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.70.1",
+    "rollup-plugin-livereload": "^2.0.5",
+    "rollup-plugin-serve": "^1.1.0",
+    "typescript": "^4.6.2"
+  },
+  "author": "Ant Group CO., Ltd.",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  }
+}