Files
esengine/packages/editor-app/src/components/FlexLayoutDockContainer.tsx
YHH beaa1d09de feat: 预制体系统与架构改进 (#303)
* feat(prefab): 实现预制体系统和编辑器 UX 改进

## 预制体系统
- 新增 PrefabSerializer: 预制体序列化/反序列化
- 新增 PrefabInstanceComponent: 追踪预制体实例来源和修改
- 新增 PrefabService: 预制体核心服务
- 新增 PrefabLoader: 预制体资产加载器
- 新增预制体命令: Create/Instantiate/Apply/Revert/BreakLink

## 预制体编辑模式
- 支持双击 .prefab 文件进入编辑模式
- 预制体编辑模式工具栏 (保存/退出)
- 预制体实例指示器和操作菜单

## 编辑器 UX 改进
- SceneHierarchy 快捷键: F2 重命名, Ctrl+D 复制, ↑↓ 导航
- 支持双击实体名称内联编辑
- 删除实体时显示子节点数量警告
- 右键菜单添加重命名/复制选项及快捷键提示
- 布局持久化和重置功能

## Bug 修复
- 修复 editor-runtime 组件类重复导致的 TransformComponent 不识别问题
- 修复 .prefab-name 样式覆盖导致预制体工具栏文字不可见
- 修复 Inspector 资源字段高度不正确问题

* feat(editor): 改进编辑器 UX 交互体验

- ContentBrowser: 加载动画 spinner、搜索高亮、改进空状态设计
- SceneHierarchy: 选中项自动滚动到视图、搜索清除按钮
- PropertyInspector: 输入框本地状态管理、Enter/Escape 键处理
- EntityInspector: 组件折叠状态持久化、属性搜索清除按钮
- Viewport: 变换操作实时数值显示
- 国际化: 添加相关文本 (en/zh)

* fix(build): 修复 Web 构建资产加载和编辑器 UX 改进

构建系统修复:
- 修复 asset-catalog.json 字段名不匹配 (entries vs assets)
- 修复 BrowserFileSystemService 支持两种目录格式
- 修复 bundle 策略检测逻辑 (空对象判断)
- 修复 module.json 中 assetExtensions 声明和类型推断

行为树修复:
- 修复 BehaviorTreeExecutionSystem 使用 loadAsset 替代 loadAssetByPath
- 修复 BehaviorTreeAssetType 常量与 module.json 类型名一致 (behavior-tree)

编辑器 UX 改进:
- 构建完成对话框添加"打开文件夹"按钮
- 构建完成对话框样式优化 (圆形图标背景、按钮布局)
- SceneHierarchy 响应式布局 (窄窗口自动隐藏 Type 列)
- SceneHierarchy 隐藏滚动条

错误追踪:
- 添加全局错误处理器写入日志文件 (%TEMP%/esengine-editor-crash.log)
- 添加 append_to_log Tauri 命令

* feat(render): 修复 UI 渲染和点击特效系统

## UI 渲染修复
- 修复 GUID 验证 bug,使用统一的 isValidGUID() 函数
- 修复 UI 渲染顺序随机问题,Rust 端使用 IndexMap 替代 HashMap
- Web 运行时添加 assetPathResolver 支持 GUID 解析
- UIInteractableComponent.blockEvents 默认值改为 false

## 点击特效系统
- 新增 ClickFxComponent 和 ClickFxSystem
- 支持在点击位置播放粒子效果
- 支持多种触发模式和粒子轮换

## Camera 系统重构
- CameraSystem 从 ecs-engine-bindgen 移至 camera 包
- 新增 CameraManager 统一管理相机

## 编辑器改进
- 改进属性面板 UI 交互
- 粒子编辑器面板优化
- Transform 命令系统

* feat(render): 实现 Sorting Layer 系统和 Overlay 渲染层

- 新增 SortingLayerManager 管理排序层级 (Background, Default, Foreground, UI, Overlay)
- 实现 ISortable 接口,统一 Sprite、UI、Particle 的排序属性
- 修复粒子 Overlay 层被 UI 遮挡问题:添加独立的 Overlay Pass 在 UI 之后渲染
- 更新粒子资产格式:从 sortingOrder 改为 sortingLayer + orderInLayer
- 更新粒子编辑器面板支持新的排序属性
- 优化 UI 渲染系统使用新的排序层级

* feat(ci): 集成 SignPath 代码签名服务

- 添加 SignPath 自动签名工作流(Windows)
- 配置 release-editor.yml 支持代码签名
- 将构建改为草稿模式,等待签名完成后发布
- 添加证书文件到 .gitignore 防止泄露

* fix(asset): 修复 Web 构建资产路径解析和全局单例移除

## 资产路径修复
- 修复 Tauri 本地服务器 `/asset?path=...` 路径解析,正确与 root 目录连接
- BrowserPathResolver 支持两种模式:
  - 'proxy': 使用 /asset?path=... 格式(编辑器 Run in Browser)
  - 'direct': 使用直接路径 /assets/path.png(独立 Web 构建)
- BrowserRuntime 使用 'direct' 模式,无需 Tauri 代理

## 架构改进 - 移除全局单例
- 移除 globalAssetManager 导出,改用 AssetManagerToken 依赖注入
- 移除 globalPathResolver 导出,改用 PathResolutionService
- 移除 globalPathResolutionService 导出
- ParticleUpdateSystem/ClickFxSystem 通过 setAssetManager() 注入依赖
- EngineService 使用 new AssetManager() 替代全局实例

## 新增服务
- PathResolutionService: 统一路径解析接口
- RuntimeModeService: 运行时模式查询服务
- SerializationContext: EntityRef 序列化上下文

## 其他改进
- 完善 ServiceToken 注释说明本地定义的意图
- 导出 BrowserPathResolveMode 类型

* fix(build): 添加 world-streaming composite 设置修复类型检查

* fix(build): 移除 world-streaming 引用避免 composite 冲突

* fix(build): 将 const enum 改为 enum 兼容 isolatedModules

* fix(build): 添加缺失的 IAssetManager 导入
2025-12-13 19:44:08 +08:00

569 lines
21 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
/**
* FlexLayoutDockContainer - Dockable panel container based on FlexLayout
* FlexLayoutDockContainer - 基于 FlexLayout 的可停靠面板容器
*/
import { useCallback, useRef, useEffect, useState, useMemo, useImperativeHandle, forwardRef } from 'react';
import { Layout, Model, TabNode, TabSetNode, IJsonModel, Actions, Action, DockLocation } from 'flexlayout-react';
import 'flexlayout-react/style/light.css';
import '../styles/FlexLayoutDock.css';
import { LayoutMerger, LayoutBuilder, FlexDockPanel } from '../shared/layout';
export type { FlexDockPanel };
/** LocalStorage key for persisting layout | 持久化布局的 localStorage 键 */
const LAYOUT_STORAGE_KEY = 'esengine-editor-layout';
/** Layout version for migration | 布局版本用于迁移 */
const LAYOUT_VERSION = 1;
/** Saved layout data structure | 保存的布局数据结构 */
interface SavedLayoutData {
version: number;
layout: IJsonModel;
timestamp: number;
}
/**
* Save layout to localStorage.
* 保存布局到 localStorage。
*/
function saveLayoutToStorage(layout: IJsonModel): void {
try {
const data: SavedLayoutData = {
version: LAYOUT_VERSION,
layout,
timestamp: Date.now()
};
localStorage.setItem(LAYOUT_STORAGE_KEY, JSON.stringify(data));
} catch (error) {
console.warn('Failed to save layout to localStorage:', error);
}
}
/**
* Load layout from localStorage.
* 从 localStorage 加载布局。
*/
function loadLayoutFromStorage(): IJsonModel | null {
try {
const saved = localStorage.getItem(LAYOUT_STORAGE_KEY);
if (!saved) return null;
const data: SavedLayoutData = JSON.parse(saved);
// Version check for future migrations
if (data.version !== LAYOUT_VERSION) {
console.info('Layout version mismatch, using default layout');
return null;
}
return data.layout;
} catch (error) {
console.warn('Failed to load layout from localStorage:', error);
return null;
}
}
/**
* Clear saved layout from localStorage.
* 从 localStorage 清除保存的布局。
*/
function clearLayoutStorage(): void {
try {
localStorage.removeItem(LAYOUT_STORAGE_KEY);
} catch (error) {
console.warn('Failed to clear layout from localStorage:', error);
}
}
/**
* Public handle for FlexLayoutDockContainer.
* FlexLayoutDockContainer 的公开句柄。
*/
export interface FlexLayoutDockContainerHandle {
/** Reset layout to default | 重置布局到默认状态 */
resetLayout: () => void;
}
/**
* Panel IDs that should persist in DOM when switching tabs.
* These panels contain WebGL canvas or other stateful content that cannot be unmounted.
* 切换 tab 时需要保持 DOM 存在的面板 ID。
* 这些面板包含 WebGL canvas 或其他不能卸载的有状态内容。
*/
const PERSISTENT_PANEL_IDS = ['viewport'];
/** Tab header height in pixels | Tab 标签栏高度(像素) */
const TAB_HEADER_HEIGHT = 28;
interface PanelRect {
domRect: DOMRect;
isSelected: boolean;
isVisible?: boolean;
}
/**
* Get panel rectangle from FlexLayout model.
* 从 FlexLayout 模型获取面板矩形。
*/
function getPanelRectFromModel(model: Model, panelId: string): PanelRect | null {
const node = model.getNodeById(panelId);
if (!node || node.getType() !== 'tab') return null;
const parent = node.getParent();
if (!parent || parent.getType() !== 'tabset') return null;
const tabset = parent as any;
const selectedNode = tabset.getSelectedNode();
const isSelected = selectedNode?.getId() === panelId;
const tabsetRect = tabset.getRect();
if (!tabsetRect) return null;
return {
domRect: new DOMRect(
tabsetRect.x,
tabsetRect.y + TAB_HEADER_HEIGHT,
tabsetRect.width,
tabsetRect.height - TAB_HEADER_HEIGHT
),
isSelected
};
}
/**
* Get panel rectangle from DOM placeholder element.
* 从 DOM 占位符元素获取面板矩形。
*/
function getPanelRectFromDOM(panelId: string): PanelRect | null {
const placeholder = document.querySelector(`[data-panel-id="${panelId}"]`);
if (!placeholder) return null;
const placeholderRect = placeholder.getBoundingClientRect();
if (placeholderRect.width <= 0 || placeholderRect.height <= 0) return null;
const container = document.querySelector('.flexlayout-dock-container');
if (!container) return null;
const containerRect = container.getBoundingClientRect();
const parentTab = placeholder.closest('.flexlayout__tabset_content');
const isVisible = parentTab ? (parentTab as HTMLElement).offsetParent !== null : false;
return {
domRect: new DOMRect(
placeholderRect.x - containerRect.x,
placeholderRect.y - containerRect.y,
placeholderRect.width,
placeholderRect.height
),
isSelected: false,
isVisible
};
}
interface FlexLayoutDockContainerProps {
panels: FlexDockPanel[];
onPanelClose?: (panelId: string) => void;
activePanelId?: string;
messageHub?: { subscribe: (event: string, callback: (data: any) => void) => () => void } | null;
}
export const FlexLayoutDockContainer = forwardRef<FlexLayoutDockContainerHandle, FlexLayoutDockContainerProps>(
function FlexLayoutDockContainer({ panels, onPanelClose, activePanelId, messageHub }, ref) {
const layoutRef = useRef<Layout>(null);
const previousLayoutJsonRef = useRef<string | null>(null);
const previousPanelIdsRef = useRef<string>('');
const previousPanelTitlesRef = useRef<Map<string, string>>(new Map());
/** Skip saving on next model change (used when resetting layout) | 下次模型变化时跳过保存(重置布局时使用) */
const skipNextSaveRef = useRef(false);
// Persistent panel state | 持久化面板状态
const [persistentPanelRects, setPersistentPanelRects] = useState<Map<string, DOMRect>>(new Map());
const [visiblePersistentPanels, setVisiblePersistentPanels] = useState<Set<string>>(
() => new Set(PERSISTENT_PANEL_IDS)
);
const [isAnyTabsetMaximized, setIsAnyTabsetMaximized] = useState(false);
const persistentPanels = useMemo(
() => panels.filter((p) => PERSISTENT_PANEL_IDS.includes(p.id)),
[panels]
);
const createDefaultLayout = useCallback((): IJsonModel => {
return LayoutBuilder.createDefaultLayout(panels, activePanelId);
}, [panels, activePanelId]);
/**
* Try to load saved layout and merge with current panels.
* 尝试加载保存的布局并与当前面板合并。
*/
const loadSavedLayoutOrDefault = useCallback((): IJsonModel => {
const savedLayout = loadLayoutFromStorage();
if (savedLayout) {
try {
// Merge saved layout with current panels (handle new/removed panels)
const defaultLayout = createDefaultLayout();
const mergedLayout = LayoutMerger.merge(savedLayout, defaultLayout, panels);
return mergedLayout;
} catch (error) {
console.warn('Failed to merge saved layout, using default:', error);
}
}
return createDefaultLayout();
}, [createDefaultLayout, panels]);
const [model, setModel] = useState<Model>(() => {
try {
return Model.fromJson(loadSavedLayoutOrDefault());
} catch (error) {
console.warn('Failed to load saved layout, using default:', error);
return Model.fromJson(createDefaultLayout());
}
});
/**
* Reset layout to default and clear saved layout.
* 重置布局到默认状态并清除保存的布局。
*/
const resetLayout = useCallback(() => {
clearLayoutStorage();
skipNextSaveRef.current = true;
previousLayoutJsonRef.current = null;
previousPanelIdsRef.current = '';
const defaultLayout = createDefaultLayout();
setModel(Model.fromJson(defaultLayout));
}, [createDefaultLayout]);
// Expose resetLayout method via ref | 通过 ref 暴露 resetLayout 方法
useImperativeHandle(ref, () => ({
resetLayout
}), [resetLayout]);
useEffect(() => {
try {
// 检查面板ID列表是否真的变化了而不只是标题等属性变化
const currentPanelIds = panels.map((p) => p.id).sort().join(',');
const previousIds = previousPanelIdsRef.current;
// 检查标题是否变化
const currentTitles = new Map(panels.map((p) => [p.id, p.title]));
const titleChanges: Array<{ id: string; newTitle: string }> = [];
for (const panel of panels) {
const previousTitle = previousPanelTitlesRef.current.get(panel.id);
if (previousTitle && previousTitle !== panel.title) {
titleChanges.push({ id: panel.id, newTitle: panel.title });
}
}
// 更新标题引用
previousPanelTitlesRef.current = currentTitles;
// 如果只是标题变化更新tab名称
if (titleChanges.length > 0 && currentPanelIds === previousIds && model) {
titleChanges.forEach(({ id, newTitle }) => {
const node = model.getNodeById(id);
if (node && node.getType() === 'tab') {
model.doAction(Actions.renameTab(id, newTitle));
}
});
return;
}
if (currentPanelIds === previousIds) {
return;
}
// 计算新增和移除的面板
const prevSet = new Set(previousIds.split(',').filter((id) => id));
const currSet = new Set(currentPanelIds.split(',').filter((id) => id));
const newPanelIds = Array.from(currSet).filter((id) => !prevSet.has(id));
const removedPanelIds = Array.from(prevSet).filter((id) => !currSet.has(id));
previousPanelIdsRef.current = currentPanelIds;
// 如果已经有布局且只是添加新面板使用Action动态添加
// 检查新面板是否需要独立 tabset如 bottom 位置的面板)
// Check if new panels require separate tabset (e.g., bottom position panels)
const newPanelsWithConfig = panels.filter((p) => newPanelIds.includes(p.id));
const hasSpecialLayoutPanels = newPanelsWithConfig.some((p) =>
p.layout?.requiresSeparateTabset || p.layout?.position === 'bottom'
);
if (model && newPanelIds.length > 0 && removedPanelIds.length === 0 && previousIds && !hasSpecialLayoutPanels) {
// 找到要添加的面板
const newPanels = panels.filter((p) => newPanelIds.includes(p.id));
// 构建面板位置映射 | Build panel position map
const panelPositionMap = new Map(panels.map((p) => [p.id, p.layout?.position || 'center']));
// 找到中心区域的tabset ID | Find center tabset ID
let centerTabsetId: string | null = null;
model.visitNodes((node: any) => {
if (node.getType() === 'tabset') {
const tabset = node as any;
// 检查是否是中心tabset包含 center 位置的面板)
// Check if this is center tabset (contains center position panels)
const children = tabset.getChildren();
const hasCenterPanel = children.some((child: any) => {
const id = child.getId();
const position = panelPositionMap.get(id);
return position === 'center' || position === undefined;
});
if (hasCenterPanel && !centerTabsetId) {
centerTabsetId = tabset.getId();
}
}
});
if (centerTabsetId) {
// 动态添加tab到中心tabset
newPanels.forEach((panel) => {
model.doAction(Actions.addNode(
{
type: 'tab',
name: panel.title,
id: panel.id,
component: panel.id,
enableClose: panel.closable !== false
},
centerTabsetId!,
DockLocation.CENTER,
-1 // 添加到末尾
));
});
// 选中最后添加的面板
const lastPanel = newPanels[newPanels.length - 1];
if (lastPanel) {
setTimeout(() => {
const node = model.getNodeById(lastPanel.id);
if (node) {
model.doAction(Actions.selectTab(lastPanel.id));
}
}, 0);
}
return;
}
}
// 否则完全重建布局
const defaultLayout = createDefaultLayout();
// 如果有保存的布局,尝试合并
// 注意:如果新面板需要特殊布局(独立 tabset直接使用默认布局
// Note: If new panels need special layout (separate tabset), use default layout directly
if (previousLayoutJsonRef.current && previousIds && !hasSpecialLayoutPanels) {
try {
const savedLayout = JSON.parse(previousLayoutJsonRef.current);
const mergedLayout = LayoutMerger.merge(savedLayout, defaultLayout, panels);
const newModel = Model.fromJson(mergedLayout);
setModel(newModel);
return;
} catch (error) {
// 合并失败,使用默认布局
}
}
// 使用默认布局
const newModel = Model.fromJson(defaultLayout);
setModel(newModel);
} catch (error) {
throw new Error(`Failed to update layout model: ${error instanceof Error ? error.message : String(error)}`);
}
}, [createDefaultLayout, panels]);
/**
* Track persistent panel positions and visibility.
* Uses FlexLayout model to determine if panel tab is selected,
* falls back to DOM measurement if model data unavailable.
* 追踪持久化面板的位置和可见性。
* 使用 FlexLayout 模型判断面板 tab 是否被选中,
* 如果模型数据不可用则回退到 DOM 测量。
*/
useEffect(() => {
if (!model) return;
const updatePersistentPanelPositions = () => {
const newRects = new Map<string, DOMRect>();
const newVisible = new Set<string>();
for (const panelId of PERSISTENT_PANEL_IDS) {
// Try to get position from FlexLayout model
const rect = getPanelRectFromModel(model, panelId);
if (rect) {
newRects.set(panelId, rect.domRect);
if (rect.isSelected) {
newVisible.add(panelId);
}
continue;
}
// Fallback: measure placeholder element in DOM
const placeholderRect = getPanelRectFromDOM(panelId);
if (placeholderRect) {
newRects.set(panelId, placeholderRect.domRect);
if (placeholderRect.isVisible) {
newVisible.add(panelId);
}
}
}
setPersistentPanelRects(newRects);
setVisiblePersistentPanels(newVisible);
};
// Initial update after DOM render
requestAnimationFrame(updatePersistentPanelPositions);
// Observe layout changes
const container = document.querySelector('.flexlayout-dock-container');
if (!container) return;
const mutationObserver = new MutationObserver(() => {
requestAnimationFrame(updatePersistentPanelPositions);
});
mutationObserver.observe(container, { childList: true, subtree: true, attributes: true });
const resizeObserver = new ResizeObserver(() => {
requestAnimationFrame(updatePersistentPanelPositions);
});
resizeObserver.observe(container);
return () => {
mutationObserver.disconnect();
resizeObserver.disconnect();
};
}, [model]);
const factory = useCallback((node: TabNode) => {
const componentId = node.getComponent() || '';
// Persistent panels render as placeholder, actual content is in overlay
// 持久化面板渲染为占位符,实际内容在覆盖层中
if (PERSISTENT_PANEL_IDS.includes(componentId)) {
return <div className="persistent-panel-placeholder" data-panel-id={componentId} />;
}
const panel = panels.find((p) => p.id === componentId);
return panel?.content ?? <div>Panel not found</div>;
}, [panels]);
const onAction = useCallback((action: Action) => {
if (action.type === Actions.DELETE_TAB) {
const tabId = (action.data as { node: string }).node;
if (onPanelClose) {
onPanelClose(tabId);
}
}
return action;
}, [onPanelClose]);
const onModelChange = useCallback((newModel: Model) => {
// 保存布局状态以便在panels变化时恢复
const layoutJson = newModel.toJson();
previousLayoutJsonRef.current = JSON.stringify(layoutJson);
// Save to localStorage (unless skipped) | 保存到 localStorage除非跳过
if (skipNextSaveRef.current) {
skipNextSaveRef.current = false;
} else {
saveLayoutToStorage(layoutJson);
}
// Check if any tabset is maximized
let hasMaximized = false;
newModel.visitNodes((node) => {
if (node.getType() === 'tabset') {
const tabset = node as TabSetNode;
if (tabset.isMaximized()) {
hasMaximized = true;
}
}
});
setIsAnyTabsetMaximized(hasMaximized);
}, []);
useEffect(() => {
if (!messageHub || !model) return;
const unsubscribe = messageHub.subscribe('panel:select', (data: { panelId: string }) => {
const { panelId } = data;
const node = model.getNodeById(panelId);
if (node && node.getType() === 'tab') {
model.doAction(Actions.selectTab(panelId));
}
});
return () => unsubscribe?.();
}, [messageHub, model]);
return (
<div className="flexlayout-dock-container">
<Layout
ref={layoutRef}
model={model}
factory={factory}
onAction={onAction}
onModelChange={onModelChange}
/>
{/* Persistent panel overlay - always mounted, visibility controlled by CSS */}
{/* 持久化面板覆盖层 - 始终挂载,通过 CSS 控制可见性 */}
{persistentPanels.map((panel) => (
<PersistentPanelContainer
key={panel.id}
panel={panel}
rect={persistentPanelRects.get(panel.id)}
isVisible={visiblePersistentPanels.has(panel.id)}
isMaximized={isAnyTabsetMaximized}
/>
))}
</div>
);
});
/**
* Container for persistent panel content.
* 持久化面板内容容器。
*/
function PersistentPanelContainer({
panel,
rect,
isVisible,
isMaximized
}: {
panel: FlexDockPanel;
rect?: DOMRect;
isVisible: boolean;
isMaximized: boolean;
}) {
const hasValidRect = rect && rect.width > 0 && rect.height > 0;
// Hide persistent panel completely when another tabset is maximized
// (unless this panel itself is in the maximized tabset)
const shouldHide = isMaximized && !isVisible;
return (
<div
className="persistent-panel-container"
style={{
position: 'absolute',
left: hasValidRect ? rect.x : 0,
top: hasValidRect ? rect.y : 0,
width: hasValidRect ? rect.width : '100%',
height: hasValidRect ? rect.height : '100%',
visibility: (isVisible && !shouldHide) ? 'visible' : 'hidden',
pointerEvents: (isVisible && !shouldHide) ? 'auto' : 'none',
// 使用较低的 z-index确保不会遮挡 FlexLayout 的 tab bar
zIndex: 0,
overflow: 'hidden'
}}
>
{panel.content}
</div>
);
}