FOverscroll

Handles overscroll management.

Windows
MacOS
Linux

References

Module

Slate

Header

/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h

Include

#include "Framework/Layout/Overscroll.h"

Syntax

struct FOverscroll

Remarks

Handles overscroll management.

Constructors

Name Description

Public function

FOverscroll()

Functions

Name Description

Public function Const

float

 

GetOverscroll

(
    const FGeometry& AllottedGeometry
)

How far the user scrolled above/below the beginning/end of the list.

Public function

void

 

ResetOverscroll()

Resets the overscroll amout.

Public function

float

 

ScrollBy

(
    const FGeometry& AllottedGeometry,
    float LocalDeltaScroll
)

Public function Const

bool

 

ShouldApplyOverscroll

(
    const bool bIsAtStartOfList,
    const bool bIsAtEndOfList,
    const float ScrollDelta
)

Should ScrollDelta be applied to overscroll or to regular item scrolling.

Public function

void

 

UpdateOverscroll

(
    float InDeltaTime
)

Ticks the overscroll manager so it can animate.

Constants

Name

Description

Looseness

The amount to scale the logarithm by to make it more loose

OvershootBounceRate

The bounce back rate when the overscroll stops.

OvershootLooseMax

The "max" used to perform the interpolation snap back, and make it faster the further away it is.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss