类参考
UDreamUIControl
UDreamUIControl
继承自 UDreamUserWidget。
声明于 Public/Controls/DreamUIControl.h。
一种层级结构由代码而非资产构成的控件。
所有此类控件共有的并不是那棵树,而是生成一棵树的四个步骤。此类持有 NativeOnInitialized,并按顺序执行它们:
1. a tree -- RealizeTemplate(), or RealizeBuiltIn() when nothing replaces it
2. the parts -- BindParts(), by NAME, from the one list CollectParts declares
3. the behaviours -- WireParts(), on whichever nodes step 2 found
4. the look -- ApplyStyle(), and again whenever a knob changes将第 1 步与第 2 步分开,正是 Template 得以实现的原因。过去,控件通过构建器的 .Out() 来访问其部件,这种方式在构造时写入一个指针,因此只对由本代码写入的树有效;而之后按名称绑定则对任何具有正确名称的树都有效,因此这两条路径仅在步骤 1 上有所不同。这也是为什么 CollectParts 是一个列表,而不是在指针列表旁再放一个名称查找:两份相同名称的列表,正是模板会悄悄停止驱动代码树中依然命名的某个部件的方式。
将第 3 步单独拆分出来,正是让“控件始终携带自身行为”这一点对模板化控件依然成立的原因——这也是 DreamButton 被写出来的论据。模板的作者绘制一张脸;WireParts 才是把 UUIButton 放上去的东西。
风格契约是另一半:外观来自何处(默认来自项目表,按需来自此实例)、使用哪个命名变体,以及当某个旋钮变化时重新推送每个旋钮的义务,因为没有任何东西会像实例化一个变化后的模板那样从属性重新推导。最后这部分就是 UMG 的 SynchronizeProperties,也是整个家族都要付出的代价。
具体的样式结构体仍以带类型的形式留在派生类上;控件按如下方式解析它:
const FDreamToggleStyle& S = ResolveStyle(Style, &UDreamUIStyleSheet::ToggleStyle);当 StyleSource 指示如此时它读取项目表,否则读取此实例的 Style。
属性
| 名称 | 类型 | 类别 | 在细节面板中 | 来自蓝图 | 描述 |
|---|---|---|---|---|---|
StyleSource | EDreamUIStyleSource | 样式 | 是 | GetStyleSource / SetStyleSource | 参见 EDreamUIStyleSource:项目表是默认值,因为一处更改即全局生效正是关键所在。 |
StyleVariant | FName | 样式 | 是 | GetStyleVariant / SetStyleVariant | 项目表中的命名条目("Danger"、"Compact");留空表示该家族默认值。 |
Template | TSubclassOf<UDreamUserWidget> | 样式 | 是 | 只读 | 一个用来替代该控件自身构建的层级结构——即 WPF 的 ControlTemplate。 |
函数
| 函数 | 类型 | 描述 |
|---|---|---|
void ApplyStyle() | 可调用 | 将解析后的样式以及所有其他旋钮重新推送到各部件中。在树构建完成后会自动为你调用,编辑器中的属性变化时也会调用;在运行时就地编辑样式后,请自行调用它。 |
UDreamWidget* FindPart(FName InName) | 纯函数 | 该控件自身内容中具有该显示名称的控件,或 null。 |
EDreamUIStyleSource GetStyleSource() | 纯函数 | 获取样式来源 |
FName GetStyleVariant() | 纯函数 | 获取样式变体 |
TArray<FName> GetUnboundRequiredParts() | 可调用 | 该控件未能找到的所有必需部件。为空即为健康结果。 |
void OnControlReady() | 事件 | 控件已完全构建:其树已存在,其部件已绑定,其行为已接线,其样式已推送过一次。 |
void SetStyleSource(EDreamUIStyleSource InStyleSource) | 可调用 | 运行时外观的来源。会重新推送,因为一个改变了来源却未重新解析的样式会成为一个属性,其全部效果在别的东西碰巧推送之前都不可见——而这正是该家族各 setter 存在所要防止的失败。 |
void SetStyleVariant(FName InStyleVariant) | 可调用 | 项目表中的哪个命名条目。出于上述原因会重新推送。 |