className
stringlengths
1
167
headerPath
stringlengths
14
166
description
stringlengths
0
1.62k
module
stringlengths
0
76
code
stringlengths
0
11.4k
variables
listlengths
0
395
FTabSpawnerEntry
/Engine/Source/Runtime/Slate/Public/Framework/Docking/TabManager.h
Slate
struct FTabSpawnerEntry : public [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem)
[]
FWorkspaceItem::AddGroup
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > AddGroup ( const [FText](API\Runtime\Core\Internationalization\FText) & InDisplayName, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const bool InSortChildren )
[]
FWorkspaceItem::AddGroup
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
[TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > AddGroup ( const [FText](API\Runtime\Core\Internationalization\FText) & InDisplayName, const [FText](API\Runtime\Core\Internationalization\FText) & InTooltipText, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const bool InSortChildren )
[]
FWorkspaceItem::AddItem
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
void AddItem ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > & ItemToAdd )
[]
FWorkspaceItem::AsSpawnerEntry
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
virtual [TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FTabSpawnerEntry](API\Runtime\Slate\Framework\Docking\FTabSpawnerEntry) > AsSpawnerEntry()
[]
FWorkspaceItem::ClearItems
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
void ClearItems()
[]
FWorkspaceItem::FWorkspaceItemSort::operator()
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
bool operator&40;&41; &40; const TSharedRef< FWorkspaceItem > A, const TSharedRef< FWorkspaceItem > B &41; const
[]
FWorkspaceItemSort
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
struct FWorkspaceItemSort
[]
FWorkspaceItem::GetChildItems
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
const [TArray](API\Runtime\Core\Containers\TArray)< [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > > & GetChildItems() const
[]
FWorkspaceItem::GetDisplayName
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
const [FText](API\Runtime\Core\Internationalization\FText) & GetDisplayName() const
[]
FWorkspaceItem::GetIcon
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & GetIcon() const
[]
FWorkspaceItem::GetParent
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
[TSharedPtr](API\Runtime\Core\Templates\TSharedPtr)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > GetParent() const
[]
FWorkspaceItem::GetTooltipText
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
const [FText](API\Runtime\Core\Internationalization\FText) & GetTooltipText() const
[]
FWorkspaceItem::HasChildrenIn
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
bool HasChildrenIn ( const [TArray](API\Runtime\Core\Containers\TArray)< [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [FTabSpawnerEntry](API\Runtime\Slate\Framework\Docking\FTabSpawnerEntry) > > & AllowedSpawners )
[]
FWorkspaceItem::NewGroup
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > NewGroup ( const [FText](API\Runtime\Core\Internationalization\FText) & DisplayName, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & Icon, const bool bSortChildren )
[]
FWorkspaceItem::RemoveItem
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
void RemoveItem ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > & ItemToRemove )
[]
FWorkspaceItem::SortChildren
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
void SortChildren()
[]
FWorkspaceItem::NewGroup
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
static [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [FWorkspaceItem](API\Runtime\Slate\Framework\Docking\FWorkspaceItem) > NewGroup ( const [FText](API\Runtime\Core\Internationalization\FText) & DisplayName, const [FText](API\Runtime\Core\Internationalization\FText) & TooltipText, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & Icon, const bool bSortChildren )
[]
FWorkspaceItem::FWorkspaceItem
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
FWorkspaceItem ( const [FText](API\Runtime\Core\Internationalization\FText) & InDisplayName, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const bool bInSortChildren )
[]
FWorkspaceItem::FWorkspaceItem
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
FWorkspaceItem ( const [FText](API\Runtime\Core\Internationalization\FText) & InDisplayName, const [FText](API\Runtime\Core\Internationalization\FText) & InTooltipText, const [FSlateIcon](API\Runtime\SlateCore\Textures\FSlateIcon) & InIcon, const bool bInSortChildren )
[]
FWorkspaceItem::~FWorkspaceItem
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FWorkspaceItem()
[]
FWorkspaceItem
/Engine/Source/Runtime/Slate/Public/Framework/Docking/WorkspaceItem.h
Slate
class FWorkspaceItem : public [TSharedFromThis< FWorkspaceItem >](API\Runtime\Core\Templates\TSharedFromThis)
[ { "type": "bool", "name": "bSortChildren", "description": "" }, { "type": "TArray<TShared...", "name": "ChildItems", "description": "" }, { "type": "TAttribute<FTe...", "name": "DisplayNameAttribute", "description": "" }, { "type": "FSlateIcon", "name": "Icon", "description": "" }, { "type": "TWeakPtr<FWork...", "name": "ParentItem", "description": "" }, { "type": "TAttribute<FTe...", "name": "TooltipTextAttribute", "description": "" } ]
STabDrawer::Close
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Begins an animation which closes the drawer
Slate
void Close()
[]
STabDrawer::ComputeDesiredSize
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Note thatComputeDesiredSize()is meant as an aide to the developer. It is NOT meant to be very robust in many cases. If your widget is simulating a bouncing ball, you should just return a reasonable size; e.g. 160x160. Let the programmer set up a reasonable rule of resizing the bouncy ball simulation. The desired size.
Slate
virtual FVector2D ComputeDesiredSize ( float LayoutScaleMultiplier ) const
[]
STabDrawer::Construct
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Slate
void Construct ( const [FArguments](API\Runtime\Slate\Framework\Docking\STabDrawer\FArguments) & InArgs, [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SDockTab](API\Runtime\Slate\Widgets\Docking\SDockTab) > InTab, [TWeakPtr](API\Runtime\Core\Templates\TWeakPtr)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > InTabButton, ETabDrawerOpenDirection InOpenDirection )
[]
STabDrawer::FArguments::Content
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Slate
NamedSlotProperty< FArguments > Content&40;&41;
[]
STabDrawer::FArguments::MaxDrawerSize
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The maximum size a drawer can be when opened. This unit is in window space
Slate
WidgetArgsType & MaxDrawerSize &40; float InArg &41;
[]
STabDrawer::FArguments::MinDrawerSize
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The minimum size a drawer can be when opened. This unit is in window space
Slate
WidgetArgsType & MinDrawerSize &40; float InArg &41;
[]
STabDrawer::FArguments::OnDrawerClosed
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Called when the drawer is completely closed (i.e will be called once the close animation completes
Slate
WidgetArgsType & OnDrawerClosed &40; const FOnDrawerClosed & InDelegate &41;
[]
STabDrawer::FArguments::OnDrawerFocusLost
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Called when the drawer loses focus
Slate
WidgetArgsType & OnDrawerFocusLost &40; const FOnDrawerFocusLost & InDelegate &41;
[]
STabDrawer::FArguments::OnTargetDrawerSizeChanged
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Called when the target drawer size is changed by the user
Slate
WidgetArgsType & OnTargetDrawerSizeChanged &40; const FOnDrawerTargetSizeChanged & InDelegate &41;
[]
STabDrawer::FArguments::operator[]
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Slate
FArguments & operator&91;&93; &40; const TSharedRef< SWidget > & InChild &41;
[]
STabDrawer::FArguments::ShadowOffset
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The side of the drop shadow surrounding the drawer
Slate
WidgetArgsType & ShadowOffset &40; FVector2D InArg &41;
[]
STabDrawer::FArguments::TargetDrawerSize
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The size that the drawer should be, clamped to the above min/max values. This unit is in window space
Slate
WidgetArgsType & TargetDrawerSize &40; float InArg &41;
[]
WidgetArgsType
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Slate
typedef FArguments WidgetArgsType
[]
STabDrawer::FArguments::FArguments
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Slate
FArguments&40;&41;
[]
FArguments
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Slate
struct FArguments : public [TSlateBaseNamedArgs< STabDrawer >](API\Runtime\SlateCore\Widgets\TSlateBaseNamedArgs)
[]
STabDrawer::IsClosing
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
true if the drawer is currently playing the close animation
Slate
bool IsClosing() const
[]
STabDrawer::GetTab
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
the tab whose contents is being shown in the drawer
Slate
const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SDockTab](API\Runtime\Slate\Widgets\Docking\SDockTab) > GetTab() const
[]
STabDrawer::IsOpen
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
true if the drawer is open
Slate
bool IsOpen() const
[]
STabDrawer::OnArrangeChildren
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. Each type of Layout panel should arrange children based on desired behavior.
Slate
virtual void OnArrangeChildren ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, [FArrangedChildren](API\Runtime\SlateCore\Layout\FArrangedChildren) & ArrangedChildren ) const
[]
STabDrawer::OnCursorQuery
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The system asks each widget under the mouse to provide a cursor. This event is bubbled.FCursorReply::Unhandled()if the event is not handled; returnFCursorReply::Cursor()otherwise.
Slate
virtual [FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) OnCursorQuery ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & CursorEvent ) const
[]
STabDrawer::OnMouseButtonDown
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
STabDrawer::OnMouseButtonUp
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The system calls this method to notify the widget that a mouse button was release within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
STabDrawer::OnMouseLeave
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The system will use this event to notify a widget that the cursor has left it. This event is uses a custom bubble strategy.
Slate
virtual void OnMouseLeave ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
STabDrawer::OnMouseMove
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The system calls this method to notify the widget that a mouse moved within it. This event is bubbled. Whether the event was handled along with possible requests for the system to take action.
Slate
virtual [FReply](API\Runtime\SlateCore\Input\FReply) OnMouseMove ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
STabDrawer::OnPaint
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. Called by the non-virtual OnPaint to enforce pre/post conditions during OnPaint. The maximum layer ID attained by this widget or any of its children.
Slate
virtual int32 OnPaint ( const [FPaintArgs](API\Runtime\SlateCore\Types\FPaintArgs) & Args, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, const [FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) & MyCullingRect, [FSlateWindowElementList](API\Runtime\SlateCore\Rendering\FSlateWindowElementList) & OutDrawElements, int32 LayerId, const [FWidgetStyle](API\Runtime\SlateCore\Styling\FWidgetStyle) & InWidgetStyle, bool bParentEnabled ) const
[]
STabDrawer::Open
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Opens the drawer
Slate
void Open ( bool bAnimateOpen )
[]
STabDrawer::SupportsKeyboardFocus
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
SWidgetinterface
Slate
virtual bool SupportsKeyboardFocus() const
[]
STabDrawer::SetCurrentSize
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Sets the current size of the drawer, ignoring any open/close animation
Slate
void SetCurrentSize ( float InSize )
[]
STabDrawer::~STabDrawer
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
Slate
~STabDrawer()
[]
STabDrawer
/Engine/Source/Runtime/Slate/Public/Framework/Docking/STabDrawer.h
A tab drawer is a widget that contains the contents of a widget when that widget is in a sidebar
Slate
class STabDrawer : public [SCompoundWidget](API\Runtime\SlateCore\Widgets\SCompoundWidget)
[]
FDelayedDrag::AttemptDragStart
/Engine/Source/Runtime/Slate/Public/Framework/DelayedDrag.h
Attempt to start a drag from the given mouse event.
Slate
bool AttemptDragStart ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
FDelayedDrag::ForceDragStart
/Engine/Source/Runtime/Slate/Public/Framework/DelayedDrag.h
Force the state of this helper to be 'dragging'
Slate
void ForceDragStart()
[]
FDelayedDrag::GetInitialPosition
/Engine/Source/Runtime/Slate/Public/Framework/DelayedDrag.h
Get the initial start position (before any drag has started)
Slate
const FVector2D & GetInitialPosition() const
[]
FDelayedDrag::IsDragging
/Engine/Source/Runtime/Slate/Public/Framework/DelayedDrag.h
Check whether we have initiated a drag or not
Slate
bool IsDragging() const
[]
FDelayedDrag::SetTriggerScaleFactor
/Engine/Source/Runtime/Slate/Public/Framework/DelayedDrag.h
Assign a new scale factor to apply to the drag trigger distance
Slate
void SetTriggerScaleFactor ( float InTriggerScaleFactor )
[]
FDelayedDrag::FDelayedDrag
/Engine/Source/Runtime/Slate/Public/Framework/DelayedDrag.h
Construct this drag helper with an initial posision, and a key (probably mouse button) required for dragging
Slate
FDelayedDrag ( FVector2D InInitialPosition, [FKey](API\Runtime\InputCore\FKey) InEffectiveKey )
[]
FDelayedDrag
/Engine/Source/Runtime/Slate/Public/Framework/DelayedDrag.h
Helper class to assist with delayed drag operations
Slate
class FDelayedDrag
[ { "type": "bool", "name": "bHasInitiatedDrag", "description": "True where the distance dragged is sufficient to have started a drag" }, { "type": "float", "name": "DistanceDragged", "description": "The amount we have dragged" }, { "type": "FKey", "name": "EffectiveKey", "description": "The key that must be pressed to initiate the drag" }, { "type": "FVector2D", "name": "InitialPosition", "description": "The initial position of the drag start" }, { "type": "float", "name": "TriggerDistance", "description": "The minimum distance that must be moved before the drag initiates." } ]
FMarqueeRect::GetLowerRight
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
the lower right of the selection
Slate
FVector2D GetLowerRight() const
[]
FMarqueeRect::GetSize
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
The size of the selection
Slate
FVector2D GetSize() const
[]
FMarqueeRect::GetUpperLeft
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
the upper left point of the selection
Slate
FVector2D GetUpperLeft() const
[]
FMarqueeRect::IsValid
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
true if this marquee selection is not too small to be considered real
Slate
bool IsValid() const
[]
FMarqueeRect::ToSlateRect
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
This marquee rectangle as a well-formed SlateRect
Slate
[FSlateRect](API\Runtime\SlateCore\Layout\FSlateRect) ToSlateRect() const
[]
FMarqueeRect::UpdateEndPoint
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
Update the location to which the user has dragged the marquee selection so far
Slate
void UpdateEndPoint ( FVector2D NewEndPoint )
[]
FMarqueeRect::FMarqueeRect
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
Make a default marquee selection
Slate
FMarqueeRect ( FVector2D InStartPoint )
[]
FMarqueeRect
/Engine/Source/Runtime/Slate/Public/Framework/MarqueeRect.h
A convenient representation of a marquee selection
Slate
struct FMarqueeRect
[ { "type": "FVector2D", "name": "EndPoint", "description": "Where the user has dragged to so far" }, { "type": "FVector2D", "name": "StartPoint", "description": "Where the user began the marquee selection" } ]
FInertialScrollManager::AddScrollSample
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
Adds a scroll velocity sample to help calculate a smooth velocity
Slate
void AddScrollSample ( float Delta, double CurrentTime )
[]
FrictionCoefficient
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
This is the percentage of velocity loss per second.
Slate
static float FrictionCoefficient = 2.0f;
[]
FInertialScrollManager::ClearScrollVelocity
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
Instantly end the inertial scroll
Slate
void ClearScrollVelocity()
[]
FInertialScrollManager::GetScrollVelocity
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
Gets the calculated velocity of the scroll.
Slate
float GetScrollVelocity() const
[]
FInertialScrollManager::UpdateScrollVelocity
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
Updates the current scroll velocity. Call every frame.
Slate
void UpdateScrollVelocity ( const float InDeltaTime )
[]
FInertialScrollManager
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
A helper class to calculate inertial scrolling. This class combines a percentage of velocity lost per second coupled with a static amount of velocity lost per second in order to achieve a quick decay when the velocity grows small enough, and the percentage of friction lost prevents large velocities from scrolling forever.
Slate
class FInertialScrollManager
[]
FInertialScrollManager::FInertialScrollManager
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
Constructor
Slate
FInertialScrollManager ( double SampleTimeout )
[]
FOverscroll::GetOverscroll
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
How far the user scrolled above/below the beginning/end of the list.
Slate
float GetOverscroll ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry ) const
[]
Looseness
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
The amount to scale the logarithm by to make it more loose
Slate
static float Looseness;
[]
OvershootBounceRate
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
The bounce back rate when the overscroll stops.
Slate
static float OvershootBounceRate;
[]
OvershootLooseMax
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
The "max" used to perform the interpolation snap back, and make it faster the further away it is.
Slate
static float OvershootLooseMax;
[]
FOverscroll::ResetOverscroll
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
Resets the overscroll amout.
Slate
void ResetOverscroll()
[]
StaticVelocityDrag
/Engine/Source/Runtime/Slate/Public/Framework/Layout/InertialScrollManager.h
This is a constant amount of velocity lost per second.
Slate
static float StaticVelocityDrag = 100;
[]
FOverscroll::ScrollBy
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
The Amount actually scrolled
Slate
float ScrollBy ( const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & AllottedGeometry, float LocalDeltaScroll )
[]
FOverscroll::ShouldApplyOverscroll
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
Should ScrollDelta be applied to overscroll or to regular item scrolling. true if the user's scrolling should be applied toward overscroll.
Slate
bool ShouldApplyOverscroll ( const bool bIsAtStartOfList, const bool bIsAtEndOfList, const float ScrollDelta ) const
[]
FOverscroll::UpdateOverscroll
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
Ticks the overscroll manager so it can animate.
Slate
void UpdateOverscroll ( float InDeltaTime )
[]
FOverscroll::FOverscroll
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
Slate
FOverscroll()
[]
FOverscroll
/Engine/Source/Runtime/Slate/Public/Framework/Layout/Overscroll.h
Handles overscroll management.
Slate
struct FOverscroll
[]
FScrollHelper::FromScrollerSpace
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Converts a coordinate back from the scrollable area's space Returns the position transformed back from the scrollable area's space
Slate
FVector2D FromScrollerSpace ( const FVector2D & InVec ) const
[]
FScrollHelper::GetPosition
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Returns the current position Current position
Slate
const FVector2D & GetPosition() const
[]
FScrollHelper::SetPosition
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Sets the scrolled position
Slate
void SetPosition ( const FVector2D & InNewPosition )
[]
FScrollHelper::SizeFromScrollerSpace
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Converts a size back from the scrollable area's space Returns the size transformed back from the scrollable area's space
Slate
FVector2D SizeFromScrollerSpace ( const FVector2D & InVec ) const
[]
FScrollHelper::SizeToScrollerSpace
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Converts a size to the scrollable area's space Returns the size transformed to the scrollable area's space
Slate
FVector2D SizeToScrollerSpace ( const FVector2D & InVec ) const
[]
FScrollHelper::ToScrollerSpace
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Converts a coordinate to the scrollable area's space Returns the position transformed to the scrollable area's space
Slate
FVector2D ToScrollerSpace ( const FVector2D & InVec ) const
[]
FScrollHelper::FScrollHelper
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Constructor
Slate
FScrollHelper()
[]
FScrollHelper
/Engine/Source/Runtime/Slate/Public/Framework/Layout/SlateScrollHelper.h
Utility class to handle scrolling
Slate
class FScrollHelper
[]
FScrollyZoomy::GetSoftwareCursorPosition
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
NeedsSoftwareCursor
Slate
[UE::Slate::FDeprecateVector2DResult](API\Runtime\SlateCore\Types\FDeprecateVector2DResult) GetSoftwareCursorPosition() const
[]
FScrollyZoomy::IsRightClickScrolling
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Whether the user is actively scrolling. true if the user is scrolling, false otherwise.
Slate
bool IsRightClickScrolling() const
[]
FScrollyZoomy::NeedsSoftwareCursor
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
GetSoftwareCursorPosition
Slate
bool NeedsSoftwareCursor() const
[]
FScrollyZoomy::OnCursorQuery
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Call this from your widget's OnCursorQuery function. The cursor reply to pass back.
Slate
[FCursorReply](API\Runtime\SlateCore\Input\FCursorReply) OnCursorQuery() const
[]
FScrollyZoomy::OnMouseButtonDown
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Should be called when a mouse button is pressed. IfFReply::Handledis returned, that should be passed as the result of the calling function.
Slate
[FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonDown ( const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
FScrollyZoomy::OnMouseButtonUp
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Should be called when a mouse button is released. IfFReply::Handledis returned, that should be passed as the result of the calling function.
Slate
[FReply](API\Runtime\SlateCore\Input\FReply) OnMouseButtonUp ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MyWidget, const [FGeometry](API\Runtime\SlateCore\Layout\FGeometry) & MyGeometry, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]
FScrollyZoomy::OnMouseLeave
/Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h
Should be called from your widget's OnMouseLeave override.
Slate
void OnMouseLeave ( const [TSharedRef](API\Runtime\Core\Templates\TSharedRef)< [SWidget](API\Runtime\SlateCore\Widgets\SWidget) > MyWidget, const [FPointerEvent](API\Runtime\SlateCore\Input\FPointerEvent) & MouseEvent )
[]