Navigation
API > API/Runtime > API/Runtime/Slate
Handles overscroll management.
| Name | FOverscroll |
| Type | struct |
| Header File | /Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h |
| Include Path | #include "Framework/Layout/Overscroll.h" |
Syntax
struct FOverscroll
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FOverscroll() |
Framework/Layout/Overscroll.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Looseness | float | The amount to scale the logarithm by to make it more loose | Framework/Layout/Overscroll.h |
| OvershootBounceRate | float | The bounce back rate when the overscroll stops. | Framework/Layout/Overscroll.h |
| OvershootLooseMax | float | The "max" used to perform the interpolation snap back, and make it faster the further away it is. | Framework/Layout/Overscroll.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OverscrollAmount | float | How much we've over-scrolled above/below the beginning/end of the list, stored in log form | Framework/Layout/Overscroll.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetOverscroll
(
const FGeometry& AllottedGeometry |
How far the user scrolled above/below the beginning/end of the list. | Framework/Layout/Overscroll.h | |
void ResetOverscroll() |
Resets the overscroll amout. | Framework/Layout/Overscroll.h | |
float ScrollBy
(
const FGeometry& AllottedGeometry, |
Framework/Layout/Overscroll.h | ||
bool ShouldApplyOverscroll
(
const bool bIsAtStartOfList, |
Should ScrollDelta be applied to overscroll or to regular item scrolling. | Framework/Layout/Overscroll.h | |
void UpdateOverscroll
(
float InDeltaTime |
Ticks the overscroll manager so it can animate. | Framework/Layout/Overscroll.h |