UDreamProgressBar
UDreamProgressBar
继承自 UDreamUIControl。
声明于 Public/Controls/DreamProgressBar.h。
一个层级结构是代码而非资源的进度条。
两个节点、无行为:一个轨道,它本身就是根节点——按钮的“面即根节点”论点,一个条就是一个矩形——以及其内部由控件驱动的填充。UUIProgressBar 存在,也能驱动同样的几何形状,但一项行为要靠拥有交互或逐帧工作(跑马灯)才能挣得自己的位置,而一个普通条两者都没有;让控件自己写填充,比把一个部件交给一个会隐藏其其他功能的组件要更小。
两种形状,一个控件。Bar 把百分比花在填充的 WIDTH 上;Radial 把它花在扫掠的 ANGLE 上,两个矩形就变成了环。这是一个枚举而不是两个类,理由和滑块只有一个 Direction 而不是两个蓝图预设一样:部件、属性和样式完全相同,只有绘制不同。Radial 借助填充矩形自带的 RadialFill 楔形——没有第二个视觉元素,没有遮罩,没有材质变体——而环本身就是把主体关掉之后的矩形边框,因为边框是这个图元唯一拥有的孔洞。
一个 Throbber 由此自然得出,不需要自己的类:一个固定 Percent 的 Radial 条,其 RadialStartAngle(或控件的旋转)由动画旋转,正是 UMG 自带的旋转指示器,而且它和项目中其他所有条一样从同一张样式表设定样式。
UMG 对齐是 UProgressBar 的核心:Percent 在 0..1 范围内,SetPercent/GetPercent,没有事件——进度由代码写入,所以没有人需要通知。
/Script/DreamGUIControls.DreamProgressBar LoadProgress {
Percent = 0.35
}
/Script/DreamGUIControls.DreamProgressBar Spinner {
Shape = Radial
Percent = 0.25
}Properties
| Name | Type | Category | In the details panel | From Blueprint | Description |
|---|---|---|---|---|---|
Style | FDreamProgressBarStyle | Progress Bar | yes | GetStyle / SetStyle | 此实例自己的外观。当 StyleSource 如此指示且项目中确实存在样式表时,项目样式表获胜;如果项目中没有任何样式表,那么这就是生效的外观——这就是为什么它保持可编辑,而不是被枚举门控:旧的编辑条件会把正在驱动控件的那些确切值变灰。 |
FillColorAndOpacity | FColor | Progress Bar | yes | GetFillColorAndOpacity / SetFillColorAndOpacity | 样式填充颜色之上的着色——UMG 的 FillColorAndOpacity,出于同样的原因,它也是 SProgressBar 填充图像之上的着色:样式说明一个已填充的条看起来什么样,而这个说明此刻这个条正在发生什么。白色表示不表达任何意见。 |
Percent | float | Progress Bar | yes | GetPercent / SetPercent | 轨道被填充的比例,0..1。作为一个属性,.dui 和绑定可以看到它;值按编写时的样子存储,只在它变成几何形状的地方被钳制,这是 UMG 的安排。 |
Shape | EDreamProgressShape | Progress Bar | yes | GetShape / SetShape | 百分比花在哪个轮廓上:条的宽度,或环的扫掠角度。是一个属性,不是子类——见类注释和 EDreamProgressShape。 |
FillType | EDreamProgressFillType | Progress Bar | yes | GetFillType / SetFillType | 填充从哪条边生长。仅限 Bar——环的方向是它的 RadialStartAngle,样式已经说明了这一点。 |
bIsMarquee | bool | Progress Bar | yes | GetIsMarquee / SetIsMarquee | 不确定态条——UMG 的 bIsMarquee:一段短填充永远扫掠轨道,用于长度无人知晓的工作。 |
MarqueeFraction | float | Progress Bar | yes | GetMarqueeFraction / SetMarqueeFraction | 扫掠填充覆盖轨道的比例,0..1。用分数而不是像素数,理由和这个控件上其他所有长度一样:条会被放置它的人拉伸。 |
MarqueeDuration | float | Progress Bar | yes | GetMarqueeDuration / SetMarqueeDuration | 一次扫掠从入口到出口的秒数。为零或更少时,扫掠停在起始边。 |
TrackNode | TObjectPtr<UDreamWidget> | Progress Bar | - | read only | |
FillNode | TObjectPtr<UDreamWidget> | Progress Bar | - | read only |
Functions
| Function | Kind | Description |
|---|---|---|
FColor GetFillColorAndOpacity() | pure | Get Fill Color and Opacity |
EDreamProgressFillType GetFillType() | pure | Get Fill Type |
bool GetIsMarquee() | pure | Get Is Marquee |
float GetMarqueeDuration() | pure | Get Marquee Duration |
float GetMarqueeFraction() | pure | Get Marquee Fraction |
float GetPercent() | pure | Get Percent |
EDreamProgressShape GetShape() | pure | Get Shape |
FDreamProgressBarStyle GetStyle() | pure | Get Style |
void SetFillColorAndOpacity(FColor InFillColorAndOpacity) | callable | Set Fill Color and Opacity |
void SetFillType(EDreamProgressFillType InFillType) | callable | 重新放置填充:方向决定它锚定在哪条边,以及它在哪个轴上花费。 |
void SetIsMarquee(bool bInIsMarquee) | callable | 打开它会启动扫掠以及它所需的逐帧 tick;关闭它会同时停止两者。 |
void SetMarqueeDuration(float InMarqueeDuration) | callable | 一次扫掠的秒数。为零或更少时,它停在起始边,也就是它重新放置到的地方。 |
void SetMarqueeFraction(float InMarqueeFraction) | callable | 扫掠填充的宽度。在属性处被钳制,并立即重新放置:宽度由扫掠读取,而一个因零时长而停住的扫掠,否则会一直保持旧宽度,直到别的东西移动它。 |
void SetPercent(float InPercent) | callable | Set Percent |
void SetShape(EDreamProgressShape InShape) | callable | 重新推入整个样式,因为形状决定了其他每个旋钮的含义。 |
void SetStyle(FDreamProgressBarStyle InStyle) | callable | 此实例的完整外观,被替换并推入。关于注意事项,见 UDreamButton::SetStyle。 |
Compared with UMG
UMG 类中每一个面向蓝图的成员,以及它们去了哪里。adopt:同名,同义。map:在这里换了名字或在另一个类型上。reject:有意缺席,附原因。
| UMG | 成员 | 状态 | 此处 | 说明 |
|---|---|---|---|---|
UProgressBar | WidgetStyle | map | Style | FDreamProgressBarStyle:轨道与填充的颜色和画笔、厚度,以及圆环的各项数值。 |
UProgressBar | Percent | adopt | Percent | |
UProgressBar | BarFillType | map | FillType | EDreamProgressFillType。UMG 的 TopToBottom / BottomToTop / LeftToRight / RightToLeft;它的两个 FillFromCenter 值在这里归圆环管(Shape = Radial),不属于条形。 |
UProgressBar | BarFillStyle | reject | 这里的填充是一个 RECT,其长度即是百分比,其上的画笔就绘制到这个矩形上——这也就是 UMG 的 Scale,既是默认值,也是这套几何能够表达的唯一一种。Mask 意味着让绘制保持整个条形的宽度,同时用一个窗口露出其中一部分,而这里没有任何东西可以承载它:面画笔没有 UV 偏移,所以要实现它就需要在裁剪节点下再加一个节点。在提出需求之前值得知道的是:对于样式自带的纯色填充而言,这两种模式在像素上完全一致,差异只在填充带有图片时才会出现。 | |
UProgressBar | bIsMarquee | adopt | bIsMarquee | 仅限条形,而且正是它让该控件开始逐帧更新。 |
UProgressBar | BorderPadding | map | FDreamProgressBarStyle::BorderPadding | 作用在填充上而非轨道上,这样条形保持它看起来的大小,填充则位于其内部。这四个边距数值的排序取决于 FillType 让它们各是什么:填充起始的那条边、结束的那条边,以及两条侧边(不对称的一对会让填充朝较大一侧推的方向偏移)。默认值为零。Radial 形状会忽略它——圆环的填充恰好落在其轨道上,向内收缩会变成第二个更小的圆环。 |
UProgressBar | FillColorAndOpacity | adopt | FillColorAndOpacity | FColor,并且是对样式填充颜色的叠加着色——在 Slate 中它也是这个含义。 |
UProgressBar | SetPercent | adopt | SetPercent | |
UProgressBar | SetIsMarquee | adopt | SetIsMarquee | |
UProgressBar | SetFillColorAndOpacity | adopt | SetFillColorAndOpacity | |
UProgressBar | SetStyle | adopt | SetStyle | 在 UProgressBar 上并不是 UFUNCTION(其 Setter 元数据给它起了名);这里加上它,是为了能在运行时替换外观。 |