UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FScrollHelper Class Reference

#include <SlateScrollHelper.h>

Public Member Functions

 FScrollHelper ()
 
const FVector2DGetPosition () const
 
void SetPosition (const FVector2D &InNewPosition)
 
FVector2D ToScrollerSpace (const FVector2D &InVec) const
 
FVector2D FromScrollerSpace (const FVector2D &InVec) const
 
FVector2D SizeToScrollerSpace (const FVector2D &InVec) const
 
FVector2D SizeFromScrollerSpace (const FVector2D &InVec) const
 

Detailed Description

Utility class to handle scrolling

Constructor & Destructor Documentation

◆ FScrollHelper()

FScrollHelper::FScrollHelper ( )
inline

Constructor

Member Function Documentation

◆ FromScrollerSpace()

FVector2D FScrollHelper::FromScrollerSpace ( const FVector2D InVec) const
inline

Converts a coordinate back from the scrollable area's space

Parameters
InVecPosition to convert from the scrollable area's space
Returns
Returns the position transformed back from the scrollable area's space

◆ GetPosition()

const FVector2D & FScrollHelper::GetPosition ( ) const
inline

Returns the current position

Returns
Current position

◆ SetPosition()

void FScrollHelper::SetPosition ( const FVector2D InNewPosition)
inline

Sets the scrolled position

◆ SizeFromScrollerSpace()

FVector2D FScrollHelper::SizeFromScrollerSpace ( const FVector2D InVec) const
inline

Converts a size back from the scrollable area's space

Parameters
InVecSize to convert from the scrollable area's space
Returns
Returns the size transformed back from the scrollable area's space

◆ SizeToScrollerSpace()

FVector2D FScrollHelper::SizeToScrollerSpace ( const FVector2D InVec) const
inline

Converts a size to the scrollable area's space

Parameters
InVecSize to convert to the scrollable area's space
Returns
Returns the size transformed to the scrollable area's space

◆ ToScrollerSpace()

FVector2D FScrollHelper::ToScrollerSpace ( const FVector2D InVec) const
inline

Converts a coordinate to the scrollable area's space

Parameters
InVecPosition to convert to the scrollable area's space
Returns
Returns the position transformed to the scrollable area's space

The documentation for this class was generated from the following file: