DreamGUI
类参考

UDreamSlider

UDreamSlider

继承自 UDreamUIControl。

声明于 Public/Controls/DreamSlider.h。

一个层级结构由代码而非资源决定的滑块。

两个预设蓝图所携带的同样五个节点——一条轨道、一个容纳填充的填充区域、一个容纳手柄的手柄区域——只差一点,而这一点正是关键:BP_HorizontalSlider 和 BP_VerticalSlider 是两个资源,因为资源无法根据属性分支,而这个类是一个控件,因为代码可以。方向会重新锚定各个部分;除此之外,两个预设没有任何分歧。

这些区域之所以存在,是因为 UUISlider 会把填充和手柄放置在它们父节点内部——FillArea 和 HandleArea 就是轨道告诉它“0”和“1”在哪里的方式。手柄区域按手柄自身的尺寸内缩,这样手柄就在轨道的两端之内滑动,而不会超出两端。

Properties

名称类型类别在细节面板中来自蓝图描述
StyleFDreamSliderStyleSlider是GetStyle / SetStyle此实例自身的外观。当 StyleSource 如此指示且项目中确实存在样式表时,项目样式表优先;如果项目中没有样式表,那么这就是实际生效的外观——这正是它保持可编辑、而不是被枚举限制的原因:旧的编辑条件恰好把驱动控件的那些值置灰了。
bLockedboolSlider是IsLocked / SetLocked显示其值并拒绝被移动——即 UMG 的 Locked,被推送到行为上。按下已锁定的滑块不会开始鼠标捕获,因此 OnMouseCaptureBegin 和 OnMouseCaptureEnd 保持静默,与 SSlider 的表现一致。
SliderBarColorFColorSlider是GetSliderBarColor / SetSliderBarColor叠加在手柄所沿行的条上的着色——即 UMG 的 SliderBarColor,它叠加在 SSlider 的条图像上,其原因与此处完全相同:样式决定滑块看起来什么样,而这个决定它此刻正在发生什么。白色表示没有意见。
SliderHandleColorFColorSlider是GetSliderHandleColor / SetSliderHandleColor同上,叠加在手柄的五种状态颜色上——即 UMG 的 SliderHandleColor。
bIndentHandleboolSlider是GetIndentHandle / SetIndentHandle手柄是否保持在轨道的两端之内——即 UMG 的 IndentHandle。
DirectionEUISliderDirectionTypeSlider是GetDirection / SetDirection它沿哪个方向运行。用这一个属性代替两个蓝图资源。
ValuefloatSlider是GetValue / SetValue作者设定的输入值;是行为输出的镜像。作为一个属性,以便 .dui 和绑定能够看到它。
MinValuefloatSlider是GetMinValue / SetMinValue
MaxValuefloatSlider是GetMaxValue / SetMaxValue
bWholeNumbersboolSlider是GetWholeNumbers / SetWholeNumbers仅限整数——行为一直有此设置,而控件从未推送它,因此作为整数选择器编写的滑块会给出 3.7215 这样的结果。滑块接受的每个值都会被舍入到最接近的整数——拖动、手柄步进、SetValue——因此作者设定的分数值会在下一次推送时被舍入,而不是被拒绝。
NavigationChangeIntervalfloatSlider是GetNavigationChangeInterval / SetNavigationChangeInterval一次手柄或键盘按键移动值的幅度,以范围的分数表示:一次按键等于 (MaxValue - MinValue) * 此值。同样是行为的设置,同样从未被推送过——因此项目中的每个滑块无论其 .dui 怎么写,都以库默认的 0.1 步进。
StepSizefloatSlider是GetStepSize / SetStepSize当 bMouseUsesStep 开启时,鼠标拖动移动值的量子——即 UMG 的 StepSize。
bMouseUsesStepboolSlider是GetMouseUsesStep / SetMouseUsesStep将鼠标拖动量化到 StepSize。关闭时,拖动是连续的。
bRequiresControllerLockboolSlider是GetRequiresControllerLock / SetRequiresControllerLock手柄必须先捕获此滑块,其方向键才能移动值——即 UMG 的 RequiresControllerLock,默认开启,其原因与那里相同:如果一排滑块中第一个就吞掉了所有左右输入,摇杆便无法穿过这排滑块。
TrackNodeTObjectPtr<UDreamWidget>Slider-只读
FillNodeTObjectPtr<UDreamWidget>Slider-只读
FillAreaNodeTObjectPtr<UDreamWidget>Slider-只读
HandleNodeTObjectPtr<UDreamWidget>Slider-只读
HandleAreaNodeTObjectPtr<UDreamWidget>Slider-只读
SliderBehaviourTObjectPtr<UUISlider>Slider-只读

Functions

函数种类描述
EUISliderDirectionType GetDirection()pureGet Direction
bool GetIndentHandle()pureGet Indent Handle
float GetMaxValue()pureGet Max Value
float GetMinValue()pureGet Min Value
bool GetMouseUsesStep()pureGet Mouse Uses Step
float GetNavigationChangeInterval()pureGet Navigation Change Interval
float GetNormalizedValue()pure值位于两端之间的位置,0 到 1——即 UMG 的 GetNormalizedValue。
bool GetRequiresControllerLock()pureGet Requires Controller Lock
FColor GetSliderBarColor()pureGet Slider Bar Color
FColor GetSliderHandleColor()pureGet Slider Handle Color
float GetStepSize()pureGet Step Size
FDreamSliderStyle GetStyle()pureGet Style
float GetValue()pureGet Value
bool GetWholeNumbers()pureGet Whole Numbers
bool IsControllerCaptured()pure手柄当前是否持有此滑块——直接从行为读取。
bool IsLocked()pureIs Locked
void SetDirection(EUISliderDirectionType InDirection)callable重新锚定各个部分:方向决定轨道、填充和手柄沿哪个轴运行。
void SetIndentHandle(bool bInIndentHandle)callable重新放置手柄区域,这是它唯一决定的事。
void SetLocked(bool bInLocked)callableSet Locked
void SetMaxValue(float InMaxValue)callableSet Max Value
void SetMinValue(float InMinValue)callable范围先于值,永远如此:值会根据范围被钳制,而不是反过来。
void SetMouseUsesStep(bool bInMouseUsesStep)callableSet Mouse Uses Step
void SetNavigationChangeInterval(float InInterval)callableSet Navigation Change Interval
void SetRequiresControllerLock(bool bInRequiresControllerLock)callableSet Requires Controller Lock
void SetSliderBarColor(FColor InSliderBarColor)callableSet Slider Bar Color
void SetSliderHandleColor(FColor InSliderHandleColor)callableSet Slider Handle Color
void SetStepSize(float InStepSize)callableSet Step Size
void SetStyle(FDreamSliderStyle InStyle)callable此实例的整个外观,被替换并推送。注意事项见 UDreamButton::SetStyle。
void SetValue(float InValue)callableSet Value
void SetWholeNumbers(bool bInWholeNumbers)callableSet Whole Numbers

Events

事件签名描述
OnMouseCaptureBeginvoid DreamSliderCaptureEvent__DelegateSignature()UMG 滑块所发出的四个捕获时刻,它们和数值变更一样从行为中重新广播。鼠标开始/结束对应按下与释放;控制器开始/结束对应锁的获取与归还。它们的用途正是 UMG 拥有它们的原因:将数值写入设置、播放声音或向服务器发起请求的消费者可以在玩家仍在拖动时暂缓操作,并在其松开的那一刻执行一次。
OnMouseCaptureEndvoid DreamSliderCaptureEvent__DelegateSignature()
OnControllerCaptureBeginvoid DreamSliderCaptureEvent__DelegateSignature()
OnControllerCaptureEndvoid DreamSliderCaptureEvent__DelegateSignature()
OnValueChangedvoid DreamSliderValueChangedEvent__DelegateSignature(float Value)从行为中重新广播,因此消费者绑定到控件本身,而不是它的某一部分。
OnValueChangedBPvoid DreamSliderValueChangedEvent__DelegateSignature(float Value)<-> 约定:双向绑定会针对这个确切的名称合成其反向路由,因此数值控件会与其发出的事件一同携带它。与之同时触发。

与 UMG 对比

UMG 类中每一个面向蓝图的成员,以及它们的去向。adopt:名称相同,含义相同。map:在此处以另一个名称或另一种类型存在。reject:有意缺席,并附原因。

UMG成员状态此处备注
USliderValueadoptValue
USliderMinValueadoptMinValue
USliderMaxValueadoptMaxValue
USliderWidgetStylemapStyleFDreamSliderStyle:轨道厚度与颜色、填充颜色、手柄尺寸及其五种状态颜色。
USliderOrientationmapDirectionEUISliderDirectionType 有四个值而非两个:水平和垂直各自带有其反转形式,而 UMG 用单独的 FlipForRightToLeft 来表达这一点。
USliderSliderBarColoradoptSliderBarColorFColor,以及对样式轨道颜色的一层 TINT——在 Slate 中也是如此(SSlider 将其乘在条形图像上)。作用于轨道,而非填充。
USliderSliderHandleColoradoptSliderHandleColor覆盖手柄全部五种状态颜色的色调,因此带有色调的手柄在悬停时仍保持该色调。
USliderIndentHandlemapbIndentHandle使用本代码库的布尔前缀命名。开启时(默认值,也是此滑块一直以来的绘制方式)手柄的行程为轨道减去手柄自身宽度;关闭时则给予其轨道全长,因此手柄的中心可达两端,而它的一半会悬出在外。无论哪种方式,它都是手柄 AREA 的内缩,因此报告的数值不受影响——相同的拖动跨越相同的数值。
USliderLockedmapbLocked推送至 UUISlider::bLocked,它控制 CalculateInputValue、鼠标捕获和导航方向:在锁定的滑块上按下不会开始捕获,因此 OnMouseCaptureBegin/End 保持静默,如同 SSlider 一样。仅影响输入:SetValue 继续有效,外观也不改变。
USliderMouseUsesStepmapbMouseUsesStep使用本代码库的布尔前缀命名。
USliderRequiresControllerLockmapbRequiresControllerLock使用本代码库的布尔前缀命名。
USliderStepSizeadoptStepSize
USliderIsFocusablemapUDreamWidget::bIsFocusable这里的每个控件都携带它。
USliderbPreventThrottlingrejectSlate 会在控件被拖动时限制整个应用程序的 tick,而此标志用于退出该限制。这里没有 Slate 控件,也没有节流——UI 是关卡中的渲染几何体。
USliderOnMouseCaptureBeginadoptOnMouseCaptureBegin
USliderOnMouseCaptureEndadoptOnMouseCaptureEnd
USliderOnControllerCaptureBeginadoptOnControllerCaptureBegin
USliderOnControllerCaptureEndadoptOnControllerCaptureEnd
USliderOnValueChangedadoptOnValueChanged
USliderGetValueadoptGetValue
USliderGetNormalizedValueadoptGetNormalizedValue零宽度范围返回零,而不是对其做除法。
USliderSetValueadoptSetValue
USliderSetMinValueadoptSetMinValue
USliderSetMaxValueadoptSetMaxValue
USliderSetIndentHandleadoptSetIndentHandle重新放置手柄区域,这是它唯一决定的事。
USliderSetLockedadoptSetLocked
USliderSetStepSizeadoptSetStepSize
USliderSetSliderBarColoradoptSetSliderBarColor
USliderSetSliderHandleColoradoptSetSliderHandleColor
USliderSetStyleadoptSetStyle它不是 USlider 上的 UFUNCTION(其 Setter 元数据为其命名);此处添加它以便在运行时替换外观。

本页目录