Choose your operating system:
Windows
macOS
Linux
Module |
|
Header |
/Engine/Source/Runtime/Slate/Public/Widgets/SViewport.h |
Include |
#include "Widgets/SViewport.h" |
class SViewport : public SCompoundWidget
Name | Description | ||
---|---|---|---|
|
ViewportInterface |
Interface to the rendering and I/O implementation of the viewport. |
Name | Description | |
---|---|---|
|
SViewport() |
Default constructor. |
Name | Description | ||
---|---|---|---|
|
Construct ( |
Construct the widget. |
|
|
EnableStereoRendering ( |
Sets whether stereo rendering is allowed for this viewport. Advanced use only |
|
|
EActiveTimer... |
EnsureTick ( |
Empty active timer meant to ensure a tick/paint pass while this viewport is active |
|
const TShare... |
GetContent() |
|
|
TSharedPtr< ... |
GetCustomHitTestPath() |
|
|
GetIgnoreTextureAlpha() |
||
|
GetViewportInterface() |
Sets the interface to be used by this viewport for rendering and I/O |
|
|
IsStereoRenderingAllowed() |
||
|
OnViewportActivated ( |
A delegate called when the viewports top level window is activated |
|
|
OnViewportDeactivated ( |
A delegate called when the viewports top level window is deactivated |
|
|
OnWindowClosed ( |
A delegate called when the viewports top level window is being closed |
|
|
SetActive ( |
Sets whether this viewport is active. |
|
|
SetContent ( |
Sets the content for this widget |
|
|
SetCustomHitTestPath ( |
||
|
SetIgnoreTextureAlpha ( |
If true, the viewport's texture alpha is ignored when performing blending. |
|
|
SetRenderDirectlyToWindow ( |
Sets whether this viewport can render directly to the back buffer. Advanced use only |
|
|
SetViewportInterface ( |
Sets the interface to be used by this viewport for rendering and I/O |
|
|
ShouldRenderDirectly() |
Name | Description | ||
---|---|---|---|
|
ComputeDesiredSize ( |
Computes the ideal size necessary to display this widget. |
|
|
OnAnalogValueChanged ( |
Called when an analog value changes on a button that supports analog |
|
|
OnArrangeChildren ( |
Compute the Geometry of all the children and add populate the ArrangedChildren list with their values. |
|
|
OnCursorQuery ( |
The system asks each widget under the mouse to provide a cursor. This event is bubbled. |
|
|
OnFinishedPointerInput() |
All the pointer (mouse, touch, stylus, etc.) events from this frame have been routed. |
|
|
OnFocusLost ( |
Called when this widget loses focus. This event does not bubble. |
|
|
OnFocusReceived ( |
KEY INPUT Called when focus is given to this widget. This event does not bubble. |
|
|
OnKeyChar ( |
Called after a character is entered while this widget has keyboard focus |
|
|
OnKeyDown |
Called after a key is pressed when this widget has focus (this event bubbles if not handled) |
|
|
OnKeyUp |
Called after a key is released when this widget has focus |
|
|
OnMapCursor ( |
After OnCursorQuery has specified a cursor type the system asks each widget under the mouse to map that cursor to a widget. |
|
|
OnMotionDetected ( |
Called when motion is detected (controller or device) e.g. Someone tilts or shakes their controller. |
|
|
OnMouseButtonDoubleClick ( |
Called when a mouse button is double clicked. Override this in derived classes. |
|
|
OnMouseButtonDown ( |
MOUSE INPUT The system calls this method to notify the widget that a mouse button was pressed within it. |
|
|
OnMouseButtonUp ( |
The system calls this method to notify the widget that a mouse button was release within it. |
|
|
OnMouseEnter ( |
The system will use this event to notify a widget that the cursor has entered it. |
|
|
OnMouseLeave ( |
The system will use this event to notify a widget that the cursor has left it. |
|
|
OnMouseMove ( |
The system calls this method to notify the widget that a mouse moved within it. |
|
|
OnMouseWheel ( |
Called when the mouse wheel is spun. This event is bubbled. |
|
|
FNavigationR... |
OnNavigation ( |
Called when navigation is requested e.g. Left Joystick, Direction Pad, Arrow Keys can generate navigation events. |
|
OnPaint ( |
The widget should respond by populating the OutDrawElements array with FDrawElements that represent it and any of its children. |
|
|
FPopupMethod... |
OnQueryPopupMethod() |
Popups can manifest in a NEW OS WINDOW or via an OVERLAY in an existing window. |
|
OnQueryShowFocus ( |
Called to determine if we should render the focus brush. |
|
|
OnTouchEnded ( |
Called when a touchpad touch is ended (finger lifted) |
|
|
OnTouchFirstMove ( |
Called when a touchpad touch first moves after TouchStarted |
|
|
OnTouchForceChanged ( |
Called when a touchpad touch force changes |
|
|
OnTouchGesture ( |
TOUCH and GESTURES Called when the user performs a gesture on trackpad. This event is bubbled. |
|
|
OnTouchMoved ( |
Called when a touchpad touch is moved (finger moved) |
|
|
OnTouchStarted ( |
Called when a touchpad touch is started (finger down) |
|
|
SupportsKeyboardFocus() |
SViewport wants keyboard focus |
|
|
Tick ( |
Ticks this widget with Geometry. |
|
|
TranslateMouseCoordinateForCustomHitTestChild |
Name |
Description |
|
---|---|---|
|
FArguments |
Name | Description | ||
---|---|---|---|
|
SetWidgetToFocusOnActivate ( |
SetWidgetToFocusOnActivate is no longer needed, remove this call. |