@galacean/effects-specification 0.0.1

package/dist/src/numberExpression.d.ts

@@ -0,0 +1,279 @@
+/*********************************************/
+/*********************************************/
+export declare enum ValueType {
+    /**
+     * 常数
+     */
+    CONSTANT = 0,
+    /**
+     * 二维常数向量
+     */
+    CONSTANT_VEC2 = 1,
+    /**
+     * 三维常数向量
+     */
+    CONSTANT_VEC3 = 2,
+    /**
+     * 四维常数向量
+     */
+    CONSTANT_VEC4 = 3,
+    /**
+     * 随机数
+     */
+    RANDOM = 4,
+    /**
+     * 直线
+     */
+    LINE = 5,
+    /**
+     * 曲线
+     */
+    CURVE = 6,
+    /**
+     * 贝塞尔路径
+     */
+    BEZIER_PATH = 7,
+    /**
+     * 颜色
+     */
+    RGBA_COLOR = 8,
+    /**
+     * 渐变色
+     */
+    GRADIENT_COLOR = 9,
+    /**
+     * 蒙版形状点集
+     */
+    SHAPE_POINTS = 10,
+    /**
+     * 蒙版形状切分
+     */
+    SHAPE_SPLITS = 11,
+    /**
+     *直线路径
+     */
+    LINEAR_PATH = 12,
+    /**
+     * 多色
+     */
+    COLORS = 13,
+    /**
+     * 二进制指针
+     */
+    BINARY = 20,
+    /**
+     * 贝塞尔曲线
+     */
+    BEZIER_CURVE = 21,
+    /**
+     * 贝塞尔曲线路径
+     */
+    BEZIER_CURVE_PATH = 22
+}
+export declare type vec2 = [x: number, y: number];
+export declare type vec3 = [x: number, y: number, z: number];
+export declare type vec4 = [x: number, y: number, z: number, w: number];
+export declare type mat2 = [m11: number, m12: number, m21: number, m22: number];
+export declare type mat3 = [
+    m11: number,
+    m12: number,
+    m13: number,
+    m21: number,
+    m22: number,
+    m23: number,
+    m31: number,
+    m32: number,
+    m33: number
+];
+export declare type mat4 = [
+    m11: number,
+    m12: number,
+    m13: number,
+    m14: number,
+    m21: number,
+    m22: number,
+    m23: number,
+    m24: number,
+    m31: number,
+    m32: number,
+    m33: number,
+    m34: number,
+    m41: number,
+    m42: number,
+    m43: number,
+    m44: number
+];
+/*********************************************/
+/*********************************************/
+export declare type FunctionExpression = LineValue | CurveValue | BezierValue;
+export declare type FixedNumberExpression = ConstantNumber | LineValue | CurveValue | BezierValue;
+export declare type NumberExpression = FixedNumberExpression | RandomValue;
+export declare type FixedVec3Expression = ConstantVec3 | BezierPath | LinearPath | BezierCurvePath;
+/**
+ * 常数数值
+ * [0,5]
+ * [1,[1,2]]
+ * [2,[1,2,3]]
+ */
+export declare type ConstantNumber = [type: ValueType.CONSTANT, value: number];
+export declare type ConstantVec2 = [type: ValueType.CONSTANT_VEC2, value: vec2];
+export declare type ConstantVec3 = [type: ValueType.CONSTANT_VEC3, value: vec3];
+export declare type ConstantVec4 = [type: ValueType.CONSTANT_VEC4, value: vec4];
+/**
+ * 随机数数值
+ */
+export declare type RandomValue = [type: ValueType.RANDOM, value: [min: number, max: number]];
+/**
+ * 直线段数值
+ */
+export declare type LineValue = [type: ValueType.LINE, value: [time: number, value: number][]];
+export declare type CurveEasingPoint = [time: number, value: number, tanIn: number, tanOut: number];
+/**
+ * 曲线段数值
+ */
+export declare type CurveValue = [type: ValueType.CURVE, value: CurveEasingPoint[]];
+/**
+ * 贝塞尔路径数值
+ */
+export declare type BezierPath = [type: ValueType.BEZIER_PATH, value: BezierPathValue];
+export declare type BezierPathValue = [
+    easing: CurveEasingPoint[],
+    points: vec3[],
+    controlPoints: vec3[]
+];
+export declare type LinearPath = [type: ValueType.LINEAR_PATH, value: LinearPathValue];
+export declare type LinearPathValue = [
+    easing: CurveEasingPoint[],
+    points: vec3[]
+];
+/**
+ * 关键帧类型
+ */
+export declare enum BezierKeyframeType {
+    AUTO = 0,
+    EASE = 1,
+    EASE_IN = 2,
+    EASE_OUT = 3,
+    LINE = 4,
+    HOLD = 5,
+    LINE_OUT = 6
+}
+/**
+ * 缓动关键帧数据（有三个点：左曲线控制点、曲线点、右曲线控制点，auto：自动关键帧）
+ */
+export declare type EaseKeyframeValue = [
+    type: BezierKeyframeType.EASE,
+    value: [x1: number, y1: number, x2: number, y2: number, x3: number, y3: number],
+    markType?: BezierKeyframeType
+];
+/**
+ * 缓入关键帧数据（有两个点：左曲线控制点、曲线点）
+ */
+export declare type EaseInKeyframeValue = [
+    type: BezierKeyframeType.EASE_IN,
+    value: [x1: number, y1: number, x2: number, y2: number],
+    markType?: BezierKeyframeType
+];
+/**
+ * 缓出关键帧数据（有两个点：曲线点、右曲线控制点）
+ */
+export declare type EaseOutKeyframeValue = [
+    type: BezierKeyframeType.EASE_OUT,
+    value: [x2: number, y2: number, x3: number, y3: number],
+    markType?: BezierKeyframeType
+];
+/**
+ * 线性关键帧数据（有一个点：曲线点）
+ */
+export declare type LineKeyframeValue = [
+    type: BezierKeyframeType.LINE,
+    value: [x2: number, y2: number],
+    markType?: BezierKeyframeType
+];
+/**
+ * 缓动定格出关键帧（有两个点：左曲线控制点、曲线点）
+ */
+export declare type EaseHoldOutKeyframeValue = [
+    type: BezierKeyframeType.HOLD,
+    value: [x1: number, y1: number, x2: number, y2: number],
+    markType: BezierKeyframeType.EASE_IN
+];
+/**
+ * 缓动定格出关键帧（有两个点：曲线点、右曲线控制点）
+ */
+export declare type EaseHoldInKeyframeValue = [
+    type: BezierKeyframeType.HOLD,
+    value: [x1: number, y1: number, x2: number, y2: number],
+    markType: BezierKeyframeType.EASE_OUT
+];
+/**
+ * 线性定格出关键帧（有一个点：曲线点）
+ */
+export declare type LineHoldOutKeyframeValue = [
+    type: BezierKeyframeType.HOLD,
+    value: [x2: number, y2: number],
+    markType: BezierKeyframeType.LINE
+];
+/**
+ * 线性定格进关键帧（有一个点：曲线点）
+ */
+export declare type LineHoldInKeyframeValue = [
+    type: BezierKeyframeType.HOLD,
+    value: [x2: number, y2: number],
+    markType: BezierKeyframeType.LINE_OUT
+];
+/**
+ * 定格进出关键帧（有一个点：曲线点）
+ */
+export declare type HoldInOutKeyframeValue = [
+    type: BezierKeyframeType.HOLD,
+    value: [x2: number, y2: number],
+    markType: BezierKeyframeType.HOLD
+];
+/**
+ * 定格关键帧
+ */
+export declare type HoldKeyframeValue = EaseHoldOutKeyframeValue | EaseHoldInKeyframeValue | LineHoldOutKeyframeValue | LineHoldInKeyframeValue | HoldInOutKeyframeValue;
+/**
+ * 贝塞尔关键帧值
+ */
+export declare type BezierKeyframeValue = EaseKeyframeValue | EaseInKeyframeValue | EaseOutKeyframeValue | LineKeyframeValue | HoldKeyframeValue;
+/**
+ * 贝塞尔关键帧
+ */
+export declare type BezierValue = [type: ValueType.BEZIER_CURVE, value: BezierKeyframeValue[]];
+/**
+ * 贝塞尔曲线路径关键帧值
+ */
+export declare type BezierCurvePathValue = [easing: BezierKeyframeValue[], points: vec3[], controlePoints: vec3[]];
+/**
+ * 贝塞尔曲线路径关键帧
+ */
+export declare type BezierCurvePath = [type: ValueType.BEZIER_CURVE_PATH, value: BezierCurvePathValue];
+/*********************************************/
+/*********************************************/
+export declare type ColorExpression = RGBAColor | GradientColor | RGBAColors;
+/**
+ * rgba range in [0,255]
+ */
+export declare type RGBAColorValue = [r: number, g: number, b: number, a: number];
+/**
+ * 颜色数值
+ */
+export declare type RGBAColor = [type: ValueType.RGBA_COLOR, value: RGBAColorValue];
+/**
+ * 渐变色数值
+ */
+export declare type GradientStop = [stop: number, r: number, g: number, b: number, a: number];
+export declare type GradientColor = [type: ValueType.GRADIENT_COLOR, value: GradientStop[]];
+export declare type RGBAColors = [type: ValueType.COLORS, value: RGBAColorValue[]];
+/*********************************************/
+/*********************************************/
+/**
+ * 蒙版形状控制点数值
+ */
+export declare type ShapePoints = [type: ValueType.SHAPE_POINTS, value: [x: number, y: number, xIn: number, yIn: number, xOut: number, yOut: number][]];
+/**
+ * 蒙版形状采样分割点数值
+ */
+export declare type ShapeSplits = [type: ValueType.SHAPE_SPLITS, value: number[][]];

package/dist/src/scene.d.ts

@@ -0,0 +1,92 @@
+import type { Composition } from './composition';
+import type { SpineResource } from './item/spine-item';
+import type { PlayerVersion, Shape } from './type';
+import type { TemplateImage, Image, CompressedImage, TextureDefine } from './image';
+import type { FontBase, FontDefine } from './text';
+import type { BinaryFile } from './binary';
+/**
+ * 场景信息
+ * 素材信息存放于统一数据结构中
+ */
+export interface JSONScene {
+    /************** 文件版本不是 Player 版本，应用于文件变更后在 editor/player 中加载时的分类处理 **************/
+    /**
+     * JSON 版本
+     *
+     * 1.1 增加数据模板 https://yuque.antfin.com/ndl7nd/mars/ib13fw
+     * 1.2 增加 anchor https://yuque.antfin.com/ndl7nd/mars/dyccyr
+     * 1.3 增加二进制文件格式
+     * 1.5 增加 Spine 数据
+     * 2.0 改造升级
+     * 2.1 增加文本元素
+     */
+    version: '1.0' | '1.1' | '1.2' | '1.3' | '1.5' | '1.8' | '2.0' | '2.1';
+    /**
+     * 播放器版本信息
+     */
+    playerVersion: PlayerVersion;
+    /**
+     * 类型为 Galacean Effects
+     */
+    type: 'ge';
+    /*************************************** 用于加载 json 后复原合成 **************************************/
+    /**
+     * 选中合成ID
+     * 如果没有设置，选择合成中的第一个
+     */
+    compositionId?: string;
+    /**
+     * 渲染所需合成列表
+     */
+    compositions: Composition[];
+    /******************************** 以下皆为可复用信息，加载在对应 Manager 中 *******************************/
+    /**
+     * 贴图信息
+     */
+    images: (TemplateImage | Image | CompressedImage)[];
+    /**
+     * 根据合成ID，每个合成用到的 image 的数组索引
+     */
+    imgUsage?: Record<string, number[]>;
+    /**
+     * 根据合成id，每个合成用到的 bin 的数组索引
+     */
+    binUsage?: Record<string, number[]>;
+    /**
+     * 蒙版形状信息
+     */
+    shapes: Shape[];
+    /**
+     * 插件类型信息
+     * 'model@1.0'
+     */
+    plugins: string[];
+    /**
+     * 保留字段
+     */
+    requires: SceneRequire[];
+    /**
+     * 字体资源
+     * 数据模板下掉可以不要 FontBase[]
+     */
+    fonts?: FontBase[] | FontDefine[];
+    /**
+     * spine 资源
+     * @version 1.5
+     */
+    spines?: SpineResource[];
+    /**
+     * 二进制文件地址
+     * @version 1.3
+     */
+    bins?: BinaryFile[];
+    /**
+     * textures 配置
+     * 从 v1.3 开始，images 数组会对应创建 textures 数组
+     */
+    textures?: TextureDefine[];
+}
+/**
+ * 如果是内置模块，但是需要额外的代码引入，比如滤镜则会加入 requires 数组中
+ */
+export declare type SceneRequire = 'filter';

package/dist/src/text.d.ts

@@ -0,0 +1,183 @@
+import type { RGBAColor } from './numberExpression';
+export interface StringTemplate {
+    fonts: FontBase[];
+    texts: Text[];
+    colors: RGBAColor[];
+}
+/**
+ * 字体资源
+ * @version 2.3
+ */
+export interface FontDefine {
+    /**
+     * 字体资源链接
+     */
+    fontURL: string;
+    /**
+     * 字体名称
+     */
+    fontFamily: string;
+}
+export interface FontBase {
+    /**
+     * 字体
+     * @default "serif"
+     */
+    family?: string;
+    /**
+     * 像素单位（unit px）
+     * @default 16
+     */
+    size?: number;
+    /**
+     * @default 400
+     */
+    weight?: number;
+    /**
+     * index to fonts array, if set it inherits properties
+     * 字体属性继承
+     * 如果设置了会继承指定的字体属性
+     */
+    extends?: number;
+    /**
+     * url to download font file
+     * 字体文件下载地址
+     */
+    url?: string;
+    /**
+     * font style
+     * @default 0
+     */
+    style?: FontStyle;
+    /**
+     * space between 2 chars
+     * 字间距，两个字符（包括数字，英文和空格等特殊字符）的像素距离
+     * @default 0
+     */
+    letterSpace?: number;
+}
+export interface Text {
+    x: number;
+    y: number;
+    /**
+     * 变量名
+     */
+    n?: string;
+    /**
+     * content,
+     * 文字内容，如果包含 $var$ 样式，内容将被替换
+     */
+    t: string;
+    /**
+     * width, if not provide use canvas.measureText() to get width
+     * 文字最大宽度，如果不设置，由系统进行计算
+     */
+    w?: number;
+    /**
+     * font, index to fonts array
+     * 字体，指向字体数组
+     * @default 0
+     */
+    f?: number;
+    /**
+     * textAlignment
+     * 字体排列
+     * @default 0
+     */
+    a?: TextAlignment;
+    /**
+     * index to color array
+     * 字体颜色，指向数组
+     */
+    c?: number;
+    /**
+     * 当文字超过最大宽度时，文字的表现行为
+     * 仅当设置文字最大宽度后生效
+     * @default 0
+     */
+    of?: TextOverflow;
+    /**
+     * 当文字overflow为ellipsis时的替换符号
+     * @default ".."
+     */
+    et?: string;
+}
+export declare enum TextOverflow {
+    /**
+     * display 模式下，会显示所有文本，存在文本超过边界框的情况。
+     */
+    display = 0,
+    /**
+     * clip 模式下，当文本内容超出边界框时，多余的会被截断。
+     */
+    clip = 1,
+    /**
+     * ellipsis 模式下，会使用（...）来代替超出边界框的内容。
+     */
+    ellipsis = 2
+}
+export declare enum TextBaseline {
+    /**
+     * 文本顶对齐。
+     */
+    top = 0,
+    /**
+     * 文本垂直居中对齐。
+     */
+    middle = 1,
+    /**
+     * 文本底对齐。
+     */
+    bottom = 2
+}
+export declare enum TextAlignment {
+    /**
+     * text alignment starts from（x,y) to right direction
+     * 从(x,y)开始第一个字符，向右边延伸
+     */
+    left = 0,
+    /**
+     * (x,y) is middle position of text, where (left + right)/2 =(x,y)
+     * (x,y) 为文字中间位置，（最左位置 + 最右位置)/2 = (x,y)
+     */
+    middle = 1,
+    /**
+     * text alignment ends with（x,y) from left direction
+     * 从(x,y)结束最后一个字符，向左边延伸
+     */
+    right = 2
+}
+/**
+ * 文本字重
+ */
+export declare enum TextWeight {
+    /**
+     * 正常
+     */
+    normal = "normal",
+    /**
+     * 粗体
+     */
+    bold = "bold",
+    /**
+     * 瘦体
+     */
+    lighter = "lighter"
+}
+/**
+ * 文本样式
+ */
+export declare enum FontStyle {
+    /**
+     * 正常
+     */
+    normal = "normal",
+    /**
+     * 斜体
+     */
+    italic = "italic",
+    /**
+     * 倾斜体
+     */
+    oblique = "oblique"
+}