DreamGUI
类参考

UDreamThrobber

UDreamThrobber

继承自 UDreamUIControl。

声明于 Public/Controls/DreamThrobber.h 中。

一个层级结构由代码而非资源构成的 throbber:N 个小块脉冲闪烁,只表达“正在发生某事”。

用 UMG 的两个控件合成一个,这是本库已经做过三次的抉择:进度条有 Bar 和 Radial,而不是两个类;滑块有一个 Direction,而不是两套蓝图预设;滚动框有一个 Orientation。小块的样式、周期、颜色和淡入淡出在 Throbber 和 CircularThrobber 之间完全相同;唯一的不同是小块的摆放位置,所以那是一个枚举,而不是一个类。调色板仍然提供两行——它们只差一次属性写入,就像两个滑块一样。

为什么它会 tick,而库中其他一切都不会

这里的其他每一个动画对象都是 TWEEN:它有起点、终点和持续时间,时钟由 tween 管理器掌管。throbber 没有这些——它会一直运行,直到有人把它移出屏幕 ——所以 tween 必须被永远重新启动,而每个小块一个循环 tween 就意味着 N 个对象,管理器每帧都要遍历它们,去做这个控件一遍就能完成的计算。于是它选择启用 NativeOnTick(对每个控件默认关闭,见 UDreamUserWidget::SetWantsTick)并自己写入不透明度。

这也让它在 tween 管理器不存在的地方依然正确:管理器是一个世界子系统,在无头测试和设计师预览中会返回 null,在那里基于 tween 的 throbber 只会静止不动。而这个 throbber 在任何调用它 tick 的地方都会动,在没有任何东西调用时则保持它的第一帧——这就是一个在设计师中看起来像 throbber 的 throbber,而不是一个空盒子。

没有 Play / Stop,出于 UMG 的理由:throbber 不是时间轴。把它移出屏幕即可停止。

属性

名称类型类别在细节面板中来自蓝图描述
StyleFDreamThrobberStyleThrobber是GetStyle / SetStyle此实例自身的外观。当 StyleSource 如此指示且确实存在项目表时,项目表优先;如果项目中没有任何表,那么这就是实际生效的外观。
ShapeEDreamThrobberShapeThrobber是GetShape / SetShape一排小块,或围绕圆圈排列的小块。对应 UMG 的 Throbber 和 CircularThrobber。
bAnimateboolThrobber是GetAnimate / SetAnimate关闭时小块保持在其原本所处的相位。控件也随之停止 tick。
bAnimateHorizontallyboolThrobber是GetAnimateHorizontally / SetAnimateHorizontally小块是否在该轴上同时脉冲——即 UMG 的 bAnimateHorizontally / bAnimateVertically,以及 Slate 对它们的规则:小块在被 tick 的轴上按驱动其不透明度的同一波形缩放,所以它变亮时膨胀,变暗时收缩。
bAnimateVerticallyboolThrobber是GetAnimateVertically / SetAnimateVertically
PieceRootNodeTObjectPtr<UDreamWidget>Throbber-只读小块挂载于其下,也是该控件唯一的内置节点。
PieceNodesTArray<TObjectPtr<UDreamWidget> >Throbber-只读按顺序排列的小块。公开是因为装饰器可能想为其中一个换肤。

函数

函数种类描述
bool GetAnimate()纯获取 Animate
bool GetAnimateHorizontally()纯获取 Animate Horizontally
bool GetAnimateOpacity()纯小块是否完全不透明度——即 UMG 的 bAnimateOpacity,从允许它们变得多暗淡读取:下限为 1 时每个小块保持实心,也就是该标志关闭。
bool GetAnimateVertically()纯获取 Animate Vertically
int32 GetNumberOfPieces()纯UMG 的两个 throbber 一次只提供一个的那四个数字。
float GetPeriod()纯获取 Period
float GetPhase()纯动画在一个周期内的进度,0 到 1。写进去;读出来。
float GetRadius()纯获取 Radius
EDreamThrobberShape GetShape()纯获取 Shape
FDreamThrobberStyle GetStyle()纯获取 Style
void SetAnimate(bool bInAnimate)可调用设置 Animate
void SetAnimateHorizontally(bool bInAnimateHorizontally)可调用将其关闭会立即重新摆放每个小块,因为一个在脉冲中途冻结的小块否则会保持上一次 tick 赋予它的宽度——一个会让它所关闭的对象处于随机状态的开关就是一个看起来坏掉的开关。
void SetAnimateOpacity(bool bInAnimateOpacity)可调用关闭会将下限固定为 1。开启会恢复样式所附带的下限,但仅当下限当前为 1 时——所以关闭再打开不是丢失手动调校值的方式,而一个已经在淡出的小块会恰好按照它之前的方式继续淡出。
void SetAnimateVertically(bool bInAnimateVertically)可调用设置 Animate Vertically
void SetNumberOfPieces(int32 InNumberOfPieces)可调用重建小块池,这就是这里的数量所代表的含义。
void SetPeriod(float InPeriod)可调用一个完整周期的秒数。也驱动线性形状,而在 UMG 中它只在环形上提供。
void SetRadius(float InRadius)可调用小块向外偏移多远。仅限圆形,与 UMG 一样;线性形状忽略它。
void SetShape(EDreamThrobberShape InShape)可调用重新摆放每个小块:两种形状将它们放在不同位置,除此之外没有其他差异。
void SetStyle(FDreamThrobberStyle InStyle)可调用此实例的整个外观,被替换并推送——对于 throbber 来说,如果数量发生变化,这意味着小块池会被重建。关于表的注意事项见 UDreamButton::SetStyle。

与 UMG 的比较

UMG 类中每一个面向蓝图的成员,以及它们去了哪里。adopt:同名,同义。map:在这里换了名字或换了类型。reject:故意缺失,附原因。

UMG成员状态此处备注
UCircularThrobberNumberOfPiecesmapFDreamThrobberStyle::NumberOfPieces为 UMG 的两个 throbber 提供一个控件和一个样式;Shape = Circular 就是本类。
UCircularThrobberPeriodmapFDreamThrobberStyle::Period一个完整周期的秒数,它也驱动线性形状——UMG 只在圆形上提供它。
UCircularThrobberRadiusmapFDreamThrobberStyle::Radius各片段从中心向外延伸的距离。和 UMG 一样,仅适用于圆形。
UCircularThrobberImagemapFDreamThrobberStyle::PieceBrush参见 Throbber 表:片段是程序化矩形,因此笔刷就是它的主体纹理。
UCircularThrobberSetNumberOfPiecesadoptSetNumberOfPieces用 UMG 的两个控件合成一个,所以这与 Throbber 表中列出的是同一个调用。
UCircularThrobberSetPeriodadoptSetPeriod也驱动线性形状,而 UMG 只在环形上提供它。
UCircularThrobberSetRadiusadoptSetRadius和 UMG 一样,仅适用于圆形;线性形状会忽略它。
UCircularThrobberbEnableRadiusrejectUMG 的 Radius 旁的内联勾选框,并且在那里是 Transient:它的存在是为了让未勾选的半径回退到 Slate 样式的半径。此处的半径始终是样式自身的数值,所以勾选框没有什么可选择的。
UThrobberNumberOfPiecesmapFDreamThrobberStyle::NumberOfPieces在样式中:项目的旋转指示器有多少个点是主题决定,而控件在每次推送时都会重建它的片段池。
UThrobberbAnimateHorizontallyadoptbAnimateHorizontally保留 Slate 的规则:片段在勾选的轴上按驱动其不透明度的同一波形进行缩放,因此它在变亮时膨胀。两者共用一个波形,而不是第二个时钟。默认关闭,这也是此 throbber 一直以来的绘制方式。
UThrobberbAnimateVerticallyadoptbAnimateVertically
UThrobberbAnimateOpacitymapFDreamThrobberStyle::MinOpacityUMG 用 bool,这里用 float,而且表达得更多:MinOpacity 为 1 相当于 UMG 的 bAnimateOpacity 关闭(每个片段保持不透明),任何小于 1 的值表示片段在周期底部最暗时的透明度。GetAnimateOpacity / SetAnimateOpacity 在此基础上表达 UMG 的 bool。
UThrobberImagemapFDreamThrobberStyle::PieceBrush用 FDreamUIFaceBrush 而不是 FSlateBrush——片段是程序化矩形,而笔刷就是它的主体纹理。为空时是普通的圆点。
UThrobberSetNumberOfPiecesadoptSetNumberOfPieces重建片段池,这就是此处的数量含义。编辑此实例的样式;关于项目样式表的注意事项见 UDreamBorder::SetPadding。
UThrobberSetAnimateHorizontallyadoptSetAnimateHorizontally关闭它会重新放置每个片段,因此冻结在脉冲中途的片段不会保留上一次 tick 赋予它的宽度。
UThrobberSetAnimateVerticallyadoptSetAnimateVertically
UThrobberSetAnimateOpacityadoptSetAnimateOpacity关闭会把下限固定为 1;开启仅在当前下限为 1 时恢复随附的下限,因此关闭再开启不会丢失手工调整过的值。
UThrobberSetStyleadoptSetStyleUThrobber 没有样式结构体;这是本系列的写法,也是唯一会重建片段池的调用。

本页目录