@galacean/effects-specification 2.1.0-beta.0 → 2.2.0-alpha.0

package/es/item/audio-item.d.ts

@@ -0,0 +1,46 @@
+import type { ComponentData, DataPath } from '../components';
+import type { ItemType } from '../type';
+import type { BaseItem } from './base-item';
+/**
+ * 音频元素
+ */
+export interface AudioItem extends BaseItem {
+    /**
+     * 元素类型（指定为 audio）
+     */
+    type: ItemType.audio;
+    /**
+     * 音频元素基础属性
+     */
+    content: AudioComponentData;
+}
+export interface AudioContentOptions {
+    /**
+     * 音频链接，索引到 scene 中的 audios 数组
+     */
+    audio: DataPath;
+    /**
+     * 音频播放速度
+     * @default 1
+     */
+    playbackRate?: number;
+    /**
+     * 是否静音播放
+     * @default false
+     */
+    muted?: boolean;
+    /**
+     * 音频音量大小
+     * @default 1
+     */
+    volume?: number;
+}
+/**
+ * 音频组件属性
+ */
+export interface AudioComponentData extends ComponentData {
+    /**
+     * 音频元素基础属性
+     */
+    options: AudioContentOptions;
+}

package/es/item/audio-item.js

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

package/es/item/base-item.d.ts

@@ -1,4 +1,5 @@
 import type { BinaryEnv } from '../binary';
+import type { Vector2Data, Vector3Data } from '../math';
 import type { vec3, vec4 } from '../number-expression';
 import type { ItemType, RenderLevel } from '../type';
 import type { CameraContent } from './camera-item';
@@ -9,6 +10,7 @@ import type { ModelLightContent, ModelMeshItemContent, ModelTreeContent, SkyboxC
 import type { NullContent } from './null-item';
 import type { ParticleContent } from './particle-item';
 import type { PluginContent } from './plugin-item';
+import type { RichTextContent } from './rich-text-item';
 import type { SpineContent } from './spine-item';
 import type { SpriteContent } from './sprite-item';
 import type { TextContent } from './text-item';
@@ -126,15 +128,6 @@ export interface BaseItemTransform {
      */
     quat?: vec4;
 }
-export interface Vector3Data {
-    x: number;
-    y: number;
-    z: number;
-}
-export interface Vector2Data {
-    x: number;
-    y: number;
-}
 export interface TransformData {
     position: Vector3Data;
     eulerHint: Vector3Data;
@@ -142,4 +135,4 @@ export interface TransformData {
     size?: Vector2Data;
     anchor?: Vector2Data;
 }
-export type BaseContent = SpriteContent | ParticleContent | NullContent | InteractContent | PluginContent | CompositionContent | CameraContent | TextContent | SpineContent | EffectContent | ModelTreeContent<BinaryEnv> | ModelMeshItemContent<BinaryEnv> | ModelLightContent | SkyboxContent<BinaryEnv> | any;
+export type BaseContent = SpriteContent | ParticleContent | NullContent | InteractContent | PluginContent | CompositionContent | CameraContent | TextContent | RichTextContent | SpineContent | EffectContent | ModelTreeContent<BinaryEnv> | ModelMeshItemContent<BinaryEnv> | ModelLightContent | SkyboxContent<BinaryEnv> | any;

package/es/item/effect-item.d.ts

@@ -1,3 +1,4 @@
+import type { ComponentData, DataPath } from '../components';
 import type { ItemType, PositionOverLifetime, RotationOverLifetime, SizeOverLifetime } from '../type';
 import type { BaseItem, EndBehavior } from './base-item';
 /**
@@ -33,3 +34,8 @@ export interface EffectContent {
      */
     positionOverLifetime?: PositionOverLifetime;
 }
+export interface EffectComponentData extends ComponentData {
+    _priority: number;
+    materials: DataPath[];
+    geometry: DataPath;
+}

package/es/item/interact-item.d.ts

@@ -28,11 +28,7 @@ export interface InteractContent {
 /**
  * 交互元素渲染属性
  */
-export interface InteractComponentData extends ComponentData {
-    /**
-     * 交互元素基础属性
-     */
-    options: InteractOption;
+export interface InteractComponentData extends ComponentData, InteractContent {
 }
 /**
  * 交互元素基础属性

package/es/item/model/light.d.ts

@@ -1,7 +1,8 @@
 import type { RGBAColorValue } from '../../number-expression';
 import type { BaseItem, EndBehavior } from '../base-item';
 import type { RotationOverLifetime, PositionOverLifetime, ItemType } from '../../type';
-import type { ColorData, ComponentData } from '../../components';
+import type { ComponentData } from '../../components';
+import type { ColorData } from '../../math';
 export interface ModelLightBaseOptions {
     /**
      * 挂靠的父节点
@@ -116,4 +117,8 @@ export interface ModelLightComponentData extends ComponentData {
      * @default 45度
      */
     outerConeAngle?: number;
+    /**
+     * 跟随相机
+     */
+    followCamera?: boolean;
 }

package/es/item/model/render.d.ts

@@ -37,5 +37,9 @@ export declare enum RenderMode3D {
     /**
      * 自发光
      */
-    emissive = "emissive"
+    emissive = "emissive",
+    /**
+     * 漫反射
+     */
+    diffuse = "diffuse"
 }

package/es/item/model/render.js

@@ -39,4 +39,8 @@ export var RenderMode3D;
      * 自发光
      */
     RenderMode3D["emissive"] = "emissive";
+    /**
+     * 漫反射
+     */
+    RenderMode3D["diffuse"] = "diffuse";
 })(RenderMode3D || (RenderMode3D = {}));

package/es/item/model/skybox.d.ts

@@ -2,7 +2,8 @@ import type { BaseItem, EndBehavior } from '../base-item';
 import type { BinaryEnv } from '../../binary';
 import type { SkyboxCubeTexturePointer } from './binary';
 import type { ItemType } from '../../type';
-import type { ComponentData, DataPath, Vector4Data } from '../../components';
+import type { ComponentData, DataPath } from '../../components';
+import type { Vector4Data } from '../../math';
 export interface SkyboxOptions<T extends BinaryEnv> {
     /**
      * 环境光旋转
@@ -56,16 +57,6 @@ export interface ModelSkyboxItem<T extends BinaryEnv> extends BaseItem {
  * bins:[{url:'https://big/bin/'}]
  */
 export interface SkyboxComponentOptions {
-    renderable: boolean;
-    intensity: number;
-    reflectionsIntensity: number;
-    irradianceCoeffs?: number[];
-    diffuseImage?: DataPath;
-    specularImage: DataPath;
-    specularImageSize: number;
-    specularMipCount: number;
-}
-export interface SkyboxComponentData extends ComponentData {
     /**
      * Skybox 是否渲染，UI显示"可见"
      */
@@ -99,3 +90,5 @@ export interface SkyboxComponentData extends ComponentData {
      */
     specularMipCount: number;
 }
+export interface SkyboxComponentData extends ComponentData, SkyboxComponentOptions {
+}

package/es/item/model/tree.d.ts

@@ -25,40 +25,40 @@ export interface ModelAnimationOptions<T extends BinaryEnv> {
     tracks: ModelAnimTrackOptions<T>[];
 }
 /**
- * 3D场景树属性，包含动画数据
+ * 3D 场景树属性，包含动画数据
  */
 export interface ModelTreeOptions<T extends BinaryEnv> extends TreeOptions {
     /**
-     * 默认动画索引，-1表示不播放动画
+     * 默认动画索引，-1 表示不播放动画
      */
     animation?: number;
     /**
-     * 3D场景树中所有的动画数据
+     * 3D 场景树中所有的动画数据
      */
     animations?: ModelAnimationOptions<T>[];
 }
 export interface ModelTreeContent<T extends BinaryEnv> {
     /**
-     * 3D场景树元素基础属性
+     * 3D 场景树元素基础属性
      */
     options: {
         tree: ModelTreeOptions<T>;
     };
     /**
-     * 3D场景树元素大小变化属性
+     * 3D 场景树元素大小变化属性
      */
     sizeOverLifetime?: SizeOverLifetime;
     /**
-     * 3D场景树元素旋转变化属性
+     * 3D 场景树元素旋转变化属性
      */
     rotationOverLifetime?: RotationOverLifetime;
     /**
-     * 3D场景树元素位置变化属性
+     * 3D 场景树元素位置变化属性
      */
     positionOverLifetime?: PositionOverLifetime;
 }
 /**
- * 3D场景树元素
+ * 3D 场景树元素
  */
 export interface ModelTreeItem<T extends BinaryEnv> extends BaseItem {
     type: ItemType.tree;
@@ -77,21 +77,21 @@ export interface ModelAnimationData {
 }
 export interface ModelAnimationComponentData extends ComponentData {
     /**
-     * 默认动画索引，-1表示不播放动画
+     * 默认动画索引，-1 表示不播放动画
      */
     animation?: number;
     /**
-     * 3D场景树中所有的动画数据
+     * 3D 场景树中所有的动画数据
      */
     animations: ModelAnimationData[];
 }
 export interface AnimationComponentData extends ComponentData {
     /**
-     * 默认动画索引，-1表示不播放动画
+     * 默认动画索引，-1 表示不播放动画
      */
     animation?: number;
     /**
-     * glTF中所有的动画数据
+     * glTF 中所有的动画数据
      */
     animationClips: DataPath[];
 }

package/es/item/particle-item.d.ts

@@ -2,7 +2,7 @@ import type { ItemType, RendererOptions, TextureSheetAnimation, BlendingMode, Sp
 import type { FixedNumberExpression, NumberExpression, GradientColor, vec3, FixedVec3Expression, ColorExpression, FunctionExpression } from '../number-expression';
 import type { BaseItem, EndBehavior } from './base-item';
 import type { ParticleShape } from './particle-shape';
-import type { ComponentData } from '../components';
+import type { ComponentData, DataPath } from '../components';
 /**
  * 粒子交互行为
  */
@@ -337,72 +337,7 @@ export interface ParticleContent {
 /**
  * 粒子元素渲染属性
  */
-export interface ParticleSystemData extends ComponentData {
-    splits?: SplitParameter[];
-    /**
-     * 粒子元素基础属性
-     */
-    options: ParticleOptions;
-    /**
-     * 粒子元素材质渲染属性
-     */
-    renderer: RendererOptions;
-    /**
-     * 粒子元素发射器形状属性
-     */
-    shape?: ParticleShape;
-    /**
-     * 粒子元素发射参数属性
-     */
-    emission: ParticleEmission;
-    /**
-     * 粒子元素大小变化属性
-     */
-    sizeOverLifetime?: ParticleSizeOverLifetime;
-    /**
-     * 发射器 transform 变化
-     */
-    emitterTransform?: {
-        /**
-         * 位置变化
-         */
-        path?: FixedVec3Expression;
-    };
-    positionOverLifetime?: ParticlePositionOverLifetime;
-    /**
-     * 粒子元素旋转变化属性
-     */
-    rotationOverLifetime?: ParticleRotationOverLifetime;
-    /**
-     * 粒子元素色彩变化属性
-     */
-    colorOverLifetime?: ParticleColorOverLifetime;
-    /**
-     * 粒子元素贴图变化属性
-     */
-    textureSheetAnimation?: ParticleTextureSheetAnimation;
-    /**
-     * 粒子元素拖尾参数
-     */
-    trails?: ParticleTrail;
-    /**
-     * 粒子元素交互参数
-     */
-    interaction?: {
-        /**
-         * 交互行为
-         */
-        behavior?: ParticleInteractionBehavior;
-        /**
-         * 重叠元素响应开关
-         */
-        multiple?: boolean;
-        /**
-         * ray cast 射线拾取时 sphere 的半径
-         * @default 0.4
-         */
-        radius?: number;
-    };
+export interface ParticleSystemData extends ComponentData, ParticleContent {
 }
 /**
  * 粒子拖尾参数
@@ -472,7 +407,7 @@ export interface ParticleTrail {
     /**
      * 拖尾贴图
      */
-    texture?: number;
+    texture?: DataPath;
     /**
      * 位置受父节点影响
      * 拖尾+图层绑定同一个父节点时使用

package/es/item/particle-shape.d.ts

@@ -1,4 +1,4 @@
-import type { ShapeType } from '../type';
+import type { ParticleEmitterShapeType } from '../type';
 import type { NumberExpression, vec3 } from '../number-expression';
 export declare enum ShapeArcMode {
     /**
@@ -22,7 +22,7 @@ export interface ParticleShapeBase {
     /**
      * 粒子形状类型
      */
-    type: ShapeType;
+    type: ParticleEmitterShapeType;
     /**
      * 发射模式
      */
@@ -43,7 +43,7 @@ export interface ParticleShapeBase {
     turbulenceZ?: NumberExpression;
 }
 export interface ParticleShapeNone {
-    type: ShapeType.NONE;
+    type: ParticleEmitterShapeType.NONE;
     /**
      * 发射方向旋转
      */
@@ -57,7 +57,7 @@ export type ParticleShape = ParticleShapeCone | ParticleShapeCircle | ParticleSh
  * 圆锥发射器
  */
 export interface ParticleShapeCone extends ParticleShapeBase {
-    type: ShapeType.CONE;
+    type: ParticleEmitterShapeType.CONE;
     /**
      * 形状角度
      */
@@ -75,7 +75,7 @@ export interface ParticleShapeCone extends ParticleShapeBase {
  * 圆发射器
  */
 export interface ParticleShapeCircle extends ParticleShapeBase {
-    type: ShapeType.CIRCLE;
+    type: ParticleEmitterShapeType.CIRCLE;
     /**
      * 形状半径
      */
@@ -89,7 +89,7 @@ export interface ParticleShapeCircle extends ParticleShapeBase {
  * 圆球发射器
  */
 export interface ParticleShapeSphere extends ParticleShapeBase {
-    type: ShapeType.SPHERE;
+    type: ParticleEmitterShapeType.SPHERE;
     /**
      * 形状半径
      */
@@ -103,7 +103,7 @@ export interface ParticleShapeSphere extends ParticleShapeBase {
  * 半球发射器
  */
 export interface ParticleShapeHemisphere extends ParticleShapeBase {
-    type: ShapeType.HEMISPHERE;
+    type: ParticleEmitterShapeType.HEMISPHERE;
     /**
      * 形状半径
      */
@@ -117,7 +117,7 @@ export interface ParticleShapeHemisphere extends ParticleShapeBase {
  * 圆环发射器
  */
 export interface ParticleShapeDonut extends ParticleShapeBase {
-    type: ShapeType.DONUT;
+    type: ParticleEmitterShapeType.DONUT;
     /**
      * 形状半径
      */
@@ -135,7 +135,7 @@ export interface ParticleShapeDonut extends ParticleShapeBase {
  * 矩形发射器
  */
 export interface ParticleShapeRect extends ParticleShapeBase {
-    type: ShapeType.RECTANGLE;
+    type: ParticleEmitterShapeType.RECTANGLE;
     /**
      * 宽度
      */
@@ -149,7 +149,7 @@ export interface ParticleShapeRect extends ParticleShapeBase {
  * 矩形框发射器
  */
 export interface ParticleShapeRectEdge extends ParticleShapeBase {
-    type: ShapeType.RECTANGLE_EDGE;
+    type: ParticleEmitterShapeType.RECTANGLE_EDGE;
     /**
      * 宽度
      */
@@ -163,7 +163,7 @@ export interface ParticleShapeRectEdge extends ParticleShapeBase {
  * 直线发射器
  */
 export interface ParticleShapeEdge extends ParticleShapeBase {
-    type: ShapeType.EDGE;
+    type: ParticleEmitterShapeType.EDGE;
     /**
      * 宽度
      */
@@ -173,7 +173,7 @@ export interface ParticleShapeEdge extends ParticleShapeBase {
  * 贴图发射器
  */
 export interface ParticleShapeTexture extends ParticleShapeBase {
-    type: ShapeType.TEXTURE;
+    type: ParticleEmitterShapeType.TEXTURE;
     detail: ParticleTextureShapeDetail;
     /**
      * 贴图随机数

package/es/item/rich-text-item.d.ts

@@ -0,0 +1,35 @@
+import type { BaseItem, EndBehavior } from './base-item';
+import type { ItemType } from '../type';
+import type { BaseTextContentOptions, TextComponentData, TextContent } from './text-item';
+/**
+ * 富文本元素
+ */
+export interface RichTextItem extends BaseItem {
+    /**
+     * 元素类型（指定为 text）
+     */
+    type: ItemType.richtext;
+    /**
+     * 文本元素渲染信息
+     */
+    content: RichTextContent;
+    endBehavior: EndBehavior;
+}
+/**
+ * 文本元素渲染属性
+ */
+export interface RichTextContent extends Omit<TextContent, 'options'> {
+    /**
+     * 文本元素基础属性
+     */
+    options: BaseTextContentOptions;
+}
+/**
+ * 富文本元素渲染属性
+ */
+export interface RichTextComponentData extends Omit<TextComponentData, 'options'> {
+    /**
+     * 富文本元素基础属性
+     */
+    options: BaseTextContentOptions;
+}

package/es/item/rich-text-item.js

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

package/es/item/spine-item.d.ts

@@ -1,6 +1,7 @@
 import type { BinaryPointer } from '../binary';
-import type { ComponentData, DataPath, DataType } from '../components';
-import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType } from '../type';
+import type { ComponentData, DataPath } from '../components';
+import type { DataType } from '../data-type';
+import type { SizeOverLifetime, RotationOverLifetime, PositionOverLifetime, ColorOverLifetime, RendererOptions, ItemType, MaskMode, RenderMode } from '../type';
 import type { BaseItem, EndBehavior } from './base-item';
 /**
  * 插件元素
@@ -118,4 +119,8 @@ export interface SpineComponent extends ComponentData {
         images: DataPath[];
         skeletonType: skeletonFileType;
     };
+    renderer?: {
+        renderMode: RenderMode;
+        maskMode: MaskMode;
+    };
 }

package/es/item/sprite-item.d.ts

@@ -73,47 +73,5 @@ export interface SpriteContent {
 /**
  * 图层组件属性
  */
-export interface SpriteComponentData extends ComponentData {
-    /**
-     * added by loader
-     * @default null
-     */
-    splits?: SplitParameter[];
-    /**
-     * 图层元素基础属性
-     */
-    options: SpriteContentOptions;
-    /**
-     * 图层元素材质渲染属性
-     */
-    renderer: RendererOptions;
-    /**
-     * 图层元素大小变化属性
-     */
-    sizeOverLifetime?: SizeOverLifetime;
-    /**
-     * 图层元素旋转变化属性
-     */
-    rotationOverLifetime?: RotationOverLifetime;
-    /**
-     * 图层元素位置变化属性
-     */
-    positionOverLifetime?: PositionOverLifetime;
-    /**
-     * 图层元素色彩变化属性
-     */
-    colorOverLifetime?: ColorOverLifetime;
-    /**
-     * 图层元素贴图变化属性
-     */
-    textureSheetAnimation?: TextureSheetAnimation;
-    /**
-     * 图层交互
-     */
-    interaction?: {
-        /**
-         * 交互行为
-         */
-        behavior: InteractBehavior;
-    };
+export interface SpriteComponentData extends ComponentData, SpriteContent {
 }

package/es/item/text-item.d.ts

@@ -17,7 +17,40 @@ export interface TextItem extends BaseItem {
     content: TextContent;
     endBehavior: EndBehavior;
 }
-export interface TextContentOptions {
+export interface TextContentOptions extends BaseTextContentOptions {
+    /**
+     * 文本间隔
+     * @default 0
+     */
+    letterSpace?: number;
+    /**
+     * 文本固定宽度（和自适应宽高冲突）
+     * @default 31
+     */
+    textWidth?: number;
+    /**
+     * 文本行高
+     * @default 31
+     */
+    lineHeight?: number;
+    /**
+     * 文本高度
+     * @default 31
+     */
+    textHeight?: number;
+    /**
+     * 自适应宽高开关（和文本固定宽度冲突）
+     * @default false
+     */
+    autoWidth?: boolean;
+    /**
+     * 当文字超过最大宽度时，文字的表现行为
+     * 仅当设置文字最大宽度后生效
+     * @default TextOverflow.display
+     */
+    textOverflow?: TextOverflow;
+}
+export interface BaseTextContentOptions {
     /**
      * 文本内容
      */
@@ -37,11 +70,6 @@ export interface TextContentOptions {
      * @default 'Arial'
      */
     fontFamily?: string;
-    /**
-     * 文本间隔
-     * @default 0
-     */
-    letterSpace?: number;
     /**
      * 上下对齐方式
      * @default TextBaseline.middle
@@ -52,26 +80,6 @@ export interface TextContentOptions {
      * @default TextAlignment.left
      */
     textAlign?: TextAlignment;
-    /**
-     * 文本固定宽度（和自适应宽高冲突）
-     * @default 31
-     */
-    textWidth?: number;
-    /**
-     * 文本行高
-     * @default 31
-     */
-    lineHeight?: number;
-    /**
-     * 文本高度
-     * @default 31
-     */
-    textHeight?: number;
-    /**
-     * 自适应宽高开关（和文本固定宽度冲突）
-     * @default false
-     */
-    autoWidth?: boolean;
     /**
      * 文本字重
      * @default TextWeight.normal
@@ -174,42 +182,5 @@ export interface TextContent {
 /**
  * 文本元素渲染属性
  */
-export interface TextComponentData extends ComponentData {
-    /**
-     * 文本元素基础属性
-     */
-    options: TextContentOptions;
-    /**
-     * 文本元素材质渲染属性
-     */
-    renderer: RendererOptions;
-    /**
-     * 文本元素大小变化属性
-     */
-    sizeOverLifetime?: SizeOverLifetime;
-    /**
-     * 文本元素旋转变化属性
-     */
-    rotationOverLifetime?: RotationOverLifetime;
-    /**
-     * 文本元素位置变化属性
-     */
-    positionOverLifetime?: PositionOverLifetime;
-    /**
-     * 文本元素色彩变化属性
-     */
-    colorOverLifetime?: ColorOverLifetime;
-    /**
-     * 文本元素贴图变化属性
-     */
-    textureSheetAnimation?: TextureSheetAnimation;
-    /**
-     * 图层交互
-     */
-    interaction?: {
-        /**
-         * 交互行为
-         */
-        behavior: InteractBehavior;
-    };
+export interface TextComponentData extends ComponentData, TextContent {
 }