GFramework/GFramework.Godot/Text/GfRichTextLabel.cs
GeWuYou 22882f68c4 feat(text): 添加富文本效果系统和抖动效果实现
- 创建 RichTextEffectBase 基类提供统一的标签命名和环境参数读取逻辑
- 实现 RichTextJitterEffect 抖动效果类,支持振幅和速度参数调节
- 添加 DefaultRichTextEffectRegistry 默认效果注册表管理内置效果映射
- 创建 GfRichTextLabel 组合式富文本标签宿主,集成效果装配逻辑
- 定义 IRichTextEffectRegistry 接口实现效果注册表抽象
- 开发 RichTextEffectsController 装配控制器负责效果集合管理
- 实现 RichTextMarkup 工具类提供语义化富文本标签构建辅助方法
- 添加相关单元测试验证效果控制器和标记工具的功能正确性
2026-04-18 14:17:09 +08:00

78 lines
2.6 KiB
C#

namespace GFramework.Godot.Text;
/// <summary>
/// GFramework 提供的组合式富文本标签宿主。
/// 该类型只负责桥接 Godot 的 <see cref="RichTextLabel" /> 与框架的效果装配逻辑,不承载具体效果实现。
/// </summary>
[GlobalClass]
[Tool]
public partial class GfRichTextLabel : RichTextLabel, IRichTextEffectHost
{
private IRichTextEffectRegistry? _effectRegistry;
private RichTextEffectsController? _effectsController;
/// <summary>
/// 获取或设置当前标签使用的效果配置。
/// 为空时将回退到内置默认配置。
/// </summary>
[Export]
public RichTextProfile? Profile { get; set; }
/// <summary>
/// 获取或设置是否启用框架管理的富文本效果装配。
/// 关闭后只会停止框架效果安装,不会覆盖调用方手动维护的其他 BBCode 解析状态。
/// </summary>
[Export]
public bool EnableFrameworkEffects { get; set; } = true;
/// <summary>
/// 获取或设置是否允许字符级动态效果实际生效。
/// 关闭后仍然会安装对应标签,使富文本内容保持可解析。
/// </summary>
[Export]
public bool AnimatedEffectsEnabled { get; set; } = true;
/// <summary>
/// 获取当前使用的效果注册表。
/// </summary>
/// <exception cref="ArgumentNullException">
/// 当设置值为 <see langword="null" /> 时抛出。
/// </exception>
internal IRichTextEffectRegistry EffectRegistry
{
get => _effectRegistry ??= new DefaultRichTextEffectRegistry();
set => _effectRegistry = value ?? throw new ArgumentNullException(nameof(value));
}
/// <summary>
/// 节点就绪时初始化控制器并安装效果集合。
/// </summary>
public override void _Ready()
{
EnsureController().Initialize();
}
/// <summary>
/// 手动刷新框架效果集合。
/// 当调用方在运行时替换配置或切换动画开关时,可通过该方法同步宿主状态。
/// </summary>
public void RefreshFrameworkEffects()
{
EnsureController().RefreshEffects();
}
/// <summary>
/// 获取或创建控制器实例。
/// </summary>
/// <returns>组合式装配控制器。</returns>
private RichTextEffectsController EnsureController()
{
return _effectsController ??= new RichTextEffectsController(
this,
() => EffectRegistry,
() => Profile,
() => EnableFrameworkEffects,
() => AnimatedEffectsEnabled);
}
}