@galacean/effects-plugin-editor-gizmo 2.10.3 → 2.11.0-alpha.0

package/dist/2d/drawing.d.ts

@@ -0,0 +1,148 @@
+import type { Control } from '@galacean/effects-plugin-gui';
+import { type Box2 } from '@galacean/effects-math/es/extension/index';
+import type { Vector2 } from './math';
+import { Color } from './math';
+/** 信息标签默认字号。 */
+export declare const INFO_TEXT_FONT_SIZE = 14;
+/** 信息标签默认字体。 */
+export declare const INFO_TEXT_FONT_FAMILY = "sans-serif";
+/** effects Control 字符 atlas 的固定单边留白。 */
+export declare const CONTROL_TEXT_GLYPH_PADDING = 4;
+/** 用于测量字体高度的代表字符。 */
+export declare const METRICS_STRING = "|\u00C9q\u00C5";
+/** 用于测量字体基线的字符。 */
+export declare const BASELINE_SYMBOL = "M";
+/**
+ * 将十六进制色值 + alpha 转为 effects Color（带全局缓存）。
+ * @param hex 0xRRGGBB 颜色
+ * @param alpha 透明度 0..1
+ * @returns effects Color
+ */
+export declare function toColor(hex: number, alpha?: number): Color;
+/** 文本宽度和可见字形边界。 */
+export type MeasuredTextMetrics = {
+    /** 文本宽度。 */
+    width: number;
+    /** 基线到可见字形顶部的距离。 */
+    actualBoundingBoxAscent: number;
+    /** 基线到可见字形底部的距离。 */
+    actualBoundingBoxDescent: number;
+};
+/**
+ * 测量文本的宽度与可见字形边界。
+ * @param text 文本内容
+ * @param fontSize 字号
+ * @param fontFamily 字体
+ * @param fontWeight 字重
+ * @param fontStyle 字体样式
+ * @returns 文本测量结果
+ */
+export declare function measureTextMetrics(text: string, fontSize?: number, fontFamily?: string, fontWeight?: string, fontStyle?: string): MeasuredTextMetrics;
+/**
+ * 计算 effects Control.drawText 实际使用的 atlas cell 高度。
+ * @param fontSize 字号
+ * @param fontFamily 字体
+ * @param fontWeight 字重
+ * @param fontStyle 字体样式
+ * @param resolution 渲染分辨率
+ * @returns 字符图集单元格高度
+ */
+export declare function measureControlTextCellHeight(fontSize?: number, fontFamily?: string, fontWeight?: string, fontStyle?: string, resolution?: number): number;
+/**
+ * 测量文本宽度（逻辑像素），用于信息标签的溢出判断与右对齐定位。
+ * @param text 文本内容
+ * @param fontSize 字号
+ * @param fontFamily 字体
+ * @param fontWeight 字重
+ * @returns 文本宽度
+ */
+export declare function measureTextWidth(text: string, fontSize?: number, fontFamily?: string, fontWeight?: string): number;
+/**
+ * 单行文本截断：逐字符累加，超出可用宽度时把最后两个字符替换为省略号。
+ * @param text 文本内容
+ * @param maxWidth 可用宽度
+ * @param fontSize 字号
+ * @param fontFamily 字体
+ * @returns 截断后的文本
+ */
+export declare function truncateText(text: string, maxWidth: number, fontSize?: number, fontFamily?: string): string;
+/**
+ * 多行逐字符折行：行宽超出 maxWidth 时换行；行数达到 maxLines 时末行用省略号收尾。
+ * @param text 文本内容
+ * @param maxWidth 单行可用宽度
+ * @param maxLines 最大行数
+ * @param fontSize 字号
+ * @param fontFamily 字体
+ * @returns 折行后的文本行数组
+ */
+export declare function wrapText(text: string, maxWidth: number, maxLines: number, fontSize?: number, fontFamily?: string): string[];
+/**
+ * 绘制由 4 个角点构成的（可能非正交的）包围盒边框。
+ * @param control 绘制控制器
+ * @param corners 4 个角点（视图坐标，Y 向下）
+ * @param color 边框颜色
+ * @param width 线宽
+ */
+export declare function drawCorners(control: Control, corners: Vector2[], color: Color, width: number): void;
+/**
+ * 绘制虚线包围盒，并在相邻边之间保持连续虚线相位。
+ * @param control 绘制控制器
+ * @param corners 四个视图角点
+ * @param color 虚线颜色
+ * @param width 线宽
+ * @param dashLength 实线段长度
+ * @param gapLength 间隔长度
+ */
+export declare function drawDashedCorners(control: Control, corners: Vector2[], color: Color, width: number, dashLength: number, gapLength: number): void;
+/**
+ * 绘制包围盒边框（沿 4 个角点连边）。
+ * @param control 绘制控制器
+ * @param box 包围盒（视图坐标，Y 向下）
+ * @param color 边框颜色
+ * @param width 线宽
+ */
+export declare function drawBox(control: Control, box: Box2, color: Color, width: number): void;
+/**
+ * 填充轴对齐包围盒（实心矩形）。
+ * @param control 绘制控制器
+ * @param box 包围盒（视图坐标，Y 向下）
+ * @param color 填充颜色
+ */
+export declare function fillBox(control: Control, box: Box2, color: Color): void;
+/**
+ * 用两个三角形填充 Box2 四角区域。
+ * @param control 绘制控件
+ * @param corners Box2 四角快照
+ * @param color 填充颜色
+ */
+export declare function fillBoxByCorners(control: Control, corners: Vector2[], color: Color): void;
+/**
+ * 构造沿局部轴展开的旋转矩形角点。
+ * @param center 矩形中心（视图坐标）
+ * @param xAxis 局部 X 轴单位向量（视图坐标，宽方向）
+ * @param yAxis 局部 Y 轴单位向量（视图坐标，高方向）
+ * @param halfWidth 半宽（沿 xAxis，视图像素）
+ * @param halfHeight 半高（沿 yAxis，视图像素）
+ * @returns 4 个角点（视图坐标，环绕顺序）
+ */
+export declare function getRotatedBoxCorners(center: Vector2, xAxis: Vector2, yAxis: Vector2, halfWidth: number, halfHeight: number): Vector2[];
+/**
+ * 填充沿局部轴展开的旋转矩形。
+ * @param control 绘制控制器
+ * @param center 矩形中心（视图坐标）
+ * @param xAxis 局部 X 轴单位向量（视图坐标，宽方向）
+ * @param yAxis 局部 Y 轴单位向量（视图坐标，高方向）
+ * @param width 宽（沿 xAxis，视图像素）
+ * @param height 高（沿 yAxis，视图像素）
+ * @param color 填充颜色
+ */
+export declare function fillRotatedRect(control: Control, center: Vector2, xAxis: Vector2, yAxis: Vector2, width: number, height: number, color: Color): void;
+/**
+ * 在由锚点和两个基向量定义的局部坐标系内执行绘制。
+ * @param control 绘制控制器
+ * @param anchor Control 绘制空间锚点（局部原点）
+ * @param ex 局部 X 轴基向量（单位向量）
+ * @param ey 局部 Y 轴基向量（单位向量）
+ * @param drawFn 在局部坐标系内执行的绘制
+ */
+export declare function drawWithBoxTransform(control: Control, anchor: Vector2, ex: Vector2, ey: Vector2, drawFn: () => void): void;

package/dist/2d/frame/frame-assisted-layout.d.ts

@@ -0,0 +1,115 @@
+import { type VFXItem } from '@galacean/effects';
+import type { Control } from '@galacean/effects-plugin-gui';
+import type { GizmoOwner } from '../gizmo-owner';
+import { Vector2 } from '../math';
+/** 选区拖拽产生的层级位置变更。 */
+export type SelectionPlacementChange = {
+    /** 移入画板。 */
+    type: 'moveIn';
+    /** 待移入元素 ID。 */
+    itemIds: string[];
+    /** 目标画板 ID。 */
+    targetFrameId: string;
+} | {
+    /** 移出画板。 */
+    type: 'moveOut';
+    /** 待移出元素 ID。 */
+    itemIds: string[];
+    /** 原画板 ID。 */
+    originalFrameId: string;
+} | {
+    /** 子元素脱离组合。 */
+    type: 'detachGroupChildren';
+    /** 原组合 ID。 */
+    groupId: string;
+    /** 待脱离的子元素 ID。 */
+    itemIds: string[];
+    /** 原画板 ID。 */
+    originalFrameId: string;
+};
+/** 自动布局重排的起止位置。 */
+export type AutoLayoutChangeInfo = {
+    /** 画板 ID。 */
+    frameId: string;
+    /** 被拖拽元素 ID。 */
+    draggedItemId: string;
+    /** 原行号。 */
+    fromRow: number;
+    /** 原列号。 */
+    fromColumn: number;
+    /** 目标行号。 */
+    toRow: number;
+    /** 目标列号。 */
+    toColumn: number;
+};
+/** 辅助布局交互的提交结果。 */
+export type AssistedLayoutFinishResult = {
+    /** 层级位置变更。 */
+    placementChanges: SelectionPlacementChange[];
+    /** 自动布局重排信息。 */
+    autoLayoutChange?: AutoLayoutChangeInfo;
+};
+/** 计算选区拖拽期间的画板归属、自动布局位置和视觉提示。 */
+export declare class AssistedLayout {
+    private readonly owner;
+    private readonly engine;
+    private selectedItems;
+    private readonly selectedFrameIds;
+    private readonly currentFrameIds;
+    private readonly pendingGroupDetaches;
+    private targetFrameId;
+    private autoLayoutIndicator;
+    private autoLayoutDragOriginalPosition;
+    private autoLayoutDragFrameId;
+    private autoLayoutDragItemId;
+    private pendingLayoutPosition;
+    /**
+     * @param owner Gizmo 宿主
+     */
+    constructor(owner: GizmoOwner);
+    /**
+     * 开始辅助布局会话并记录元素原画板。
+     * @param selectedItems 当前选中元素
+     */
+    begin(selectedItems: readonly VFXItem[]): void;
+    /**
+     * 根据当前指针计算元素移入或移出画板的变更。
+     * @param pointer 当前指针视图坐标
+     * @returns 本帧需要应用的层级位置变更
+     */
+    resolveReparent(pointer: Vector2): SelectionPlacementChange[];
+    /**
+     * 更新自动布局目标位置和插入指示器。
+     * @param pointer 当前指针视图坐标
+     */
+    updateAutoLayout(pointer: Vector2): void;
+    /** @returns 当前会话需要提交的层级和自动布局变更。 */
+    finish(): AssistedLayoutFinishResult;
+    /**
+     * 绘制目标画板和自动布局插入指示器。
+     * @param control 绘制控制器
+     */
+    draw(control: Control): void;
+    /** 取消会话并清空全部辅助布局状态。 */
+    cancel(): void;
+    /**
+     * 计算单个元素相对画板的层级位置变更。
+     * @param item 被拖拽元素
+     * @param pointer 当前指针视图坐标
+     * @param frameInfos 当前画板视图信息
+     * @param containerSize 画布容器尺寸
+     * @returns 目标画板和可选的层级位置变更
+     */
+    private resolveItemReparent;
+    /** 清空自动布局指示器和待提交位置。 */
+    private clearAutoLayoutVisualState;
+    /** 清空自动布局会话状态。 */
+    private clearAutoLayoutState;
+    /**
+     * 为没有参考元素的位置创建画板边缘指示线。
+     * @param frameBox 画板视图包围盒
+     * @param layoutPosition 目标行列位置
+     * @returns 插入指示线
+     */
+    private createFallbackIndicatorLine;
+}

package/dist/2d/frame/frame-auto-layout.d.ts

@@ -0,0 +1,47 @@
+import type { AutoLayoutConfig } from './types';
+import type { Box2 } from '@galacean/effects-math/es/extension/index';
+/** 参与画板自动布局的元素。 */
+export type FrameLayoutItem = {
+    /** 元素 ID。 */
+    id: string;
+    /** 元素包围盒。 */
+    box: Box2;
+    /** 已指定的行号。 */
+    row?: number;
+    /** 已指定的列号。 */
+    column?: number;
+};
+/** 自动布局后的元素位置。 */
+export type FrameLayoutResultItem = {
+    /** 元素 ID。 */
+    id: string;
+    /** 相对画板左上角的中心位置。 */
+    position: [number, number];
+    /** 行号。 */
+    row: number;
+    /** 列号。 */
+    column: number;
+};
+/** 画板自动布局选项。 */
+export type FrameAutoLayoutOptions = {
+    /** 画板内边距。 */
+    padding?: number;
+    /** 元素间距。 */
+    gap?: number;
+    /** 行宽和行数约束。 */
+    config?: AutoLayoutConfig;
+};
+/** 画板自动布局结果。 */
+export type FrameAutoLayoutResult = {
+    /** 布局后的元素。 */
+    items: FrameLayoutResultItem[];
+    /** 布局所需的画板尺寸。 */
+    size: [number, number];
+};
+/**
+ * 计算画板内元素的自动布局和画板尺寸。
+ * @param items 待布局元素
+ * @param options 布局间距与行约束
+ * @returns 自动布局结果
+ */
+export declare function computeFrameAutoLayout(items: FrameLayoutItem[], options?: FrameAutoLayoutOptions): FrameAutoLayoutResult;

package/dist/2d/frame/frame-manager.d.ts

@@ -0,0 +1,169 @@
+import type { Engine } from '@galacean/effects';
+import { type Vector2 } from '../math';
+import { FrameLayoutMode, type AutoLayoutConfig, type FrameInfo, type LayoutInfo } from './types';
+import { type FrameAutoLayoutOptions, type FrameAutoLayoutResult, type FrameLayoutItem } from './frame-auto-layout';
+/** 画板运行时布局数据。 */
+export type FrameRecord = {
+    /** 画板元素实例 ID。 */
+    id: string;
+    /** 布局模式。 */
+    layoutMode: FrameLayoutMode;
+    /** 子元素实例 ID。 */
+    children: string[];
+    /** 自动布局约束。 */
+    autoLayoutConfig?: AutoLayoutConfig;
+    /** 子元素布局信息。 */
+    layoutInfos: Record<string, LayoutInfo>;
+};
+/** 新建或更新画板数据的输入。 */
+export type FrameRecordInput = {
+    /** 画板元素实例 ID。 */
+    id: string;
+    /** 布局模式。 */
+    layoutMode?: FrameLayoutMode;
+    /** 子元素实例 ID。 */
+    children?: readonly string[];
+    /** 自动布局约束。 */
+    autoLayoutConfig?: AutoLayoutConfig;
+    /** 子元素布局信息。 */
+    layoutInfos?: Readonly<Record<string, LayoutInfo>>;
+};
+/** 管理画板布局数据及其视图投影。 */
+export declare class FrameManager {
+    private readonly records;
+    private readonly boxes;
+    private readonly engine;
+    /**
+     * @param engine 用于更新画板投影的 Effects 引擎
+     */
+    constructor(engine: Engine);
+    /**
+     * 新建或覆盖画板数据。
+     * @param input 画板数据
+     * @returns 保存后的画板记录
+     */
+    upsertFrame(input: FrameRecordInput): FrameRecord;
+    /**
+     * 获取画板记录，不存在时创建。
+     * @param input 画板数据
+     * @returns 已存在或新建的画板记录
+     */
+    ensureFrame(input: FrameRecordInput): FrameRecord;
+    /**
+     * 删除画板记录和投影。
+     * @param id 画板 ID
+     * @returns 是否删除了画板记录
+     */
+    deleteFrame(id: string): boolean;
+    /** 清空全部画板数据和投影。 */
+    clear(): void;
+    /**
+     * 使用输入列表重建画板数据。
+     * @param records 画板数据列表
+     */
+    hydrate(records: readonly FrameRecordInput[]): void;
+    /** @returns 全部画板数据的深拷贝快照。 */
+    snapshot(): FrameRecord[];
+    /**
+     * 获取指定画板数据。
+     * @param id 画板 ID
+     * @returns 画板数据；不存在时返回 undefined
+     */
+    getFrame(id: string): Readonly<FrameRecord> | undefined;
+    /** @returns 全部画板数据。 */
+    getFrames(): readonly Readonly<FrameRecord>[];
+    /**
+     * 设置画板布局模式。
+     * @param id 画板 ID
+     * @param layoutMode 布局模式
+     */
+    setLayoutMode(id: string, layoutMode: FrameLayoutMode): void;
+    /**
+     * 替换画板子元素列表。
+     * @param id 画板 ID
+     * @param children 子元素 ID
+     */
+    setChildren(id: string, children: readonly string[]): void;
+    /**
+     * 向画板添加子元素。
+     * @param id 画板 ID
+     * @param childId 子元素 ID
+     * @returns 是否添加成功
+     */
+    addChild(id: string, childId: string): boolean;
+    /**
+     * 从画板移除子元素及其布局信息。
+     * @param id 画板 ID
+     * @param childId 子元素 ID
+     * @returns 是否移除成功
+     */
+    removeChild(id: string, childId: string): boolean;
+    /**
+     * 替换画板的全部子元素布局信息。
+     * @param id 画板 ID
+     * @param layoutInfos 子元素布局信息
+     */
+    setLayoutInfos(id: string, layoutInfos: Readonly<Record<string, LayoutInfo>> | undefined): void;
+    /**
+     * 设置单个子元素的布局信息。
+     * @param id 画板 ID
+     * @param childId 子元素 ID
+     * @param layoutInfo 布局信息
+     */
+    setChildLayoutInfo(id: string, childId: string, layoutInfo: LayoutInfo): void;
+    /**
+     * 设置画板自动布局约束。
+     * @param id 画板 ID
+     * @param config 自动布局约束
+     */
+    setAutoLayoutConfig(id: string, config: AutoLayoutConfig | undefined): void;
+    /**
+     * 使用画板当前布局信息计算自动布局。
+     * @param frameId 画板 ID
+     * @param items 待布局元素
+     * @param options 内边距和元素间距
+     * @returns 自动布局结果；画板不存在时返回 undefined
+     */
+    computeAutoLayout(frameId: string, items: readonly Pick<FrameLayoutItem, 'id' | 'box'>[], options?: Omit<FrameAutoLayoutOptions, 'config'>): FrameAutoLayoutResult | undefined;
+    /**
+     * 计算元素重排后的完整布局信息。
+     * @param frameId 画板 ID
+     * @param draggedItemId 被拖拽元素 ID
+     * @param fromRow 原行号
+     * @param fromColumn 原列号
+     * @param toRow 目标行号
+     * @param toColumn 目标列号
+     * @returns 重排后的布局信息；元素不属于画板时返回 undefined
+     */
+    computeLayoutInfosAfterReorder(frameId: string, draggedItemId: string, fromRow: number, fromColumn: number, toRow: number, toColumn: number): Record<string, LayoutInfo> | undefined;
+    /** 在每帧更新时同步画板投影。 */
+    onUpdate(): void;
+    /** 更新全部画板的视图包围盒。 */
+    updateViewBoxes(): void;
+    /** @returns 带当前视图包围盒的全部画板信息。 */
+    getViewInfos(): FrameInfo[];
+    /**
+     * 获取指定画板的视图信息。
+     * @param id 画板 ID
+     * @returns 画板视图信息；不存在时返回 undefined
+     */
+    getViewInfo(id: string): FrameInfo | undefined;
+    /**
+     * 查找元素所属的画板。
+     * @param itemId 元素 ID
+     * @returns 父画板记录；不存在时返回 undefined
+     */
+    getParentFrame(itemId: string): Readonly<FrameRecord> | undefined;
+    /**
+     * 查找包含指定视图坐标的画板。
+     * @param point 视图坐标
+     * @returns 命中的画板视图信息
+     */
+    findFrameAt(point: Vector2): FrameInfo | undefined;
+    /**
+     * 将画板记录转换为视图信息。
+     * @param record 画板记录
+     * @returns 画板视图信息
+     */
+    private toViewInfo;
+}

package/dist/2d/frame/frame-resize.d.ts

@@ -0,0 +1,13 @@
+import type { VFXItem } from '@galacean/effects';
+import { type Vector2, Vector3 } from '../math';
+/**
+ * 调整画板元素（Frame）的尺寸与位置，并同步其子合成 Item 的位移。
+ * @param frameItem 画板元素（Frame 空节点控制器）
+ * @param worldSize 目标世界尺寸（所属合成坐标系，不受 viewport zoom 影响）
+ * @param translation 位移
+ * @param initialSize pointer down 时冻结的本地 / 世界尺寸；传入后允许尺寸连续经过 0 并变为负值
+ */
+export declare function resizeFrameItem(frameItem: VFXItem, worldSize: Vector2, translation: Vector3, initialSize?: {
+    localSize: Vector2;
+    worldSize: Vector2;
+}): void;

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

@@ -0,0 +1,5 @@
+export * from './frame-auto-layout';
+export * from './frame-manager';
+export * from './frame-resize';
+export * from './layout-calculations';
+export * from './types';

package/dist/2d/frame/layout-calculations.d.ts

@@ -0,0 +1,109 @@
+import type { Box2 } from '@galacean/effects-math/es/extension/index';
+import { Line2 } from '@galacean/effects-math/es/extension/index';
+import { Vector2 } from '../math';
+import type { LayoutInfo } from './types';
+/** 自动布局兄弟元素的几何与位置信息。 */
+export type SiblingInfo = {
+    /** 元素 ID。 */
+    id: string;
+    /** 视图包围盒。 */
+    box: Box2;
+    /** 包围盒中心点。 */
+    center: Vector2;
+    /** 自动布局位置。 */
+    layoutInfo?: LayoutInfo;
+};
+/** 自动布局插入指示器。 */
+export type AutoLayoutIndicator = {
+    /** 目标画板 ID。 */
+    frameId: string;
+    /** 在画板子元素列表中的插入索引。 */
+    insertIndex: number;
+    /** 相对参考元素的插入方向。 */
+    insertDirection: 'before' | 'after';
+    /** 参考兄弟元素 ID。 */
+    targetSiblingId?: string;
+    /** 插入指示线。 */
+    line: Line2;
+    /** 目标行号。 */
+    targetRow?: number;
+    /** 目标列号。 */
+    targetColumn?: number;
+} | null;
+/** 自动布局中的行列位置。 */
+export type LayoutPosition = {
+    /** 行号。 */
+    row: number;
+    /** 列号。 */
+    column: number;
+};
+/** 自动布局的插入位置及指示器依据。 */
+export type InsertInfo = {
+    /** 在画板子元素列表中的插入索引。 */
+    index: number;
+    /** 相对参考元素的插入方向。 */
+    direction: 'before' | 'after';
+    /** 参考兄弟元素 ID。 */
+    siblingId?: string;
+    /** 目标行号。 */
+    row: number;
+    /** 目标列号。 */
+    column: number;
+    /** 跨行移动信息。 */
+    rowChange?: {
+        /** 原行号。 */
+        fromRow: number;
+        /** 目标行号。 */
+        toRow: number;
+        /** 原行的视图边界。 */
+        rowBounds?: {
+            /** 最小 Y 坐标。 */
+            minY: number;
+            /** 最大 Y 坐标。 */
+            maxY: number;
+            /** 最小 X 坐标。 */
+            minX: number;
+            /** 最大 X 坐标。 */
+            maxX: number;
+        };
+        /** 是否发生跨行移动。 */
+        isRowChange: boolean;
+    };
+    /** 参考元素包围盒。 */
+    box?: Box2;
+};
+/** 已解析行列位置的兄弟元素。 */
+export type SiblingWithInfo = {
+    /** 元素 ID。 */
+    id: string;
+    /** 视图包围盒。 */
+    box: Box2;
+    /** 行号。 */
+    row: number;
+    /** 列号。 */
+    column: number;
+    /** 包围盒中心 X 坐标。 */
+    centerX: number;
+};
+/**
+ * 计算自动布局插入指示线。
+ * @param insertInfo 插入位置信息
+ * @returns 主指示线
+ */
+export declare function calculateAutoLayoutIndicatorLine(insertInfo: InsertInfo): Line2;
+/**
+ * 基于鼠标位置计算布局位置（row 和 column）。
+ * @param mousePoint 鼠标位置
+ * @param siblingInfos 所有兄弟元素的信息
+ * @returns 布局位置信息 { row: number, column: number }
+ */
+export declare function calculateAutoLayoutPositionByMouse(mousePoint: Vector2, siblingInfos: SiblingInfo[]): LayoutPosition | null;
+/**
+ * 基于鼠标位置计算插入位置（用于显示指示器）。
+ * @param mousePoint 鼠标位置
+ * @param siblingsWithInfos 所有兄弟元素信息
+ * @param allChildren 所有兄弟元素ID数组
+ * @param originalRow 原始行号
+ * @returns 插入位置信息和计算出的行列位置
+ */
+export declare function calculateInsertPositionFromLayout(mousePoint: Vector2, siblingsWithInfos: SiblingWithInfo[], allChildren: string[], originalRow: number): InsertInfo;

package/dist/2d/frame/types.d.ts

@@ -0,0 +1,41 @@
+import type { Box2 } from '@galacean/effects-math/es/extension/index';
+/** 画板布局模式。 */
+export declare enum FrameLayoutMode {
+    /** 自动布局：元素按行列规则自动排布。 */
+    AUTO = "auto",
+    /** 自由布局：元素位置不受布局约束。 */
+    FREE = "free"
+}
+/** 画板数据及其当前视图包围盒。 */
+export type FrameInfo = {
+    /** 画板元素 ID。 */
+    id: string;
+    /** 当前视图包围盒。 */
+    box: Box2;
+    /** 布局模式。 */
+    layoutMode: FrameLayoutMode;
+    /** 子元素 ID。 */
+    children: string[];
+    /** 子元素自动布局信息。 */
+    layoutInfos: Record<string, LayoutInfo>;
+};
+/** 元素在自动布局中的位置信息。 */
+export type LayoutInfo = {
+    /**
+     * 所在行号（可为小数）。
+     * 整数部分为主行号（0, 1, 2...），小数部分为分行后的子行号（如 1.5 表示第 1 行的第 5 个子行），
+     * 仅支持两层（即小数部分为 0-9）。
+     */
+    row: number;
+    /** 所在列号（必须为整数）。 */
+    column: number;
+    /** 元素在布局中的位置（相对于画板左上角，可选）。 */
+    position?: [number, number];
+};
+/** 画板自动布局约束。 */
+export type AutoLayoutConfig = {
+    /** 单行最大宽度。 */
+    maxRowWidth?: number;
+    /** 最大行数。 */
+    maxRowCount?: number;
+};