Files
esengine/packages/ui/src/components/widgets/UIButtonComponent.ts
YHH 536c4c5593 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 的位置和锚点值映射
2025-12-19 15:33:36 +08:00

331 lines
8.9 KiB
TypeScript

import { Component, ECSComponent, Property, Serializable, Serialize } from '@esengine/ecs-framework';
/**
* 按钮状态样式
* Button state style configuration
*/
export interface UIButtonStyle {
backgroundColor: number;
backgroundAlpha: number;
textColor: number;
borderColor: number;
borderWidth: number;
/** 纹理资产 GUID | Texture asset GUID */
textureGuid?: string;
}
/**
* 按钮显示模式
* Button display mode
*/
export type UIButtonDisplayMode = 'color' | 'texture' | 'both';
/**
* UI 按钮组件
* UI Button Component - Button-specific state and callbacks
*/
@ECSComponent('UIButton')
@Serializable({ version: 1, typeId: 'UIButton' })
export class UIButtonComponent extends Component {
/**
* 按钮文本
* Button label text
*/
@Serialize()
@Property({ type: 'string', label: 'Label' })
public label: string = 'Button';
// ===== 显示模式 Display Mode =====
/**
* 显示模式:纯颜色、纯纹理、或两者结合
* Display mode: color only, texture only, or both
*/
@Serialize()
@Property({
type: 'enum',
label: 'Display Mode',
options: ['color', 'texture', 'both']
})
public displayMode: UIButtonDisplayMode = 'color';
// ===== 状态纹理 State Textures =====
/**
* 正常状态纹理 GUID
* Normal state texture GUID
*/
@Serialize()
@Property({ type: 'asset', label: 'Normal Texture', assetType: 'texture' })
public normalTextureGuid: string = '';
/**
* 悬停状态纹理 GUID
* Hover state texture GUID
*/
@Serialize()
@Property({ type: 'asset', label: 'Hover Texture', assetType: 'texture' })
public hoverTextureGuid: string = '';
/**
* 按下状态纹理 GUID
* Pressed state texture GUID
*/
@Serialize()
@Property({ type: 'asset', label: 'Pressed Texture', assetType: 'texture' })
public pressedTextureGuid: string = '';
/**
* 禁用状态纹理 GUID
* Disabled state texture GUID
*/
@Serialize()
@Property({ type: 'asset', label: 'Disabled Texture', assetType: 'texture' })
public disabledTextureGuid: string = '';
// ===== 状态样式 State Styles =====
/**
* 正常状态颜色
* Normal state background color
*/
@Serialize()
@Property({ type: 'color', label: 'Normal Color' })
public normalColor: number = 0x4A90D9;
/**
* 悬停状态颜色
* Hover state background color
*/
@Serialize()
@Property({ type: 'color', label: 'Hover Color' })
public hoverColor: number = 0x5BA0E9;
/**
* 按下状态颜色
* Pressed state background color
*/
@Serialize()
@Property({ type: 'color', label: 'Pressed Color' })
public pressedColor: number = 0x3A80C9;
/**
* 禁用状态颜色
* Disabled state background color
*/
@Serialize()
@Property({ type: 'color', label: 'Disabled Color' })
public disabledColor: number = 0x888888;
/**
* 聚焦状态颜色
* Focused state background color
*/
@Serialize()
@Property({ type: 'color', label: 'Focused Color' })
public focusedColor: number = 0x4A90D9;
/**
* 文本颜色
* Text color
*/
@Serialize()
@Property({ type: 'color', label: 'Text Color' })
public textColor: number = 0xFFFFFF;
/**
* 禁用时文本颜色
* Disabled text color
*/
@Serialize()
@Property({ type: 'color', label: 'Disabled Text Color' })
public disabledTextColor: number = 0xCCCCCC;
// ===== 动画 Animation =====
/**
* 颜色过渡时长(秒)
* Color transition duration in seconds
*/
@Serialize()
@Property({ type: 'number', label: 'Transition Duration', min: 0, step: 0.01 })
public transitionDuration: number = 0.1;
/**
* 当前显示颜色(动画插值用)
* Current display color (for animation)
*/
public currentColor: number = 0x4A90D9;
/**
* 目标颜色
* Target color
*/
public targetColor: number = 0x4A90D9;
/**
* 颜色是否已初始化(用于编辑器预览)
* Whether color has been initialized (for editor preview)
*/
public _colorInitialized: boolean = false;
// ===== 回调 Callbacks =====
/**
* 点击回调
* Click callback
*/
public onClick?: () => void;
/**
* 长按回调
* Long press callback
*/
public onLongPress?: () => void;
/**
* 长按阈值(毫秒)
* Long press threshold in milliseconds
*/
@Serialize()
@Property({ type: 'number', label: 'Long Press Threshold', min: 0 })
public longPressThreshold: number = 500;
/**
* 长按计时器
* Long press timer
*/
public pressTimer: number = 0;
/**
* 是否已触发长按
* Whether long press has been triggered
*/
public longPressTriggered: boolean = false;
// ===== 配置 Configuration =====
/**
* 是否禁用
* Whether button is disabled
*/
@Serialize()
@Property({ type: 'boolean', label: 'Disabled' })
public disabled: boolean = false;
/**
* 是否显示涟漪效果
* Whether to show ripple effect
*/
@Serialize()
@Property({ type: 'boolean', label: 'Show Ripple' })
public showRipple: boolean = false;
/**
* 涟漪颜色
* Ripple color
*/
@Serialize()
@Property({ type: 'color', label: 'Ripple Color' })
public rippleColor: number = 0xFFFFFF;
/**
* 涟漪透明度
* Ripple alpha
*/
@Serialize()
@Property({ type: 'number', label: 'Ripple Alpha', min: 0, max: 1, step: 0.01 })
public rippleAlpha: number = 0.3;
/**
* 获取当前应该显示的背景颜色
* Get the background color that should be displayed based on state
*/
public getStateColor(state: 'disabled' | 'pressed' | 'hovered' | 'focused' | 'normal'): number {
if (this.disabled) return this.disabledColor;
switch (state) {
case 'pressed': return this.pressedColor;
case 'hovered': return this.hoverColor;
case 'focused': return this.focusedColor;
default: return this.normalColor;
}
}
/**
* 获取当前应该显示的纹理 GUID
* Get the texture GUID that should be displayed based on state
*/
public getStateTextureGuid(state: 'disabled' | 'pressed' | 'hovered' | 'focused' | 'normal'): string {
if (this.disabled && this.disabledTextureGuid) return this.disabledTextureGuid;
switch (state) {
case 'pressed': return this.pressedTextureGuid || this.normalTextureGuid;
case 'hovered': return this.hoverTextureGuid || this.normalTextureGuid;
case 'focused': return this.normalTextureGuid;
default: return this.normalTextureGuid;
}
}
/**
* 是否使用纹理渲染
* Whether to use texture for rendering
*/
public useTexture(): boolean {
return (this.displayMode === 'texture' || this.displayMode === 'both') && !!this.normalTextureGuid;
}
/**
* 是否使用颜色渲染
* Whether to use color for rendering
*/
public useColor(): boolean {
return this.displayMode === 'color' || this.displayMode === 'both';
}
/**
* 获取当前应该显示的文本颜色
* Get the text color that should be displayed based on state
*/
public getTextColor(): number {
return this.disabled ? this.disabledTextColor : this.textColor;
}
/**
* 设置颜色主题
* Set color theme
*/
public setColors(normal: number, hover: number, pressed: number, disabled?: number): this {
this.normalColor = normal;
this.hoverColor = hover;
this.pressedColor = pressed;
if (disabled !== undefined) this.disabledColor = disabled;
this.currentColor = normal;
this.targetColor = normal;
return this;
}
/**
* 设置纹理 GUID
* Set texture GUIDs for different states
*/
public setTextureGuids(normalGuid: string, hoverGuid?: string, pressedGuid?: string, disabledGuid?: string): this {
this.normalTextureGuid = normalGuid;
if (hoverGuid) this.hoverTextureGuid = hoverGuid;
if (pressedGuid) this.pressedTextureGuid = pressedGuid;
if (disabledGuid) this.disabledTextureGuid = disabledGuid;
this.displayMode = 'texture';
return this;
}
/**
* 组件添加到实体时初始化颜色
* Initialize colors when component is added to entity
*/
public override onAddedToEntity(): void {
super.onAddedToEntity();
// 初始化 currentColor 和 targetColor 为 normalColor
// Initialize currentColor and targetColor to normalColor
this.currentColor = this.normalColor;
this.targetColor = this.normalColor;
}
}