FOverscroll Struct Reference

#include <Overscroll.h>

Public Member Functions
SLATE_API	FOverscroll ()
SLATE_API float	ScrollBy (const FGeometry &AllottedGeometry, float LocalDeltaScroll)
SLATE_API float	GetOverscroll (const FGeometry &AllottedGeometry) const
SLATE_API void	UpdateOverscroll (float InDeltaTime)
SLATE_API bool	ShouldApplyOverscroll (const bool bIsAtStartOfList, const bool bIsAtEndOfList, const float ScrollDelta) const
SLATE_API void	ResetOverscroll ()

Static Public Attributes
static SLATE_API float	Looseness
static SLATE_API float	OvershootLooseMax
static SLATE_API float	OvershootBounceRate

Detailed Description

Handles overscroll management.

Constructor & Destructor Documentation

FOverscroll()

FOverscroll::FOverscroll

(

)

Member Function Documentation

GetOverscroll()

float FOverscroll::GetOverscroll

(

const FGeometry &

AllottedGeometry

)

const

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

ResetOverscroll()

void FOverscroll::ResetOverscroll

(

)

Resets the overscroll amout.

ScrollBy()

float FOverscroll::ScrollBy	(	const FGeometry &	AllottedGeometry,
		float	LocalDeltaScroll
	)

Returns

The Amount actually scrolled

ShouldApplyOverscroll()

bool FOverscroll::ShouldApplyOverscroll	(	const bool	bIsAtStartOfList,
		const bool	bIsAtEndOfList,
		const float	ScrollDelta
	)		const

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

Parameters

bIsAtStartOfList	Are we at the very beginning of the list (i.e. showing the first item at the top of the view)?
bIsAtEndOfList	Are we showing the last item on the screen completely?
ScrollDelta	How much the user is trying to scroll in Slate Units.

Returns

true if the user's scrolling should be applied toward overscroll.

UpdateOverscroll()

void FOverscroll::UpdateOverscroll

(

float

InDeltaTime

)

Ticks the overscroll manager so it can animate.

Member Data Documentation

Looseness

float FOverscroll::Looseness

static

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

OvershootBounceRate

float FOverscroll::OvershootBounceRate

static

The bounce back rate when the overscroll stops.

OvershootLooseMax

float FOverscroll::OvershootLooseMax

static

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

---

The documentation for this struct was generated from the following files:

• Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
• Engine/Source/Runtime/Slate/Private/Framework/Layout/Overscroll.cpp