DreamGUI
类参考

UDreamLayoutContainerScrollBox

UDreamLayoutContainerScrollBox

继承自 UDreamLayoutContainerStackBox。

声明于 Public/Core/Components/DreamPanelLayouts.h。

UMG 滚动框

属性

名称类型类别在细节面板中来自蓝图说明
ScrollSensitivityfloatScrollBox是GetScrollSensitivity / SetScrollSensitivity每格滚轮滚动的本地单位数。
ConsumeMouseWheelEDreamScrollBoxConsumeMouseWheelScrollBox是GetConsumeMouseWheel / SetConsumeMouseWheel滚轮是在此处被吞掉,还是在该框到达极限后交给外层滚动框。
WheelScrollMultiplierfloatScrollBox是GetWheelScrollMultiplier / SetWheelScrollMultiplier对一格滚轮已能滚动的距离施加的纯倍率——即 UMG 的 WheelScrollMultiplier。ScrollSensitivity 是距离;此项对其缩放,因此"手感相同、速度翻倍"只是一个数字,而非需要重新调校的数值。
NavigationDestinationEDreamUIScrollDestinationScrollBox是GetNavigationDestination / SetNavigationDestination由 ScrollWidgetIntoView 显示的控件最终落到的位置——即 UMG 的 NavigationDestination。
NavigationScrollPaddingfloatScrollBox是GetNavigationScrollPadding / SetNavigationScrollPadding在被显示的控件周围需要保持多大范围的窗口留白,以本地单位计——即 UMG 的 NavigationScrollPadding。可防止某一行紧贴边缘、而其相邻项在旁边被切掉一半,这是玩家判断列表还会继续的唯一线索。
ScrollWhenFocusChangesEDreamUIScrollWhenFocusChangesScrollBox是GetScrollWhenFocusChanges / SetScrollWhenFocusChanges当用户焦点落入此框内时此框的行为——即 UMG 的 ScrollWhenFocusChanges。由 FDreamUINavigationScroll 读取,它是唯一因为焦点移动而显示控件的机制。
AnalogMouseWheelKeyFKeyScrollBox是GetAnalogMouseWheelKey / SetAnalogMouseWheelKey用作此框鼠标滚轮的模拟按键——即 UMG 的 AnalogMouseWheelKey。无效(默认值)表示"输入预设已经路由到这里的任何按键",即右摇杆,因此与当前行为完全一致。
ScrollbarTWeakObjectPtr<UDreamUIBehaviour>ScrollBox是read / write一种与此框双向保持同步的滚动条行为——可以是 UUIScrollbar,或任何其他实现了 IDreamUIScrollbarInterface 的对象。将来自滚动条预制体(/DreamGUI/Prefabs/VerticalScrollbar 或 HorizontalScrollbar)的组件指定到层级中的任意位置——它不必是此框的子项。滚动条的哪一端表示零由滚动条自身决定:此框始终输出原始的 0..1 比例值,由滚动条自身的 DirectionType 决定映射关系。
ScrollbarVisibilityEDreamScrollBoxScrollbarVisibilityScrollBox是GetScrollbarVisibility / SetScrollbarVisibility当内容已经能完全放下时,该滚动条是否隐藏自身。
bAnimateWheelScrollingboolScrollBox是GetAnimateWheelScrolling / SetAnimateWheelScrolling在若干帧内缓动到滚轮的新位置,而不是直接跳过去。
ScrollAnimationModeEDreamScrollAnimationModeScrollBox是GetScrollAnimationMode / SetScrollAnimationMode缓动滚动遵循的曲线。
ScrollAnimationInterpolationSpeedfloatScrollBox是GetScrollAnimationInterpolationSpeed / SetScrollAnimationInterpolationSpeedFInterpTo 速度,仅由 InterpToSpeed 使用。值越大到达越快;UMG 的默认值为 15。
ScrollAnimationEaseEDreamTweenEaseScrollBox是GetScrollAnimationEase / SetScrollAnimationEase曲线形状,仅由 EaseCurve 使用。可以是 DreamTween 的任意缓动曲线,包括过冲类。
ScrollAnimationDurationfloatScrollBox是GetScrollAnimationDuration / SetScrollAnimationDuration缓动滚动所需的秒数,仅由 EaseCurve 使用。
bEnableInertiaboolScrollBox是GetEnableInertia / SetEnableInertia在手指或鼠标松开后依靠动量继续滚动。
DecelerationRatefloatScrollBox是GetDecelerationRate / SetDecelerationRate动量消亡的速度。0 表示永不减速;值越大停止越快。单位与默认值和旧版滚动视图相同,因此在旧版中调好的值可直接沿用。
bAllowOverscrollboolScrollBox是GetAllowOverscroll / SetAllowOverscroll拖拽时允许内容越界拉伸,释放后回弹。
OverscrollLimitfloatScrollBox是GetOverscrollLimit / SetOverscrollLimit内容可被拉过边界的距离,以本地单位计。拉力会朝向此值饱和而非停在此值,因此拖得越远阻力越大,内容永远不会被无限拖走——而旧版视图的平坦阻尼是允许这种情况的。
bBackPadScrollingboolScrollBox是GetBackPadScrolling / SetBackPadScrolling内容之前整整一个视口的空白空间——即 UMG 的 BackPadScrolling:在零偏移处第一个子项位于一个视口之内,因此第一个项目可以一直滚动到远端边缘。是一个视口而非半个,这是 Slate 的算法(SScrollPanel 的 ScrollPadding 是面板自身的长度)。它会增加滚动范围,且不会占用 Fill 插槽所分到的空间。
bFrontPadScrollingboolScrollBox是GetFrontPadScrolling / SetFrontPadScrolling内容之后整整一个视口的空白空间——即 UMG 的 FrontPadScrolling,这样最后一个项目可以到达近端边缘。
bAllowRightClickDragScrollingboolScrollBox是GetAllowRightClickDragScrolling / SetAllowRightClickDragScrolling右键拖拽是否滚动此框——即 UMG 的 bAllowRightClickDragScrolling,与那里一样默认为开启。关闭时,右键留给任何想将其用于上下文菜单的对象。开启时,在没有可滚动内容时仍会拒绝右键拖拽,正如 SScrollBox 除非其滚动条 IsNeeded 否则也会拒绝一样。左键拖拽无论此项如何设置都会滚动:这是本库自身的手势,现有界面依赖它。
bEnableTouchScrollingboolScrollBox是GetEnableTouchScrolling / SetEnableTouchScrolling手指在框上拖拽时是否滚动它——即 UMG 的 bEnableTouchScrolling,与那里一样默认为开启。
ScrollOffsetfloatScrollBox是-从起始位置滚动的距离。可编辑,以便设计者在预制体编辑器中(不存在指针输入)滚动内容,从而访问并编辑屏幕外的子项;所编辑的值也是运行时的初始滚动位置。由布局钳制在 [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 推进惯性和回弹。有意不涉及输入管线:这样物理可以直接由测试步进,这是在没有任何真实指针的情况下验证所有这些的唯一方式。

事件

事件签名说明
OnUserScrolledvoid DreamScrollBoxUserScrolledEvent__DelegateSignature(float CurrentOffset)

本页目录