refactor(ui): UI 系统架构重构 (#309)
* feat(ui): 动态图集系统与渲染调试增强 ## 核心功能 ### 动态图集系统 (Dynamic Atlas) - 新增 DynamicAtlasManager：运行时纹理打包，支持 MaxRects 算法 - 新增 DynamicAtlasService：自动纹理加载与图集管理 - 新增 BinPacker：高效矩形打包算法 - 支持动态/固定两种扩展策略 - 自动 UV 重映射，实现 UI 元素合批渲染 ### Frame Debugger 增强 - 新增合批分析面板，显示批次中断原因 - 新增 UI 元素层级信息（depth, worldOrderInLayer） - 新增实体高亮功能，点击可在场景中定位 - 新增动态图集可视化面板 - 改进渲染原语详情展示 ### 闪光效果 (Shiny Effect) - 新增 UIShinyEffectComponent：UI 闪光参数配置 - 新增 UIShinyEffectSystem：材质覆盖驱动的闪光动画 - 新增 ShinyEffectComponent/System（Sprite 版本） ## 引擎层改进 ### Rust 纹理管理扩展 - create_blank_texture：创建空白 GPU 纹理 - update_texture_region：局部纹理更新 - 支持动态图集的 GPU 端操作 ### 材质系统 - 新增 effects/ 目录：ShinyEffect 等效果实现 - 新增 interfaces/ 目录：IMaterial 等接口定义 - 新增 mixins/ 目录：可组合的材质功能 ### EngineBridge 扩展 - 新增 createBlankTexture/updateTextureRegion 方法 - 改进纹理加载回调机制 ## UI 渲染改进 - UIRenderCollector：支持合批调试信息 - 稳定排序：addIndex 保证渲染顺序一致性 - 九宫格渲染优化 - 材质覆盖支持 ## 其他改进 - 国际化：新增 Frame Debugger 相关翻译 - 编辑器：新增渲染调试入口 - 文档：新增架构设计文档目录 * refactor(ui): 引入新基础组件架构与渲染工具函数 Phase 1 重构 - 组件职责分离与代码复用： 新增基础组件层： - UIGraphicComponent: 所有可视 UI 元素的基类（颜色、透明度、raycast） - UIImageComponent: 纹理显示组件（支持简单、切片、平铺、填充模式） - UISelectableComponent: 可交互元素的基类（状态管理、颜色过渡） 新增渲染工具： - UIRenderUtils: 提取共享的坐标计算、边框渲染、阴影渲染等工具函数 - getUIRenderTransform: 统一的变换数据提取 - renderBorder/renderShadow: 复用的边框和阴影渲染逻辑 新增渲染系统： - UIGraphicRenderSystem: 处理新基础组件的统一渲染器 重构现有系统： - UIRectRenderSystem: 使用新工具函数，移除重复代码 - UIButtonRenderSystem: 使用新工具函数，移除重复代码 这些改动为后续统一渲染系统奠定基础。 * refactor(ui): UIProgressBarRenderSystem 使用渲染工具函数 - 使用 getUIRenderTransform 替代手动变换计算 - 使用 renderBorder 工具函数替代重复的边框渲染 - 使用 lerpColor 工具函数替代重复的颜色插值 - 简化方法签名，使用 UIRenderTransform 类型 - 移除约 135 行重复代码 * refactor(ui): Slider 和 ScrollView 渲染系统使用工具函数 - UISliderRenderSystem: 使用 getUIRenderTransform，简化方法签名 - UIScrollViewRenderSystem: 使用 getUIRenderTransform，简化方法签名 - 统一使用 UIRenderTransform 类型减少参数传递 - 消除重复的变换计算代码 * refactor(ui): 使用 UIWidgetMarker 消除硬编码组件依赖 - 新增 UIWidgetMarker 标记组件 - UIRectRenderSystem 改为检查标记而非硬编码4种组件类型 - 各 Widget 渲染系统自动添加标记组件 - 减少模块间耦合，提高可扩展性 * feat(ui): 实现 Canvas 隔离机制 - 新增 UICanvasComponent 定义 Canvas 渲染组 - UITransformComponent 添加 Canvas 相关字段：canvasEntityId, worldSortingLayer, pixelPerfect - UILayoutSystem 传播 Canvas 设置给子元素 - UIRenderUtils 使用 Canvas 继承的排序层 - 支持嵌套 Canvas 和不同渲染模式 * refactor(ui): 统一纹理管理工具函数 Phase 4: 纹理管理统一 新增: - UITextureUtils.ts: 统一的纹理描述符接口和验证函数 - UITextureDescriptor: 支持 GUID/textureId/path 多种纹理源 - isValidTextureGuid: GUID 验证 - getTextureKey: 获取用于合批的纹理键 - normalizeTextureDescriptor: 规范化各种输入格式 - utils/index.ts: 工具函数导出 修改: - UIGraphicRenderSystem: 使用新的纹理工具函数 - index.ts: 导出纹理工具类型和函数 * refactor(ui): 实现统一的脏标记机制 Phase 5: Dirty 标记机制 新增: - UIDirtyFlags.ts: 位标记枚举和追踪工具 - UIDirtyFlags: Visual/Layout/Transform/Material/Text 标记 - IDirtyTrackable: 脏追踪接口 - DirtyTracker: 辅助工具类 - 帧级别脏状态追踪 (markFrameDirty, isFrameDirty) 修改: - UIGraphicComponent: 实现 IDirtyTrackable - 属性 setter 自动设置脏标记 - 保留 setDirty/clearDirty 向后兼容 - UIImageComponent: 所有属性支持脏追踪 - textureGuid/imageType/fillAmount 等变化自动标记 - UIGraphicRenderSystem: 使用 clearDirtyFlags() 导出: - UIDirtyFlags, IDirtyTrackable, DirtyTracker - markFrameDirty, isFrameDirty, clearFrameDirty * refactor(ui): 移除过时的 dirty flag API 移除 UIGraphicComponent 中的兼容性 API: - 移除 _isDirty getter/setter - 移除 setDirty() 方法 - 移除 clearDirty() 方法 现在统一使用新的 dirty flag 系统: - isDirty() / hasDirtyFlag(flags) - markDirty(flags) / clearDirtyFlags() * fix(ui): 修复两个 TODO 功能 1. 滑块手柄命中测试 (UIInputSystem) - UISliderComponent 添加 getHandleBounds() 计算手柄边界 - UISliderComponent 添加 isPointInHandle() 精确命中测试 - UIInputSystem.handleSlider() 使用精确测试更新悬停状态 2. 径向填充渲染 (UIGraphicRenderSystem) - 实现 renderRadialFill() 方法 - 支持 radial90/radial180/radial360 三种模式 - 支持 fillOrigin (top/right/bottom/left) 和 fillClockwise - 使用多段矩形近似饼形填充效果 * feat(ui): 完善 UI 系统架构和九宫格渲染 * fix(ui): 修复文本渲染层级问题并清理调试代码 - 修复纹理就绪后调用 invalidateUIRenderCaches() 导致的无限循环 - 移除 UITextRenderSystem、UIButtonRenderSystem、UIRectRenderSystem 中的首帧调试输出 - 移除 UILayoutSystem 中的布局调试日志 - 清理所有 __UI_RENDER_DEBUG__ 条件日志 * refactor(ui): 优化渲染批处理和输入框组件 渲染系统: - 修复 RenderBatcher 保持渲染顺序 - 优化 Rust SpriteBatch 避免合并非连续精灵 - 增强 EngineRenderSystem 纹理就绪检测 输入框组件: - 增强 UIInputFieldComponent 功能 - 改进 UIInputSystem 输入处理 - 新增 TextMeasureService 文本测量服务 * fix(ui): 修复九宫格首帧渲染和InputField输入问题 - 修复九宫格首帧 size=0x0 问题： - Viewport.tsx: 预览模式读取图片尺寸存储到 importSettings - AssetDatabase: ISpriteSettings 添加 width/height 字段 - AssetMetadataService: getTextureSpriteInfo 使用元数据尺寸作为后备 - UIRectRenderSystem: 当 atlasEntry 不存在时使用 spriteInfo 尺寸 - WebBuildPipeline: 构建时包含 importSettings - AssetManager: 从 catalog 初始化时复制 importSettings - AssetTypes: IAssetCatalogEntry 添加 importSettings 字段 - 修复 InputField 无法输入问题： - UIRuntimeModule: manifest 添加 pluginExport: 'UIPlugin' - 确保预览模式正确加载 UI 插件并绑定 UIInputSystem - 添加调试日志用于排查纹理加载问题 * fix(sprite): 修复类型导出错误 MaterialPropertyOverride 和 MaterialOverrides 应从 @esengine/material-system 导出 * fix(ui-editor): 补充 AnchorPreset 拉伸预设的映射 添加 StretchTop, StretchMiddle, StretchBottom, StretchLeft, StretchCenter, StretchRight 的位置和锚点值映射
This commit is contained in:
YHH
GitHub
@@ -11,6 +11,7 @@ import { EntitySystem, Matcher, Entity, ECSSystem } from '@esengine/ecs-framewor
|
||||
import { UITransformComponent } from '../../components/UITransformComponent';
|
||||
import { UITextComponent } from '../../components/UITextComponent';
|
||||
import { getUIRenderCollector, registerCacheInvalidationCallback, unregisterCacheInvalidationCallback } from './UIRenderCollector';
|
||||
import { getUIRenderTransform } from './UIRenderUtils';
|
||||
|
||||
/**
|
||||
* Text texture cache entry
|
||||
@@ -47,7 +48,7 @@ interface TextTextureCache {
|
||||
* 2. 缓存纹理以避免每帧重新生成
|
||||
* 3. 向收集器提交纹理渲染原语
|
||||
*/
|
||||
@ECSSystem('UITextRender', { updateOrder: 120 })
|
||||
@ECSSystem('UITextRender', { updateOrder: 120, runInEditMode: true })
|
||||
export class UITextRenderSystem extends EntitySystem {
|
||||
private textCanvas: HTMLCanvasElement | null = null;
|
||||
private textCtx: CanvasRenderingContext2D | null = null;
|
||||
@@ -55,6 +56,10 @@ export class UITextRenderSystem extends EntitySystem {
|
||||
private nextTextureId = 90000;
|
||||
private onTextureCreated: ((id: number, dataUrl: string) => void) | null = null;
|
||||
private cacheInvalidationBound: () => void;
|
||||
/** 检查纹理是否已就绪的回调 | Callback to check if texture is ready */
|
||||
private textureReadyChecker: ((id: number) => boolean) | null = null;
|
||||
/** 待确认就绪的纹理 ID 集合 | Set of texture IDs pending ready confirmation */
|
||||
private pendingTextures: Set<number> = new Set();
|
||||
|
||||
constructor() {
|
||||
super(Matcher.empty().all(UITransformComponent, UITextComponent));
|
||||
@@ -90,9 +95,42 @@ export class UITextRenderSystem extends EntitySystem {
|
||||
this.onTextureCreated = callback;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set callback to check if texture is ready
|
||||
* 设置检查纹理是否就绪的回调
|
||||
*
|
||||
* This is used to verify that dynamically created textures
|
||||
* have finished loading before caching them.
|
||||
* 用于验证动态创建的纹理在缓存前已加载完成。
|
||||
*/
|
||||
setTextureReadyChecker(checker: (id: number) => boolean): void {
|
||||
this.textureReadyChecker = checker;
|
||||
}
|
||||
|
||||
protected process(entities: readonly Entity[]): void {
|
||||
const collector = getUIRenderCollector();
|
||||
|
||||
// 检查待确认的纹理是否已就绪
|
||||
// Check if pending textures are ready
|
||||
if (this.pendingTextures.size > 0 && this.textureReadyChecker) {
|
||||
const nowReady: number[] = [];
|
||||
for (const textureId of this.pendingTextures) {
|
||||
if (this.textureReadyChecker(textureId)) {
|
||||
nowReady.push(textureId);
|
||||
}
|
||||
}
|
||||
if (nowReady.length > 0) {
|
||||
for (const id of nowReady) {
|
||||
this.pendingTextures.delete(id);
|
||||
}
|
||||
// 纹理就绪后不需要做任何特殊处理！
|
||||
// Rust 端的纹理已经从 1x1 占位符更新为真实内容。
|
||||
// 注意：不要调用 invalidateUIRenderCaches()，那会清除缓存导致无限循环。
|
||||
// No special action needed - Rust texture is already updated.
|
||||
// Note: Do NOT call invalidateUIRenderCaches(), it would cause infinite loop.
|
||||
}
|
||||
}
|
||||
|
||||
for (const entity of entities) {
|
||||
const transform = entity.getComponent(UITransformComponent);
|
||||
const text = entity.getComponent(UITextComponent);
|
||||
@@ -101,49 +139,40 @@ export class UITextRenderSystem extends EntitySystem {
|
||||
// Null check - component may not be ready during deserialization or initialization
|
||||
if (!transform || !text) continue;
|
||||
|
||||
if (!transform.worldVisible || !text.text) continue;
|
||||
// 使用工具函数获取渲染变换数据（包含 layoutComputed 检查）
|
||||
// Use utility function to get render transform data (includes layoutComputed check)
|
||||
const rt = getUIRenderTransform(transform);
|
||||
if (!rt) continue;
|
||||
|
||||
const x = transform.worldX ?? transform.x;
|
||||
const y = transform.worldY ?? transform.y;
|
||||
// 使用世界缩放和旋转
|
||||
const scaleX = transform.worldScaleX ?? transform.scaleX;
|
||||
const scaleY = transform.worldScaleY ?? transform.scaleY;
|
||||
const rotation = transform.worldRotation ?? transform.rotation;
|
||||
const width = (transform.computedWidth ?? transform.width) * scaleX;
|
||||
const height = (transform.computedHeight ?? transform.height) * scaleY;
|
||||
const alpha = transform.worldAlpha ?? transform.alpha;
|
||||
// 使用排序层和世界层内顺序 | Use sorting layer and world order in layer
|
||||
const sortingLayer = transform.sortingLayer;
|
||||
const orderInLayer = transform.worldOrderInLayer;
|
||||
// 使用 transform 的 pivot 作为旋转/缩放中心
|
||||
const pivotX = transform.pivotX;
|
||||
const pivotY = transform.pivotY;
|
||||
// 渲染位置 = 左下角 + pivot 偏移
|
||||
const renderX = x + width * pivotX;
|
||||
const renderY = y + height * pivotY;
|
||||
// 跳过空文本 | Skip empty text
|
||||
if (!text.text) continue;
|
||||
|
||||
// Generate or retrieve cached texture
|
||||
// 生成或获取缓存的纹理
|
||||
const textureId = this.getOrCreateTextTexture(
|
||||
entity.id, text, Math.ceil(width), Math.ceil(height)
|
||||
entity.id, text, Math.ceil(rt.width), Math.ceil(rt.height)
|
||||
);
|
||||
|
||||
if (textureId === null) continue;
|
||||
|
||||
// Use pivot position with transform's pivot values
|
||||
// 文本渲染在背景之上 | Text renders above background
|
||||
const textOrderInLayer = rt.orderInLayer + 1;
|
||||
|
||||
// 使用 transform 的 pivot 值作为旋转中心
|
||||
// Use pivot position with transform's pivot values
|
||||
collector.addRect(
|
||||
renderX, renderY,
|
||||
width, height,
|
||||
rt.renderX, rt.renderY,
|
||||
rt.width, rt.height,
|
||||
0xFFFFFF, // White tint (color is baked into texture)
|
||||
alpha,
|
||||
sortingLayer,
|
||||
orderInLayer + 1, // Text renders above background
|
||||
rt.alpha,
|
||||
rt.sortingLayer,
|
||||
textOrderInLayer, // 使用调整后的 orderInLayer
|
||||
{
|
||||
rotation,
|
||||
pivotX,
|
||||
pivotY,
|
||||
textureId
|
||||
rotation: rt.rotation,
|
||||
pivotX: rt.pivotX,
|
||||
pivotY: rt.pivotY,
|
||||
textureId,
|
||||
entityId: entity.id
|
||||
}
|
||||
);
|
||||
}
|
||||
@@ -238,6 +267,15 @@ export class UITextRenderSystem extends EntitySystem {
|
||||
// 通知回调新纹理
|
||||
if (this.onTextureCreated) {
|
||||
this.onTextureCreated(textureId, dataUrl);
|
||||
// 如果有就绪检查器，将新纹理添加到待确认列表
|
||||
// If ready checker is available, add new texture to pending list
|
||||
if (this.textureReadyChecker) {
|
||||
this.pendingTextures.add(textureId);
|
||||
}
|
||||
} else {
|
||||
// 警告：回调未设置（只输出一次）
|
||||
// Warning: callback not set (output once only)
|
||||
console.warn('[UITextRenderSystem] onTextureCreated callback not set! Text will not render.');
|
||||
}
|
||||
|
||||
// Update cache
|
||||
@@ -316,6 +354,7 @@ export class UITextRenderSystem extends EntitySystem {
|
||||
*/
|
||||
clearTextCache(): void {
|
||||
this.textTextureCache.clear();
|
||||
this.pendingTextures.clear();
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -334,6 +373,8 @@ export class UITextRenderSystem extends EntitySystem {
|
||||
this.textCanvas = null;
|
||||
this.textCtx = null;
|
||||
this.textTextureCache.clear();
|
||||
this.pendingTextures.clear();
|
||||
this.onTextureCreated = null;
|
||||
this.textureReadyChecker = null;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user