@galacean/effects-specification 0.0.1

package/dist/src/item/particle-shape.d.ts

@@ -0,0 +1,212 @@
+import type { ShapeType } from '../type';
+import type { NumberExpression, vec3 } from '../numberExpression';
+export declare enum ShapeArcMode {
+    /**
+     * 随机
+     */
+    RANDOM = 0,
+    /**
+     * 单向循环
+     */
+    UNIDIRECTIONAL_CYCLE = 1,
+    /**
+     * 双向循环
+     */
+    BIDIRECTIONAL_CYCLE = 2,
+    /**
+     * 均匀爆发
+     */
+    UNIFORM_BURST = 3
+}
+export interface ParticleShapeBase {
+    /**
+     * 粒子形状类型
+     */
+    type: ShapeType;
+    /**
+     * 发射模式
+     */
+    arcMode: ShapeArcMode;
+    /**
+     * 运动对齐开关
+     */
+    alignSpeedDirection?: boolean;
+    /**
+     * 向上方向
+     */
+    upDirection?: vec3;
+    /**
+     * 发射方向旋转
+     */
+    turbulenceX?: NumberExpression;
+    turbulenceY?: NumberExpression;
+    turbulenceZ?: NumberExpression;
+}
+export interface ParticleShapeNone {
+    type: ShapeType.NONE;
+    /**
+     * 发射方向旋转
+     */
+    turbulenceX?: NumberExpression;
+    turbulenceY?: NumberExpression;
+    turbulenceZ?: NumberExpression;
+    upDirection?: number[];
+}
+export declare type ParticleShape = ParticleShapeCone | ParticleShapeCircle | ParticleShapeSphere | ParticleShapeHemisphere | ParticleShapeDonut | ParticleShapeRect | ParticleShapeRectEdge | ParticleShapeTexture | ParticleShapeEdge | ParticleShapeNone;
+/**
+ * 圆锥发射器
+ */
+export interface ParticleShapeCone extends ParticleShapeBase {
+    type: ShapeType.CONE;
+    /**
+     * 形状角度
+     */
+    angle: number;
+    /**
+     * 形状半径
+     */
+    radius: number;
+    /**
+     * 形状曲率
+     */
+    arc: number;
+}
+/**
+ * 圆发射器
+ */
+export interface ParticleShapeCircle extends ParticleShapeBase {
+    type: ShapeType.CIRCLE;
+    /**
+     * 形状半径
+     */
+    radius: number;
+    /**
+     * 形状曲率
+     */
+    arc: number;
+}
+/**
+ * 圆球发射器
+ */
+export interface ParticleShapeSphere extends ParticleShapeBase {
+    type: ShapeType.SPHERE;
+    /**
+     * 形状半径
+     */
+    radius: number;
+    /**
+     * 形状曲率
+     */
+    arc: number;
+}
+/**
+ * 半球发射器
+ */
+export interface ParticleShapeHemisphere extends ParticleShapeBase {
+    type: ShapeType.HEMISPHERE;
+    /**
+     * 形状半径
+     */
+    radius: number;
+    /**
+     * 形状曲率
+     */
+    arc: number;
+}
+/**
+ * 圆环发射器
+ */
+export interface ParticleShapeDonut extends ParticleShapeBase {
+    type: ShapeType.DONUT;
+    /**
+     * 形状半径
+     */
+    radius: number;
+    /**
+     * 圆环半径
+     */
+    donutRadius: number;
+    /**
+     * 形状曲率
+     */
+    arc: number;
+}
+/**
+ * 矩形发射器
+ */
+export interface ParticleShapeRect extends ParticleShapeBase {
+    type: ShapeType.RECTANGLE;
+    /**
+     * 宽度
+     */
+    width: number;
+    /**
+     * 高度
+     */
+    height: number;
+}
+/**
+ * 矩形框发射器
+ */
+export interface ParticleShapeRectEdge extends ParticleShapeBase {
+    type: ShapeType.RECTANGLE_EDGE;
+    /**
+     * 宽度
+     */
+    width: number;
+    /**
+     * 高度
+     */
+    height: number;
+}
+/**
+ * 直线发射器
+ */
+export interface ParticleShapeEdge extends ParticleShapeBase {
+    type: ShapeType.EDGE;
+    /**
+     * 宽度
+     */
+    width: number;
+}
+/**
+ * 贴图发射器
+ */
+export interface ParticleShapeTexture extends ParticleShapeBase {
+    type: ShapeType.TEXTURE;
+    detail: ParticleTextureShapeDetail;
+    /**
+     * 贴图随机数
+     */
+    random: number;
+    /**
+     * 宽度
+     */
+    width: number;
+    /**
+     * 高度
+     */
+    height: number;
+}
+/**
+ * 贴图形状数据
+ */
+export interface ParticleTextureShapeDetail {
+    /**
+     * 贴图形状宽度
+     */
+    width: number;
+    /**
+     * 贴图形状高度
+     */
+    height: number;
+    /**
+     * 编辑器参数
+     * 对于图片栅格化时，像素区域的大小
+     */
+    block: [number, number];
+    /**
+     * 贴图形状点
+     */
+    anchors: number[];
+}

package/dist/src/item/plugin-item.d.ts

@@ -0,0 +1,46 @@
+import type { ItemType, PluginGyroscopeTarget, PluginType, RendererOptions } from '../type';
+import type { BaseItem, ItemEndBehavior } from './base-item';
+/**
+ * 插件元素
+ */
+export interface PluginItem extends BaseItem {
+    /**
+     * 元素类型[指定为plugin]
+     */
+    type: ItemType.plugin;
+    /**
+     * 插件元素渲染信息
+     */
+    content: PluginContent;
+    endBehavior: ItemEndBehavior;
+}
+/**
+ * 插件元素渲染属性
+ */
+export interface PluginContent {
+    /**
+     * 插件元素基础属性
+     */
+    options: PluginOption;
+    /**
+     * 插件元素渲染属性
+     */
+    renderer: RendererOptions;
+}
+/**
+ * 插件元素基础属性
+ */
+export declare type PluginOption = PluginGyroscopeOption;
+/**
+ * 陀螺仪插件基础属性
+ */
+export interface PluginGyroscopeOption {
+    /**
+     * 插件类型
+     */
+    type: PluginType.GYROSCOPE;
+    /**
+     * 陀螺仪属性
+     */
+    targets: PluginGyroscopeTarget[];
+}

package/dist/src/item/spine-item.d.ts

@@ -0,0 +1,93 @@
+import type { BinaryPointer } from '../binary';
+import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType } from '../type';
+import type { BaseItem, ItemEndBehavior } from './base-item';
+/**
+ * 插件元素
+ */
+export interface SpineItem extends BaseItem {
+    /**
+       * 元素类型 "spine"
+       */
+    type: ItemType.spine;
+    /**
+       * 插件元素渲染信息
+       */
+    content: SpineContent;
+    endBehavior: ItemEndBehavior;
+}
+/**
+ * Spine元素渲染属性
+ */
+export interface SpineContent {
+    /**
+     * Spine元素基础属性
+     */
+    options: PluginSpineOption;
+    /**
+     * Spine元素材质渲染属性
+     */
+    renderer?: RendererOptions;
+    /**
+     * Spine元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * Spine元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * Spine元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * Spine元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+}
+/**
+ * Spine 插件属性
+ */
+export interface PluginSpineOption {
+    /**
+       * 当前使用的皮肤名称
+       */
+    activeSkin: string;
+    /**
+       * 当前使用的动画列表，1.5之前为 string
+       */
+    activeAnimation: string[] | string;
+    /**
+       * 在 spines 资源数组中的索引
+       */
+    spine: number;
+    /**
+     * 默认融合时间
+     */
+    mixDuration?: number;
+    /**
+     * 动画播放的速度
+     */
+    speed?: number;
+}
+/**
+ * spine资源信息
+ */
+export declare type skeletonFileType = 'json' | 'skel';
+export interface SpineResource {
+    /**
+       * atlas 文件在 `bins` 中的指针
+       */
+    atlas: BinaryPointer;
+    /**
+       * 骨骼文件
+       */
+    skeleton: BinaryPointer;
+    /**
+       * skeleton 文件类型, `.skel/.json`
+       */
+    skeletonType: skeletonFileType;
+    /**
+       * 图像文件在 `scene.textures` 数组中的索引
+       */
+    images: number[];
+}

package/dist/src/item/sprite-item.d.ts

@@ -0,0 +1,71 @@
+import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, SplitParameter, InteractBehavior } from '../type';
+import type { RGBAColorValue } from '../numberExpression';
+/**
+ * 图层元素
+ */
+export interface SpriteItem extends BaseItem {
+    /**
+     * 元素类型[指定为sprite]
+     */
+    type: ItemType.sprite;
+    /**
+     * 图层元素渲染信息
+     */
+    content: SpriteContent;
+    endBehavior: ItemEndBehavior;
+}
+export interface SpriteContentOptions {
+    /**
+     * 元素基础颜色
+     * @default [255,255,255,255]
+     */
+    startColor?: RGBAColorValue;
+}
+/**
+ * 图层元素渲染属性
+ */
+export interface SpriteContent {
+    /**
+     * added by loader
+     * @default null
+     */
+    splits?: SplitParameter[];
+    /**
+     * 图层元素基础属性
+     */
+    options: SpriteContentOptions;
+    /**
+     * 图层元素材质渲染属性
+     */
+    renderer: RendererOptions;
+    /**
+     * 图层元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 图层元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 图层元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 图层元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 图层元素贴图变化属性
+     */
+    textureSheetAnimation?: TextureSheetAnimation;
+    /**
+     * 图层交互
+     */
+    interaction?: {
+        /**
+         * 交互行为
+         */
+        behavior: InteractBehavior;
+    };
+}

package/dist/src/item/text-item.d.ts

@@ -0,0 +1,172 @@
+import type { BaseItem, ItemEndBehavior } from './base-item';
+import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, ItemType, TextureSheetAnimation, RendererOptions, InteractBehavior } from '../type';
+import type { RGBAColorValue } from '../numberExpression';
+import type { FontStyle, TextAlignment, TextBaseline, TextOverflow, TextWeight } from 'src/text';
+/**
+ * 文本元素
+ */
+export interface TextItem extends BaseItem {
+    /**
+     * 元素类型[指定为text]
+     */
+    type: ItemType.text;
+    /**
+     * 文本元素渲染信息
+     */
+    content: TextContent;
+    endBehavior: ItemEndBehavior;
+}
+export interface TextContentOptions {
+    /**
+     * 文本内容
+     */
+    text: string;
+    /**
+     * 字体大小
+     * @default 40
+     */
+    fontSize: number;
+    /**
+     * 文本颜色
+     * @default [1,1,1,1]
+     */
+    textColor?: RGBAColorValue;
+    /**
+     * 文本字体
+     * @default 'Arial'
+     */
+    fontFamily?: string;
+    /**
+     * 文本间隔
+     * @default 0
+     */
+    letterSpace?: number;
+    /**
+     * 上下对齐方式
+     * @default TextBaseline.middle
+     */
+    textBaseline?: TextBaseline;
+    /**
+     * 左右对齐方式
+     * @default TextAlignment.left
+     */
+    textAlign?: TextAlignment;
+    /**
+     * 文本固定宽度（和自适应宽高冲突）
+     * @default 31
+     */
+    textWidth?: number;
+    /**
+     * 文本行高
+     * @default 31
+     */
+    lineHeight?: number;
+    /**
+     * 文本高度
+     * @default 31
+     */
+    textHeight?: number;
+    /**
+     * 自适应宽高开关（和文本固定宽度冲突）
+     * @default false
+     */
+    autoWidth?: boolean;
+    /**
+     * 文本字重
+     * @default TextWeight.normal
+     */
+    fontWeight?: TextWeight;
+    /**
+     * 文本样式
+     * @default FontStyle.normal
+     */
+    fontStyle?: FontStyle;
+    /**
+     * 当文字超过最大宽度时，文字的表现行为
+     * 仅当设置文字最大宽度后生效
+     * @default TextOverflow.display
+     */
+    textOverflow?: TextOverflow;
+    /**
+     * 文本外描边
+     */
+    outline?: {
+        /**
+         * 外描边颜色
+         * @default [1,1,1,0]
+         */
+        outlineColor?: RGBAColorValue;
+        /**
+         * 外描边宽度
+         * @default 1
+         */
+        outlineWidth?: number;
+    };
+    /**
+     * 文本阴影
+     */
+    shadow?: {
+        /**
+         * 文本阴影颜色
+         * @default [0,0,0,0]
+         */
+        shadowColor?: RGBAColorValue;
+        /**
+         * 阴影模糊
+         * @default 2
+         */
+        shadowBlur?: number;
+        /**
+         * 阴影水平偏移距离
+         * @default 0
+         */
+        shadowOffsetX?: number;
+        /**
+         * 阴影高度偏移距离
+         * @default 0
+         */
+        shadowOffsetY?: number;
+    };
+}
+/**
+ * 文本元素渲染属性
+ */
+export interface TextContent {
+    /**
+     * 文本元素基础属性
+     */
+    options: TextContentOptions;
+    /**
+     * 文本元素材质渲染属性
+     */
+    renderer: RendererOptions;
+    /**
+     * 文本元素大小变化属性
+     */
+    sizeOverLifetime?: SizeOverLifetime;
+    /**
+     * 文本元素旋转变化属性
+     */
+    rotationOverLifetime?: RotationOverLifetime;
+    /**
+     * 文本元素位置变化属性
+     */
+    positionOverLifetime?: PositionOverLifetime;
+    /**
+     * 文本元素色彩变化属性
+     */
+    colorOverLifetime?: ColorOverLifetime;
+    /**
+     * 文本元素贴图变化属性
+     */
+    textureSheetAnimation?: TextureSheetAnimation;
+    /**
+     * 图层交互
+     */
+    interaction?: {
+        /**
+         * 交互行为
+         */
+        behavior: InteractBehavior;
+    };
+}

package/dist/src/item.d.ts

@@ -0,0 +1,17 @@
+import type { NullItem } from './item/null-item';
+import type { SpineItem } from './item/spine-item';
+import type { SpriteItem } from './item/sprite-item';
+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';
+/**
+ * Item Interface，
+ * 1.0版本
+ * 基类，无对应元素
+ */
+export declare 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'>;