类参考
UDreamLayoutContainerScrollBox
UDreamLayoutContainerScrollBox
继承自 UDreamLayoutContainerStackBox。
声明于 Public/Core/Components/DreamPanelLayouts.h。
UMG 滚动框
属性
| 名称 | 类型 | 类别 | 在细节面板中 | 来自蓝图 | 说明 |
|---|---|---|---|---|---|
ScrollSensitivity | float | ScrollBox | 是 | GetScrollSensitivity / SetScrollSensitivity | 每格滚轮滚动的本地单位数。 |
ConsumeMouseWheel | EDreamScrollBoxConsumeMouseWheel | ScrollBox | 是 | GetConsumeMouseWheel / SetConsumeMouseWheel | 滚轮是在此处被吞掉,还是在该框到达极限后交给外层滚动框。 |
WheelScrollMultiplier | float | ScrollBox | 是 | GetWheelScrollMultiplier / SetWheelScrollMultiplier | 对一格滚轮已能滚动的距离施加的纯倍率——即 UMG 的 WheelScrollMultiplier。ScrollSensitivity 是距离;此项对其缩放,因此"手感相同、速度翻倍"只是一个数字,而非需要重新调校的数值。 |
NavigationDestination | EDreamUIScrollDestination | ScrollBox | 是 | GetNavigationDestination / SetNavigationDestination | 由 ScrollWidgetIntoView 显示的控件最终落到的位置——即 UMG 的 NavigationDestination。 |
NavigationScrollPadding | float | ScrollBox | 是 | GetNavigationScrollPadding / SetNavigationScrollPadding | 在被显示的控件周围需要保持多大范围的窗口留白,以本地单位计——即 UMG 的 NavigationScrollPadding。可防止某一行紧贴边缘、而其相邻项在旁边被切掉一半,这是玩家判断列表还会继续的唯一线索。 |
ScrollWhenFocusChanges | EDreamUIScrollWhenFocusChanges | ScrollBox | 是 | GetScrollWhenFocusChanges / SetScrollWhenFocusChanges | 当用户焦点落入此框内时此框的行为——即 UMG 的 ScrollWhenFocusChanges。由 FDreamUINavigationScroll 读取,它是唯一因为焦点移动而显示控件的机制。 |
AnalogMouseWheelKey | FKey | ScrollBox | 是 | GetAnalogMouseWheelKey / SetAnalogMouseWheelKey | 用作此框鼠标滚轮的模拟按键——即 UMG 的 AnalogMouseWheelKey。无效(默认值)表示"输入预设已经路由到这里的任何按键",即右摇杆,因此与当前行为完全一致。 |
Scrollbar | TWeakObjectPtr<UDreamUIBehaviour> | ScrollBox | 是 | read / write | 一种与此框双向保持同步的滚动条行为——可以是 UUIScrollbar,或任何其他实现了 IDreamUIScrollbarInterface 的对象。将来自滚动条预制体(/DreamGUI/Prefabs/VerticalScrollbar 或 HorizontalScrollbar)的组件指定到层级中的任意位置——它不必是此框的子项。滚动条的哪一端表示零由滚动条自身决定:此框始终输出原始的 0..1 比例值,由滚动条自身的 DirectionType 决定映射关系。 |
ScrollbarVisibility | EDreamScrollBoxScrollbarVisibility | ScrollBox | 是 | GetScrollbarVisibility / SetScrollbarVisibility | 当内容已经能完全放下时,该滚动条是否隐藏自身。 |
bAnimateWheelScrolling | bool | ScrollBox | 是 | GetAnimateWheelScrolling / SetAnimateWheelScrolling | 在若干帧内缓动到滚轮的新位置,而不是直接跳过去。 |
ScrollAnimationMode | EDreamScrollAnimationMode | ScrollBox | 是 | GetScrollAnimationMode / SetScrollAnimationMode | 缓动滚动遵循的曲线。 |
ScrollAnimationInterpolationSpeed | float | ScrollBox | 是 | GetScrollAnimationInterpolationSpeed / SetScrollAnimationInterpolationSpeed | FInterpTo 速度,仅由 InterpToSpeed 使用。值越大到达越快;UMG 的默认值为 15。 |
ScrollAnimationEase | EDreamTweenEase | ScrollBox | 是 | GetScrollAnimationEase / SetScrollAnimationEase | 曲线形状,仅由 EaseCurve 使用。可以是 DreamTween 的任意缓动曲线,包括过冲类。 |
ScrollAnimationDuration | float | ScrollBox | 是 | GetScrollAnimationDuration / SetScrollAnimationDuration | 缓动滚动所需的秒数,仅由 EaseCurve 使用。 |
bEnableInertia | bool | ScrollBox | 是 | GetEnableInertia / SetEnableInertia | 在手指或鼠标松开后依靠动量继续滚动。 |
DecelerationRate | float | ScrollBox | 是 | GetDecelerationRate / SetDecelerationRate | 动量消亡的速度。0 表示永不减速;值越大停止越快。单位与默认值和旧版滚动视图相同,因此在旧版中调好的值可直接沿用。 |
bAllowOverscroll | bool | ScrollBox | 是 | GetAllowOverscroll / SetAllowOverscroll | 拖拽时允许内容越界拉伸,释放后回弹。 |
OverscrollLimit | float | ScrollBox | 是 | GetOverscrollLimit / SetOverscrollLimit | 内容可被拉过边界的距离,以本地单位计。拉力会朝向此值饱和而非停在此值,因此拖得越远阻力越大,内容永远不会被无限拖走——而旧版视图的平坦阻尼是允许这种情况的。 |
bBackPadScrolling | bool | ScrollBox | 是 | GetBackPadScrolling / SetBackPadScrolling | 内容之前整整一个视口的空白空间——即 UMG 的 BackPadScrolling:在零偏移处第一个子项位于一个视口之内,因此第一个项目可以一直滚动到远端边缘。是一个视口而非半个,这是 Slate 的算法(SScrollPanel 的 ScrollPadding 是面板自身的长度)。它会增加滚动范围,且不会占用 Fill 插槽所分到的空间。 |
bFrontPadScrolling | bool | ScrollBox | 是 | GetFrontPadScrolling / SetFrontPadScrolling | 内容之后整整一个视口的空白空间——即 UMG 的 FrontPadScrolling,这样最后一个项目可以到达近端边缘。 |
bAllowRightClickDragScrolling | bool | ScrollBox | 是 | GetAllowRightClickDragScrolling / SetAllowRightClickDragScrolling | 右键拖拽是否滚动此框——即 UMG 的 bAllowRightClickDragScrolling,与那里一样默认为开启。关闭时,右键留给任何想将其用于上下文菜单的对象。开启时,在没有可滚动内容时仍会拒绝右键拖拽,正如 SScrollBox 除非其滚动条 IsNeeded 否则也会拒绝一样。左键拖拽无论此项如何设置都会滚动:这是本库自身的手势,现有界面依赖它。 |
bEnableTouchScrolling | bool | ScrollBox | 是 | GetEnableTouchScrolling / SetEnableTouchScrolling | 手指在框上拖拽时是否滚动它——即 UMG 的 bEnableTouchScrolling,与那里一样默认为开启。 |
ScrollOffset | float | ScrollBox | 是 | - | 从起始位置滚动的距离。可编辑,以便设计者在预制体编辑器中(不存在指针输入)滚动内容,从而访问并编辑屏幕外的子项;所编辑的值也是运行时的初始滚动位置。由布局钳制在 [0, GetMaxScrollOffset()] 范围内。 |
函数
| 函数 | 类型 | 说明 |
|---|---|---|
bool CanScrollWidgetIntoView(UDreamWidget* InWidget) | callable | 当 InWidget 位于此框内,且滚动能让它更多地进入视野时返回 true。这是方向导航在确认当前不可见的候选项之前必须回答的问题。 |
void EndInertialScrolling() | callable | 丢弃甩动,保留当前位置和任何正在进行的橡皮筋效果——这是 UMG 对它的叫法。 |
bool GetAllowOverscroll() | pure | 获取允许过度滚动 |
bool GetAllowRightClickDragScrolling() | pure | 获取允许右键拖拽滚动 |
FKey GetAnalogMouseWheelKey() | pure | 获取模拟鼠标滚轮按键 |
float GetAnimatedScrollTarget() | pure | 缓动滚动的目标位置;无动画进行时为当前偏移量。 |
bool GetAnimateWheelScrolling() | pure | 获取滚轮滚动动画 |
bool GetBackPadScrolling() | pure | 获取后填充滚动 |
EDreamScrollBoxConsumeMouseWheel GetConsumeMouseWheel() | pure | 获取消费鼠标滚轮 |
float GetDecelerationRate() | pure | 获取减速率 |
bool GetEnableInertia() | pure | 获取启用惯性 |
bool GetEnableTouchScrolling() | pure | 获取启用触摸滚动 |
bool GetFrontPadScrolling() | pure | 获取前填充滚动 |
float GetMaxScrollOffset() | pure | 此框可以滚动的距离:内容范围减去视口范围,内容全部可见时为 0。 |
EDreamUIScrollDestination GetNavigationDestination() | pure | 获取导航目标位置 |
float GetNavigationScrollPadding() | pure | 获取导航滚动内边距 |
float GetOverscroll() | pure | 超过端点后的带符号位移,经过阻尼;在范围内时为零。布局会将其加到偏移量上。 |
float GetOverscrollLimit() | pure | 获取过度滚动限制 |
float GetOverscrollPercentage() | pure | 以窗口的百分比表示的同一位移——UMG 的 GetOverscrollPercentage。 |
float GetScrollAnimationDuration() | pure | 获取滚动动画时长 |
EDreamTweenEase GetScrollAnimationEase() | pure | 获取滚动动画缓动 |
float GetScrollAnimationInterpolationSpeed() | pure | 获取滚动动画插值速度 |
EDreamScrollAnimationMode GetScrollAnimationMode() | pure | 获取滚动动画模式 |
UDreamUIBehaviour* GetScrollbar() | pure | 此框所驱动的滚动条。接收原始指针,因为存储形式是弱引用。 |
EDreamScrollBoxScrollbarVisibility GetScrollbarVisibility() | pure | 获取滚动条可见性 |
float GetScrollOffset() | pure | 从起点开始的滚动距离,以本地单位计。始终位于 [0, GetMaxScrollOffset()] 范围内。 |
float GetScrollOffsetOfEnd() | pure | 内容末尾进入视野时的偏移量——UMG 对 GetMaxScrollOffset 的称呼。 |
float GetScrollSensitivity() | pure | 上述所有选项的普通读取器和写入器。 |
float GetScrollVelocity() | pure | 获取滚动速度 |
EDreamUIScrollWhenFocusChanges GetScrollWhenFocusChanges() | pure | 获取焦点变化时滚动 |
float GetViewFraction() | pure | 当前可见内容的比例,0..1。全部可见时为 1。 |
float GetViewOffsetFraction() | pure | 视图在可滚动范围中的位置比例,0..1。无法滚动时为 0。 |
float GetWheelScrollMultiplier() | pure | 获取滚轮滚动倍率 |
bool IsAnimatingScroll() | pure | 缓动滚动仍在进行时为 true。 |
bool IsScrollGestureMirrored() | pure | 当此框上的手势必须反向读取时为 true——右到左布局中的水平框,仅此而已。 |
bool IsScrolling() | pure | 惯性或回弹仍在移动内容时为 true。 |
bool IsScrollNeeded() | pure | 是否有任何内容可滚动:内容比视口长,以上次布局流程的测量为准——SScrollBar 的 IsNeeded。首次布局流程之前为 false,因为尚未进行任何测量。 |
bool ScrollBy(float Delta) | callable | 按带符号的增量滚动。偏移量实际发生变化时返回 true,已到达限制时返回 false。 |
void ScrollToEnd() | callable | 跳转到内容末尾。 |
void ScrollToStart() | callable | 跳转到内容开头。 |
bool ScrollWidgetIntoView(UDreamWidget* InWidget, bool bAnimateScroll, EDreamUIScrollDestination InDestination, float InPadding) | callable | 滚动最小距离以使 InWidget 进入视野。接受任何后代,而不仅是直接子级。当控件不在此框内或无需移动时返回 false。默认进行缓动,与 UMG 的做法一致——跳转会在长列表中丢失读者的位置。 |
void SetAllowOverscroll(bool Value) | callable | 设置允许过度滚动 |
void SetAllowRightClickDragScrolling(bool Value) | callable | 在拖拽开始时读取,这样已在进行中的手势会保留开始时得到的答案。 |
void SetAnalogMouseWheelKey(FKey Value) | callable | 设置模拟鼠标滚轮按键 |
void SetAnimateWheelScrolling(bool Value) | callable | 设置滚轮滚动动画 |
void SetBackPadScrolling(bool Value) | callable | 改变偏移量零处放置内容的位置并延长范围,因此框会被重新排列。 |
void SetConsumeMouseWheel(EDreamScrollBoxConsumeMouseWheel Value) | callable | 设置消费鼠标滚轮 |
void SetDecelerationRate(float Value) | callable | 设置减速率 |
void SetEnableInertia(bool Value) | callable | 设置启用惯性 |
void SetEnableTouchScrolling(bool Value) | callable | 设置启用触摸滚动 |
void SetFrontPadScrolling(bool Value) | callable | 设置前填充滚动 |
void SetNavigationDestination(EDreamUIScrollDestination Value) | callable | 设置导航目标位置 |
void SetNavigationScrollPadding(float Value) | callable | 设置导航滚动内边距 |
void SetOverscrollLimit(float Value) | callable | 设置过度滚动限制 |
void SetScrollAnimationDuration(float Value) | callable | 设置滚动动画时长 |
void SetScrollAnimationEase(EDreamTweenEase Value) | callable | 设置滚动动画缓动 |
void SetScrollAnimationInterpolationSpeed(float Value) | callable | 设置滚动动画插值速度 |
void SetScrollAnimationMode(EDreamScrollAnimationMode Value) | callable | 设置滚动动画模式 |
void SetScrollbar(UDreamUIBehaviour* Value) | callable | 链接滚动条行为;不实现 IDreamUIScrollbarInterface 的会被拒绝。 |
void SetScrollbarVisibility(EDreamScrollBoxScrollbarVisibility Value) | callable | 设置滚动条可见性 |
void SetScrollOffset(float Value) | callable | 设置滚动偏移 |
void SetScrollOffsetAnimated(float Value) | callable | 在接下来的帧中向 Value 缓动,而不是立即移动。取消任何惯性。 |
void SetScrollSensitivity(float Value) | callable | 设置滚动灵敏度 |
void SetScrollVelocity(float Value) | callable | 设置滚动速度 |
void SetScrollWhenFocusChanges(EDreamUIScrollWhenFocusChanges Value) | callable | 设置焦点变化时滚动 |
void SetWheelScrollMultiplier(float Value) | callable | 设置滚轮滚动倍率 |
void StopScrolling() | callable | 立即丢弃惯性和任何橡皮筋位移。 |
void TickScrollPhysics(float DeltaTime) | callable | 按 DeltaTime 推进惯性和回弹。有意不涉及输入管线:这样物理可以直接由测试步进,这是在没有任何真实指针的情况下验证所有这些的唯一方式。 |
事件
| 事件 | 签名 | 说明 |
|---|---|---|
OnUserScrolled | void DreamScrollBoxUserScrolledEvent__DelegateSignature(float CurrentOffset) |