@galacean/effects-core 2.9.0-alpha.0 → 2.9.0-alpha.1

package/dist/plugins/text/text-component-base.d.ts

@@ -10,6 +10,9 @@ import type { TextStyle } from './text-style';
  */
 export interface IRichTextComponent {
 }
+/**
+ * 文本组件基础类，包含文本组件和富文本组件的共有逻辑
+ */
 export declare class TextComponentBase {
     textStyle: TextStyle;
     textLayout: BaseLayout;
@@ -23,20 +26,67 @@ export declare class TextComponentBase {
     renderer: ItemRenderer;
     protected maxLineWidth: number;
     protected readonly ALPHA_FIX_VALUE: number;
+    /**
+     * 设置文本内容
+     * @param value - 文本内容
+     */
     setText(value: string): void;
+    /**
+     * 设置文本水平布局
+     * @param value - 布局选项
+     */
     setTextAlign(value: spec.TextAlignment): void;
+    /**
+     * 设置文本垂直布局
+     * @param value - 布局选项
+     */
     setTextVerticalAlign(value: spec.TextVerticalAlign): void;
     /**
      * @deprecated 2.8.0 本方法已废弃，请使用 setTextVerticalAlign 替代。
      */
     setTextBaseline(value: spec.TextBaseline): void;
+    /**
+     * 设置文本颜色
+     * @param value - 颜色内容
+     * @default [1, 1, 1, 1]
+     */
     setTextColor(value: spec.RGBAColorValue): void;
+    /**
+     * 设置字体
+     * @param value - 字体名称，如："Arial", "Times New Roman" 等
+     * @default "sans-serif"
+     */
     setFontFamily(value: string): void;
+    /**
+     * 设置字重
+     * @param value - 字重类型
+     */
     setFontWeight(value: spec.TextWeight): void;
+    /**
+     * 设置字体样式
+     * @param value - 字体样式
+     * @default "normal"
+     */
     setFontStyle(value: spec.FontStyle): void;
+    /**
+     * 设置外描边文本颜色
+     * @param value - 颜色内容
+     */
     setOutlineColor(value: spec.RGBAColorValue): void;
+    /**
+     * 设置是否启用外描边
+     * @param value - 是否启用外描边
+     */
     setOutlineEnabled(value: boolean): void;
+    /**
+     * 设置字体清晰度
+     * @param value - 字体清晰度
+     */
     setFontScale(value: number): void;
+    /**
+     * 设置文本溢出方式
+     * @param overflow - 溢出方式
+     */
     setOverflow(overflow: spec.TextOverflow): void;
     protected getFontDesc(size?: number): string;
     protected setupOutline(): void;

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

@@ -41,6 +41,11 @@ export declare class TextComponent extends MaskableGraphic {
      * 根据配置更新文本样式和布局
      */
     updateWithOptions(options: spec.TextContentOptions): void;
+    /**
+     * 获取文本行数
+     * @param text - 文本内容
+     * @returns 行数
+     */
     getLineCount(text: string): number;
     /**
      * 设置行高
@@ -48,46 +53,8 @@ export declare class TextComponent extends MaskableGraphic {
      * @param value - 行高像素值
      */
     setLineHeight(value: number): void;
-    /**
-     * 设置字重
-     * @param value - 字重类型
-     * @returns
-     */
-    setFontWeight(value: spec.TextWeight): void;
-    /**
-     * 设置字体样式
-     * @param value 设置字体样式
-     * @default "normal"
-     * @returns
-     */
-    setFontStyle(value: spec.FontStyle): void;
-    /**
-     * 设置文本水平布局
-     * @param value - 布局选项
-     * @returns
-     */
-    setTextAlign(value: spec.TextAlignment): void;
-    /**
-     * 设置文本颜色
-     * @param value - 颜色内容
-     * @returns
-     */
-    setTextColor(value: spec.RGBAColorValue): void;
-    /**
-     * 设置外描边文本颜色
-     * @param value - 颜色内容
-     * @returns
-     */
-    setOutlineColor(value: spec.RGBAColorValue): void;
-    /**
-     * 设置字体清晰度
-     * @param value - 字体清晰度
-     * @returns
-     */
-    setFontScale(value: number): void;
     /**
      * 更新文本
-     * @returns
      */
     protected updateTexture(flipY?: boolean): void;
     renderText(options: spec.TextContentOptions): void;
@@ -119,17 +86,47 @@ export declare class TextComponent extends MaskableGraphic {
      * @param value - 文本框高度
      */
     setTextHeight(value: number): void;
+    /**
+     * 设置字体大小
+     * @param value - 字体大小
+     * @default 40
+     */
     setFontSize(value: number): void;
+    /**
+     * 设置描边宽度
+     * @param value - 描边宽度
+     * @default 0
+     */
     setOutlineWidth(value: number): void;
     /**
      * 设置是否启用文本描边
      * @param value - 是否启用描边
-     * @returns
      */
     setOutlineEnabled(value: boolean): void;
+    /**
+     * 设置阴影模糊度
+     * @param value - 阴影模糊度
+     * @default 0
+     */
     setShadowBlur(value: number): void;
+    /**
+     * 设置阴影颜色
+     * > setupShadow 使用 outlineColor 作为阴影颜色，更新 shadowColor 不影响阴影颜色
+     * @param value - 阴影颜色
+     * @returns
+     */
     setShadowColor(value: spec.RGBAColorValue): void;
+    /**
+     * 设置阴影偏移 X
+     * @param value - 阴影偏移值
+     * @returns
+     */
     setShadowOffsetX(value: number): void;
+    /**
+     * 设置阴影偏移 Y
+     * @param value - 阴影偏移值
+     * @returns
+     */
     setShadowOffsetY(value: number): void;
     /**
      * 计算文本在当前样式与布局规则下的建议宽度（逻辑像素）。

package/dist/plugins/timeline/playable.d.ts

@@ -56,5 +56,6 @@ export interface FrameContext {
 }
 export declare enum PlayState {
     Playing = 0,
-    Paused = 1
+    Paused = 1,
+    Stopped = 2
 }

package/dist/plugins/timeline/timeline-asset.d.ts

@@ -14,12 +14,9 @@ export declare class TimelineAsset extends EffectsObject {
     private addSubTracksRecursive;
 }
 export declare class TimelineInstance {
-    private time;
     private clips;
     constructor(timelineAsset: TimelineAsset, sceneBindings: SceneBinding[]);
-    setTime(time: number): void;
-    getTime(): number;
-    evaluate(deltaTime: number): void;
+    evaluate(time: number, deltaTime: number): void;
     compileTracks(tracks: TrackAsset[], sceneBindings: SceneBinding[]): void;
     private tickTrack;
     private updateTrackAnimatedObject;

package/dist/precompositions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './precomposition';
+export * from './precomposition-manager';

package/dist/precompositions/precomposition-manager.d.ts

@@ -0,0 +1,13 @@
+import type { Composition } from '../composition';
+import { VFXItem } from '../vfx-item';
+import type { Precomposition } from './precomposition';
+export declare class PrecompositionManager {
+    /**
+     * 从预合成数据实例化一棵 VFXItem 树。
+     * 可挂载到现有合成的节点下。
+     * @param precomposition 预合成数据
+     * @param composition 目标合成
+     * @returns 实例化生成的根 VFXItem，其子树包含指定合成的所有元素
+     */
+    static instantiate(precomposition: Precomposition, composition: Composition): VFXItem;
+}

package/dist/precompositions/precomposition.d.ts

@@ -0,0 +1,7 @@
+import type { Scene, SceneLoadOptions } from '../scene';
+/**
+ * 预合成数据类，包含预合成 Json 数据和加载选项。
+ */
+export declare class Precomposition {
+    constructor(scene: Scene, options?: SceneLoadOptions);
+}

package/dist/scene-loader.d.ts

@@ -1,6 +1,9 @@
 import { Composition } from './composition';
 import type { Engine } from './engine';
 import type { Scene, SceneLoadOptions } from './scene';
+/**
+ * @hidden
+ */
 export declare class SceneLoader {
     static load(scene: Scene.LoadType, engine: Engine, options?: SceneLoadOptions): Promise<Composition>;
     private static createComposition;

package/dist/scene.d.ts

@@ -12,7 +12,6 @@ export interface Scene {
     readonly storage: Record<string, any>;
     renderLevel?: SceneRenderLevel;
     textureOptions: Record<string, any>[];
-    textures: Texture[];
     images: ImageLike[];
     assets: Record<string, ImageLike>;
     consumed?: boolean;

package/dist/vfx-item.d.ts

@@ -1,7 +1,7 @@
 import { Vector3 } from '@galacean/effects-math/es/core/vector3';
 import * as spec from '@galacean/effects-specification';
 import type { Component } from './components';
-import { Composition } from './composition';
+import type { Composition } from './composition';
 import { EffectsObject } from './effects-object';
 import type { Engine } from './engine';
 import type { EventEmitterListener, EventEmitterOptions, ItemEvent } from './events';
@@ -49,10 +49,18 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      * @deprecated 2.7.0 Please use `getInstanceId` instead
      */
     id: string;
+    /**
+     * 元素类型
+     */
     type: spec.ItemType;
+    /**
+     * @deprecated 2.9.0 Please use `defination` instead
+     */
     props: spec.VFXItemData;
+    /**
+     * 元素绑定的组件列表
+     */
     components: Component[];
-    isDuringPlay: boolean;
     /**
      * 元素是否激活
      */
@@ -64,9 +72,6 @@ export declare class VFXItem extends EffectsObject implements Disposable {
     private listIndex;
     private isEnabled;
     private eventProcessor;
-    /**
-     * 合成属性
-     */
     private _composition;
     /**
      *
@@ -127,6 +132,7 @@ export declare class VFXItem extends EffectsObject implements Disposable {
     set composition(value: Composition);
     /**
      * 播放完成后是否需要再使用，是的话生命周期结束后不会 dispose
+     * @deprecated
      */
     get compositionReusable(): boolean;
     /**
@@ -287,8 +293,6 @@ export declare class VFXItem extends EffectsObject implements Disposable {
      */
     dispose(): void;
     private resetChildrenParent;
-    private instantiatePreComposition;
-    private resetGUID;
     private gatherPreviousObjectID;
     private getDescendantsInternal;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@galacean/effects-core",
-  "version": "2.9.0-alpha.0",
+  "version": "2.9.0-alpha.1",
   "description": "Galacean Effects runtime core for the web",
   "module": "./dist/index.mjs",
   "main": "./dist/index.js",
@@ -42,7 +42,7 @@
     "registry": "https://registry.npmjs.org"
   },
   "dependencies": {
-    "@galacean/effects-specification": "2.7.2",
+    "@galacean/effects-specification": "2.8.0-alpha.0",
     "@galacean/effects-math": "1.1.0",
     "flatbuffers": "24.3.25",
     "uuid": "9.0.1",