@galacean/effects-plugin-editor-gizmo 2.10.4 → 2.11.0-alpha.1

package/dist/2d/gizmos/select-text-gizmo.d.ts

@@ -0,0 +1,77 @@
+import { type InputEventMouseButton, type InputEventMouseMotion } from '@galacean/effects';
+import type { Control } from '@galacean/effects-plugin-gui';
+import { Gizmo } from '../gizmo';
+import type { GizmoOwner } from '../gizmo-owner';
+import type { TextEditSession } from '../text/text-edit-session';
+/** 在文本编辑模式下悬停、选择并切换文本对象。 */
+export declare class SelectTextGizmo extends Gizmo {
+    private readonly session;
+    readonly type = "select-text";
+    private static readonly HOVER_HIT_RADIUS;
+    private static readonly HOVER_LINE_WIDTH;
+    private static readonly HOVER_DASH_LENGTH;
+    private static readonly HOVER_GAP_LENGTH;
+    private _hoverTextId;
+    private pointerSelecting;
+    /**
+     * 创建文本选择交互。
+     * @param owner Gizmo 宿主。
+     * @param session 文本编辑会话。
+     */
+    constructor(owner: GizmoOwner, session: TextEditSession);
+    /** 当前悬停文本的 ID。 */
+    get hoverTextId(): string | undefined;
+    /**
+     * 更新文本悬停或拖拽选区。
+     * @param event 鼠标移动事件。
+     */
+    onMouseMove(event: InputEventMouseMotion): void;
+    /**
+     * 切换到命中的文本并开始指针选区。
+     * @param event 鼠标按下事件。
+     */
+    onMouseDown(event: InputEventMouseButton): void;
+    /**
+     * 更新文本指针选区。
+     * @param event 鼠标拖拽事件。
+     */
+    onMouseDrag(event: InputEventMouseMotion): void;
+    /**
+     * 完成文本指针选区。
+     * @param event 鼠标抬起事件。
+     */
+    onMouseUp(event: InputEventMouseButton): void;
+    /** 清除离开视口后的文本悬停状态。 */
+    onMouseLeave(): void;
+    /** 在每帧更新时校验悬停文本是否仍可编辑。 */
+    onUpdate(): void;
+    /**
+     * 绘制悬停文本的轮廓。
+     * @param control 绘制控制器。
+     */
+    draw(control: Control): void;
+    /** 释放文本选择交互状态。 */
+    dispose(): void;
+    /**
+     * 查找指定位置可编辑的文本对象。
+     * @param point 视口坐标。
+     * @param excludeEditingItem 是否排除当前编辑对象。
+     * @param includeNearby 是否使用悬停命中容差。
+     * @returns 命中的文本对象。
+     */
+    private resolveTextTarget;
+    /**
+     * 判断对象是否可作为文本选择目标。
+     * @param item 待检查对象。
+     * @param excludeEditingItem 是否排除当前编辑对象。
+     * @returns 是否为可选文本对象。
+     */
+    private isTextCandidate;
+    /** 清除文本悬停目标。 */
+    private clearHover;
+    /**
+     * 设置文本编辑光标。
+     * @param _event 当前鼠标事件。
+     */
+    private setTextCursor;
+}

package/dist/2d/gizmos/sprite-text-edit-gizmo.d.ts

@@ -0,0 +1,149 @@
+import type { spec } from '@galacean/effects';
+import { type InputEventMouseButton, type InputEventMouseMotion } from '@galacean/effects';
+import type { Control } from '@galacean/effects-plugin-gui';
+import { Gizmo } from '../gizmo';
+import { GizmoType } from '../gizmo-type';
+import { Box2 } from '@galacean/effects-math/es/extension/index';
+import type { SpriteTextEditConfig } from '../configs/types';
+/**
+ * 图层文字信息
+ */
+export type SpriteTextInfo = {
+    /**
+     * 元素ID
+     */
+    id: string;
+    /**
+     * 文本框索引
+     */
+    index: number;
+    /**
+     * 文本包围盒
+     */
+    box: Box2;
+    /**
+     * 文本内容
+     */
+    text: string;
+    /**
+     * 是否被修改过
+     */
+    hasChanged: boolean;
+    /**
+     * 是否处于编辑态
+     */
+    isEditing: boolean;
+};
+/**
+ * 精准改字功能初始化信息
+ */
+export type SpriteTextInitParam = {
+    /**
+     * 元素ID
+     */
+    id: string;
+    /** 原始包围盒。 */
+    originBox?: Box2;
+    /**
+     * 改字信息
+     */
+    info: SpriteTextInitInfo[];
+};
+/** 单个精准改字文本框的初始化信息。 */
+export type SpriteTextInitInfo = {
+    /**
+     * 是否被修改过
+     */
+    hasChanged: boolean;
+    /**
+     * 文字内容
+     */
+    text: string;
+    /**
+     * 包围盒信息
+     */
+    box: [spec.vec2, spec.vec2, spec.vec2, spec.vec2];
+};
+/** 精准改字交互参数 */
+type SpriteTextEditInteractionParam = {
+    /** 已选中索引 */
+    selected: number;
+    /** 预选中索引 */
+    preSelected: number;
+};
+/** 精准改字结果列表 */
+type SpriteTextEditResult = SpriteTextInfo[];
+/** 在图层文本框上提供悬停、选择、编辑和绘制能力。 */
+export declare class SpriteTextEditGizmo extends Gizmo {
+    readonly type: GizmoType;
+    result: SpriteTextEditResult;
+    interactionParam: SpriteTextEditInteractionParam;
+    /** onMouseMove 命中缓存（坐标未变则跳过 computePreSelected，避免每帧全 result 命中扫描）。 */
+    private cachedCoords;
+    /** 当前精准改字配置。 */
+    get config(): Readonly<SpriteTextEditConfig>;
+    /**
+     * 更新指针悬停的文本框。
+     * @param _event 鼠标移动事件。
+     */
+    onMouseMove(_event: InputEventMouseMotion): void;
+    /** 鼠标离开交互层：清预选中 + 失效缓存。 */
+    onMouseLeave(): void;
+    /**
+     * 将命中的文本框设为编辑态并发送点击事件。
+     * @param event 鼠标按下事件。
+     */
+    onMouseDown(event: InputEventMouseButton): void;
+    /**
+     * 以初始化参数列表填充 result，将原始角点转换为相对元素包围盒的归一化盒。
+     * @param initParams 初始化参数列表
+     */
+    initResult(initParams: SpriteTextInitParam[]): void;
+    /** 清空当前所有改字结果数据。 */
+    clearResultData(): void;
+    /**
+     * 设置当前选中文字框；找不到时告警。
+     * @param id 元素 ID
+     * @param index 文本框索引
+     */
+    setSelected(id: string, index: number): void;
+    /**
+     * 设置指定文字框的文本内容；找不到时告警。
+     * @param id 元素 ID
+     * @param index 文本框索引
+     * @param text 文本内容
+     */
+    setText(id: string, index: number, text: string): void;
+    /**
+     * 设置指定文字框的"已改动"状态；找不到时告警。
+     * @param id 元素 ID
+     * @param index 文本框索引
+     * @param hasChanged 是否已改动
+     */
+    setChangedState(id: string, index: number, hasChanged: boolean): void;
+    /**
+     * 设置指定文字框的编辑态；找不到时告警。
+     * @param id 元素 ID
+     * @param index 文本框索引
+     * @param isEditing 是否处于编辑态
+     */
+    setEditState(id: string, index: number, isEditing: boolean): void;
+    /**
+     * 绘制文本框状态与正在编辑的文本。
+     * @param control 绘制控制器。
+     */
+    draw(control: Control): void;
+    /**
+     * 获取指定元素的视口包围盒。
+     * @param id 元素 ID。
+     * @returns 元素包围盒。
+     */
+    private getItemOriginBox;
+    /**
+     * 查找鼠标命中的文本框索引。
+     * @param mouse 鼠标位置。
+     * @returns 首个命中索引；未命中时返回 -1。
+     */
+    private computePreSelected;
+}
+export {};

package/dist/2d/gizmos/text-gizmo.d.ts

@@ -0,0 +1,65 @@
+import { type InputEventMouseButton } from '@galacean/effects';
+import type { Control } from '@galacean/effects-plugin-gui';
+import { Gizmo } from '../gizmo';
+import type { GizmoOwner } from '../gizmo-owner';
+import { GizmoType } from '../gizmo-type';
+import type { TextEditSession, TextInteractionParam, TextResult } from '../text/text-edit-session';
+export type { TextEmptyResult, TextInteractionParam, TextResult, TextValidResult, } from '../text/text-edit-session';
+/** 文本编辑态包围盒线色。 */
+export declare const TEXT_EDIT_BOX_LINE_COLOR = 3900150;
+/** 文本编辑态包围盒线宽。 */
+export declare const TEXT_EDIT_BOX_LINE_WIDTH = 2;
+/** 将文本编辑会话投影到画布并绘制编辑框。 */
+export declare class TextGizmo extends Gizmo {
+    readonly type = GizmoType.TEXT;
+    result: TextResult;
+    private readonly session;
+    private readonly projectionToken;
+    /**
+     * 转发文本输入事件。
+     * @param payload 文本输入结果。
+     */
+    private readonly forwardTextInput;
+    /**
+     * @param owner Gizmo 宿主
+     * @param session 文本编辑会话
+     */
+    constructor(owner: GizmoOwner, session: TextEditSession);
+    /** 文本编辑使用的 DOM 输入框。 */
+    get textAreaElement(): HTMLTextAreaElement;
+    /** 当前文本交互状态。 */
+    get interactionParam(): TextInteractionParam;
+    /** 是否正在编辑文本。 */
+    get isEditing(): boolean;
+    /** 当前视口缩放。 */
+    get viewScale(): number;
+    /**
+     * 保留文本编辑会话的鼠标按下入口。
+     * @param _event 鼠标按下事件
+     */
+    onMouseDown(_event: InputEventMouseButton): void;
+    /**
+     * 编辑中接收鼠标抬起事件。
+     * @param event 鼠标抬起事件
+     */
+    onMouseUp(event: InputEventMouseButton): void;
+    /** 更新文本元素的视图包围盒。 */
+    onUpdate(): void;
+    /**
+     * 绘制文本编辑框并同步 DOM 输入框。
+     * @param control 绘制控制器
+     */
+    draw(control?: Control): void;
+    /**
+     * 选中当前编辑文本的全部内容，并将焦点交给输入框。
+     * @returns 当前存在可编辑文本时返回 true
+     */
+    selectAllText(): boolean;
+    /** 脱离文本编辑会话投影。 */
+    dispose(): void;
+    /**
+     * 绘制文本编辑包围盒。
+     * @param control 绘制控制器
+     */
+    private drawEditBox;
+}

package/dist/2d/gizmos/viewport-overlay-gizmo.d.ts

@@ -0,0 +1,66 @@
+import type { Control } from '@galacean/effects-plugin-gui';
+import { Box2 } from '@galacean/effects-math/es/extension/index';
+import type { Matrix3 } from '../math';
+import { Gizmo } from '../gizmo';
+import { GizmoType } from '../gizmo-type';
+import type { ViewportOverlayConfig } from '../configs/types';
+/** 视口画板与安全区配置。 */
+export type ViewProperty = {
+    /** 画板（设计稿）尺寸 [宽, 高]，单位为设计稿像素 */
+    size: [number, number];
+    /** 出血安全区 [上, 下, 左, 右]，单位为设计稿像素，相对画板边缘的边距 */
+    safeArea: [number, number, number, number];
+    /** 预览安全区列表 */
+    previewSafeAreas: {
+        /** 安全区包围盒 [左, 上, 宽, 高]，单位为设计稿像素，相对画板左上角 */
+        box: [number, number, number, number];
+        /** 填充色 [r, g, b, a?]，0..255 */
+        color?: number[];
+        /** 背景贴图地址 */
+        url?: string;
+        /** 是否可见 */
+        visible?: boolean;
+    }[];
+};
+/** 视口展示 gizmo：绘制画板边框、画框外遮罩、出血与预览安全区。 */
+export declare class ViewportOverlayGizmo extends Gizmo {
+    readonly type = GizmoType.VIEWPORT_OVERLAY;
+    /** 遮挡层绘制结果（画板视口盒） */
+    box: Box2;
+    /** 主视口归一化 Box2 到屏幕的变换。 */
+    transform: Matrix3 | undefined;
+    /** 视图属性（由外部设置） */
+    viewProperty: ViewProperty | undefined;
+    /** 外部提供的主视口包围盒计算函数。 */
+    mainViewportBoxProvider: (() => Box2 | null) | undefined;
+    /** previewSafeAreas 贴图缓存：url → Texture（避免每帧重建） */
+    private safeAreaTextures;
+    /** previewSafeAreas 贴图加载 Promise：url → Promise<Texture>（防重入，加载完写入 safeAreaTextures） */
+    private safeAreaTexturePromises;
+    /** 当前视口覆盖层配置。 */
+    get config(): Readonly<ViewportOverlayConfig>;
+    /** 刷新当前画板或主视口的屏幕包围盒。 */
+    onUpdate(): void;
+    /**
+     * 绘制画板外遮罩、安全区与画板边框。
+     * @param control 绘制控制器。
+     */
+    draw(control: Control): void;
+    /** 释放预览安全区贴图缓存，调用父类释放。 */
+    dispose(): void;
+    /**
+     * 将居中的预览矩形投影为屏幕包围盒。
+     * @param item 提供合成相机的播放器元素。
+     * @param size 预览尺寸。
+     * @returns 主视口屏幕包围盒。
+     */
+    private projectPreviewBox;
+    /**
+     * 获取预览安全区贴图（懒加载）。命中且未销毁则直接返回；否则发起一次异步加载并返回
+     * undefined（本帧跳过该贴图，加载完成后由持续渲染循环自动重绘）。与 IconGizmo 同模式。
+     * @param url 贴图地址
+     * @param engine effects 引擎实例（取自 control）
+     * @returns 命中且未销毁的缓存纹理；未命中且发起异步加载时返回 undefined
+     */
+    private getSafeAreaTexture;
+}

package/dist/2d/index.d.ts

@@ -0,0 +1,44 @@
+export * from './math';
+export type { ViewportNavigationRange } from './viewport';
+export * from './text';
+export * from './modes';
+export * from './gizmo-tools';
+export * from './gizmo';
+export * from './gizmo-tool';
+export * from './gizmo-action';
+export * from './gizmo-manager';
+export * from './gizmo-owner';
+export * from './gizmos/loading-manager';
+export * from './gizmo-type';
+export * from './frame';
+export { ConfigManager, DEFAULT_LOADING_FRAGMENT, cloneConfigValue, defineConfig, freezeConfigValue, effectsEditModeConfig, iconConfig, itemCreateConfig, loadingConfig, maskConfig, imageCutConfig, imageExpandConfig, resizeSelectionConfig, selectionPreviewConfig, selectionSnapConfig, spriteTextEditConfig, viewportNavigationConfig, viewportOverlayConfig, } from './configs';
+export type { AnyConfigChange, AnyConfigDefinition, ConfigChange, ConfigDefinition, ConfigManagerEvents, ConfigValue, EffectsEditModeConfig, IconConfig, ItemCreateConfig, LoadingConfig, MaskConfig, ImageCutConfig, ImageExpandConfig, ResizeSelectionBehavior, ResizeSelectionConfig, SelectionPreviewConfig, SnapConfig, SpriteTextEditConfig, ViewportNavigationConfig, ViewportOverlayConfig, } from './configs';
+export * from './items';
+export * from './drawing';
+export * from './viewport';
+export * from './selection';
+export * from './gesture-handler';
+export * from './cursor';
+export * from './cursor-icons';
+export * from './drag-threshold';
+export * from './gizmos/image-interaction';
+export * from './gizmos/resize-selection-gizmo';
+export * from './gizmos/corner-rotation-gizmo';
+export * from './gizmos/text-gizmo';
+export * from './gizmos/select-text-gizmo';
+export * from './gizmos/image-cut-gizmo';
+export * from './gizmos/image-expand-gizmo';
+export * from './gizmos/mask-gizmo';
+export * from './gizmos/sprite-text-edit-gizmo';
+export * from './gizmos/icon-gizmo';
+export * from './gizmos/loading-gizmo';
+export * from './gizmos/viewport-overlay-gizmo';
+export * from './gizmos/item-create-gizmo';
+export * from './gizmos/hand-gizmo';
+export * from './gizmos/box-selection-gizmo';
+export * from './gizmos/change-selection-gizmo';
+export * from './gizmos/move-selection-gizmo';
+export * from './gizmos/click-drag-multiplex-gizmo';
+export * from './gizmos/leave-text-edit-gizmo';
+export * from './gizmos/leave-effects-edit-gizmo';
+export * from './gizmos/enter-edit-mode-gizmo';

package/dist/2d/items/default-vfx-items.d.ts

@@ -0,0 +1,45 @@
+import { type Composition, spec, type VFXItem } from '@galacean/effects';
+/** 创建内置类型 VFXItem 的便捷工厂。 */
+export declare class DefaultVFXItems {
+    /**
+     * 创建空元素。
+     * @param composition 目标合成
+     * @param parent 父元素
+     * @param name 元素名称
+     * @returns 新建的空元素
+     */
+    static createEmpty(composition: Composition, parent?: null, name?: string): VFXItem;
+    /**
+     * 创建图片元素。
+     * @param composition 目标合成
+     * @param parent 父元素
+     * @param name 元素名称
+     * @returns 新建的图片元素
+     */
+    static createSprite(composition: Composition, parent?: null, name?: string): VFXItem;
+    /**
+     * 创建文本元素。
+     * @param composition 目标合成
+     * @param parent 父元素
+     * @param name 元素名称
+     * @returns 新建的文本元素
+     */
+    static createText(composition: Composition, parent?: null, name?: string): VFXItem;
+    /**
+     * 创建视频元素。
+     * @param composition 目标合成
+     * @param parent 父元素
+     * @param name 元素名称
+     * @returns 新建的视频元素
+     */
+    static createVideo(composition: Composition, parent?: null, name?: string): VFXItem;
+    /**
+     * 加载并创建动效合成元素。
+     * @param composition 目标合成
+     * @param effects 动效地址或场景数据
+     * @param parent 父元素
+     * @param urlname 元素名称
+     * @returns 新建的动效元素
+     */
+    static createEffects(composition: Composition, effects: string | spec.JSONScene, parent?: null, urlname?: string): Promise<VFXItem>;
+}

package/dist/2d/items/index.d.ts

@@ -0,0 +1,6 @@
+export * from './default-vfx-items';
+export * from './item-geometry';
+export * from './item-hierarchy';
+export * from './item-predicates';
+export * from './media-controls';
+export * from './vfx-item-factory';

package/dist/2d/items/item-geometry.d.ts

@@ -0,0 +1,69 @@
+import { type VFXItem } from '@galacean/effects';
+import { Box2 } from '@galacean/effects-math/es/extension/index';
+import type { Matrix3 } from '../math';
+import { Euler, Matrix4, Vector2, Vector3 } from '../math';
+/**
+ * 获取元素用于编辑的视图 Box2。
+ * @param item 播放器元素
+ * @param containerSize 视图大小
+ * @returns 视图坐标系中的轴对齐包围盒
+ */
+export declare function getItemViewBox(item: VFXItem, containerSize: Vector2): Box2;
+/**
+ * 获取归一化 Box2 到元素视图坐标的变换。
+ * @param item 播放器元素
+ * @param containerSize 视图大小
+ * @returns 有效变换；元素不可见或没有有效矩形时返回 undefined
+ */
+export declare function getItemViewTransform(item: VFXItem, containerSize: Vector2): Matrix3 | undefined;
+/**
+ * 获取播放器元素在视图中的锚点坐标。
+ * @param item 播放器元素
+ * @param containerSize 视图容器大小
+ * @returns 视图锚点坐标
+ */
+export declare function getItemViewAnchor(item: VFXItem, containerSize: Vector2): Vector2;
+/**
+ * 获取元素的变换矩阵和父级变换矩阵。
+ * @param item 播放器元素
+ * @returns 元素的变换矩阵和父级变换矩阵
+ */
+export declare function getItemTransform(item: VFXItem): {
+    matrix: Matrix4;
+    parentMatrix: Matrix4;
+};
+/** 元素的世界分解变换。 */
+export type DecomposedItemTransform = {
+    /** 元素的世界矩阵。 */
+    matrix: Matrix4;
+    /** 父元素的世界矩阵。 */
+    parentMatrix: Matrix4;
+    /** 元素的世界位置。 */
+    position: Vector3;
+    /** 元素的世界旋转。 */
+    rotation: Euler;
+    /** 元素的世界缩放。 */
+    scale: Vector3;
+};
+/**
+ * 获取元素的世界变换。
+ * @param item 播放器元素
+ * @returns 分解后的世界变换
+ */
+export declare function decomposeItemTransform(item: VFXItem): DecomposedItemTransform;
+/**
+ * 获取播放器元素在视图中的尺寸。
+ * @param item 播放器元素
+ * @param containerSize 视图容器大小
+ * @returns 视图尺寸
+ */
+export declare function getItemViewSize(item: VFXItem, containerSize: Vector2): Vector2;
+/**
+ * 获取元素在所属合成坐标系中的实际世界尺寸。
+ *
+ * `transform.size` 是元素本地尺寸；这里叠加元素到合成根之间的缩放，
+ * 但排除合成本身的世界变换，与 Frame 尺寸写回使用的坐标系保持一致。
+ * @param item 播放器元素
+ * @returns 元素在所属合成坐标系中的尺寸
+ */
+export declare function getItemWorldSize(item: VFXItem): Vector2;

package/dist/2d/items/item-hierarchy.d.ts

@@ -0,0 +1,39 @@
+import type { Composition, VFXItem } from '@galacean/effects';
+/**
+ * 判断播放器元素是否参与交互命中。
+ *
+ * 部分测试夹具或外部运行时节点可能未提供 isVisible；只有明确为 false 时视为隐藏。
+ * @param item 待判断元素
+ * @returns 是否可参与交互
+ */
+export declare function isPlayerItemVisible(item: VFXItem | undefined): boolean;
+/**
+ * 获取元素自身或祖先链中最近的动效容器。
+ *
+ * 默认编辑模式下，Effects 预合成的运行时子节点只负责渲染，点选、框选等交互
+ * 会归并到该容器；EffectsEditMode 使用本方法识别当前放开的子树边界。
+ * @param item 待解析的播放器元素
+ * @returns 最近的动效容器；不在动效子树中时返回 undefined
+ */
+export declare function getEffectsPlayerItemOwner(item: VFXItem | undefined): VFXItem | undefined;
+/**
+ * 获取元素祖先链中的所有画板。
+ *
+ * 不包含元素自身，结果按从近到远排列。
+ * @param item 待检查的播放器元素
+ * @returns 元素所在的画板祖先列表
+ */
+export declare function getFramePlayerItemAncestors(item: VFXItem): VFXItem[];
+/**
+ * 获取播放器元素的所有子元素。
+ * @param item 播放器元素
+ * @returns 子元素数组
+ */
+export declare function getItemChildren(item: VFXItem): VFXItem[];
+/**
+ * 在合成元素树内按实例 ID 查找元素。
+ * @param composition 合成（无合成返回 undefined）
+ * @param id 元素 instanceId
+ * @returns 命中元素；未命中或无合成返回 undefined
+ */
+export declare function getPlayerItemById(composition: Composition | undefined, id: string): VFXItem | undefined;

package/dist/2d/items/item-predicates.d.ts

@@ -0,0 +1,31 @@
+import { type VFXItem } from '@galacean/effects';
+/**
+ * 判断播放器元素是否为画板元素。
+ * @param item 播放器元素
+ * @returns 是否为画板元素
+ */
+export declare function isFramePlayerItem(item: VFXItem): boolean;
+/**
+ * 判断播放器元素是否为动效元素。
+ * @param item 播放器元素
+ * @returns 是否为动效元素
+ */
+export declare function isEffectsPlayerItem(item: VFXItem): boolean;
+/**
+ * 判断播放器元素是否为生成器元素。
+ * @param item 播放器元素
+ * @returns 是否为生成器元素
+ */
+export declare function isGeneratorPlayerItem(item: VFXItem): boolean;
+/**
+ * 判断播放器生成器元素是否为视频生成器。
+ * @param item 播放器元素
+ * @returns 是否为视频生成器
+ */
+export declare function isVideoGeneratorPlayerItem(item: VFXItem): boolean;
+/**
+ * 判断播放器元素是否为组元素。
+ * @param item 播放器元素
+ * @returns 是否为组元素
+ */
+export declare function isGroupPlayerItem(item: VFXItem): false;

package/dist/2d/items/media-controls.d.ts

@@ -0,0 +1,39 @@
+import { type Engine } from '@galacean/effects';
+import { VideoComponent } from '@galacean/effects-plugin-multimedia';
+/**
+ * 请求播放视频组件，并撤销尚未落地的暂停请求。
+ * @param videoComponent 视频组件
+ */
+export declare function playVideoComponent(videoComponent: VideoComponent): void;
+/**
+ * 请求暂停视频组件。
+ *
+ * Multimedia 组件在 `HTMLVideoElement.play()` 尚未完成时直接暂停会产生 AbortError，
+ * 因此等待组件内部的在途播放结束后再暂停；期间再次播放会取消本次暂停请求。
+ * @param videoComponent 视频组件
+ */
+export declare function pauseVideoComponent(videoComponent: VideoComponent): void;
+/**
+ * 播放视频元素。
+ * @param engine 引擎
+ * @param id 视频元素 id
+ */
+export declare function playVideoItem(engine: Engine, id: string): void;
+/**
+ * 暂停视频元素。
+ * @param engine 引擎
+ * @param id 视频元素 id
+ */
+export declare function pauseVideoItem(engine: Engine, id: string): void;
+/**
+ * 播放动效元素。
+ * @param engine 引擎
+ * @param id 动效元素 id
+ */
+export declare function playEffectsItem(engine: Engine, id: string): void;
+/**
+ * 暂停动效元素。
+ * @param engine 引擎
+ * @param id 动效元素 id
+ */
+export declare function pauseEffectsItem(engine: Engine, id: string): void;

package/dist/2d/items/vfx-item-factory.d.ts

@@ -0,0 +1,13 @@
+import { type Component, type Composition, type Constructor, VFXItem } from '@galacean/effects';
+/** 创建 VFXItem、挂载组件并加入合成的底层工厂。 */
+export declare class VFXItemFactory {
+    /**
+     * 创建并挂载 VFXItem。
+     * @param composition 目标合成
+     * @param parent 父元素
+     * @param name 元素名称
+     * @param types 待挂载的组件类型
+     * @returns 新建的 VFXItem
+     */
+    static createVFXItem(composition: Composition, parent?: null, name?: string, ...types: Constructor<Component>[]): VFXItem;
+}

package/dist/2d/math/core.d.ts

@@ -0,0 +1,26 @@
+import { math } from '@galacean/effects';
+/** Effects runtime 使用的 core math 构造器与工具。 */
+export declare const Color: typeof math.Color;
+export declare const Euler: typeof math.Euler;
+export declare const EulerOrder: typeof math.EulerOrder;
+export declare const Matrix3: typeof math.Matrix3;
+export declare const Matrix4: typeof math.Matrix4;
+export declare const Quaternion: typeof math.Quaternion;
+export declare const Ray: typeof math.Ray;
+export declare const Vector2: typeof math.Vector2;
+export declare const Vector3: typeof math.Vector3;
+export declare const DEG2RAD: number;
+export declare const RAD2DEG: number;
+export declare const clamp: typeof math.clamp;
+export declare const isEqual: typeof math.isEqual;
+export declare const isZero: typeof math.isZero;
+/** Effects runtime 使用的 core math 实例类型。 */
+export type Color = math.Color;
+export type Euler = math.Euler;
+export type EulerOrder = math.EulerOrder;
+export type Matrix3 = math.Matrix3;
+export type Matrix4 = math.Matrix4;
+export type Quaternion = math.Quaternion;
+export type Ray = math.Ray;
+export type Vector2 = math.Vector2;
+export type Vector3 = math.Vector3;