Navigation
API > API/Runtime > API/Runtime/Slate > API/Runtime/Slate/Framework > API/Runtime/Slate/Framework/Layout
References
| Module | Slate |
| Header | /Engine/Source/Runtime/Slate/Public/Framework/Layout/ScrollyZoomy.h |
| Include | #include "Framework/Layout/ScrollyZoomy.h" |
Syntax
class FScrollyZoomy
Remarks
Utility class that adds scrolling and zooming functionality to a widget.
Derived your widget class from IScrollableZoomable, then embed an instance of FScrollyZoomy as a widget member variable, and call this class's event handlers from your own widget's event handler callbacks.
Constructors
| Type | Name | Description | |
|---|---|---|---|
FScrollyZoomy
(
const bool InUseInertialScrolling |
Create and initialize a new instance. |
Functions
| Type | Name | Description | |
|---|---|---|---|
| UE::Slate::FDeprecateVector2DResult | Get the position of the software cursor (when NeedsSoftwareCursor is true). | ||
| bool | Whether the user is actively scrolling. | ||
| bool | Whether a software cursor should be rendered. | ||
| FCursorReply | Call this from your widget's OnCursorQuery function. | ||
| FReply | OnMouseButtonDown
(
const FPointerEvent& MouseEvent |
Should be called when a mouse button is pressed. | |
| FReply | OnMouseButtonUp
(
const TSharedRef< SWidget > MyWidget, |
Should be called when a mouse button is released. | |
| void | OnMouseLeave
(
const TSharedRef< SWidget > MyWidget, |
Should be called from your widget's OnMouseLeave override. | |
| FReply | OnMouseMove
(
const TSharedRef< SWidget > MyWidget, |
Should be called when a mouse move event occurs. | |
| FReply | OnMouseWheel
(
const FPointerEvent& MouseEvent, |
Should be called by your widget when the mouse wheel is used | |
| int32 | PaintSoftwareCursorIfNeeded
(
const FGeometry& AllottedGeometry, |
Call this from your widget's OnPaint to paint a software cursor, if needed | |
| void | Tick
(
const float DeltaTime, |
Should be called every frame to update simulation state. |