Navigation
API > API/Runtime > API/Runtime/Slate
A virtual joystsick
| Name | SVirtualJoystick |
| Type | class |
| Header File | /Engine/Source/Runtime/Slate/Public/Widgets/Input/SVirtualJoystick.h |
| Include Path | #include "Widgets/Input/SVirtualJoystick.h" |
Syntax
class SVirtualJoystick : public SLeafWidget
Inheritance Hierarchy
- FSharedFromThisBase → TSharedFromThis → SWidget → SLeafWidget → SVirtualJoystick
- FSlateControlledConstruction → SWidget → SLeafWidget → SVirtualJoystick
Structs
| Name | Remarks |
|---|---|
| FArguments | |
| FControlData | The settings and current state of each zone we render |
| FControlInfo | The settings of each zone we render |
Enums
Protected
| Name | Remarks |
|---|---|
| EVirtualJoystickState |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TControlArray | TArray< T, TInlineAllocator< 2 > > | TArray specialization for controls. | Widgets/Input/SVirtualJoystick.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddControl
(
const FControlInfo& Control |
Widgets/Input/SVirtualJoystick.h | ||
void ClearControls() |
Widgets/Input/SVirtualJoystick.h | ||
void Construct
(
const FArguments& InArgs |
Widgets/Input/SVirtualJoystick.h | ||
virtual int32 OnPaint
(
const FPaintArgs& Args, |
Widgets/Input/SVirtualJoystick.h | ||
void SetControls
(
const TArray< FControlInfo >& InControls |
Widgets/Input/SVirtualJoystick.h | ||
void SetGlobalParameters
(
float InActiveOpacity, |
Sets parameters that control all controls | Widgets/Input/SVirtualJoystick.h | |
void SetJoystickVisibility
(
const bool bVisible, |
Shows or hides the controls (for instance during cinematics) | Widgets/Input/SVirtualJoystick.h |
Overridden from SWidget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FVector2D ComputeDesiredSize
(
float |
Widgets/Input/SVirtualJoystick.h | ||
virtual FReply OnTouchEnded
(
const FGeometry& MyGeometry, |
Widgets/Input/SVirtualJoystick.h | ||
virtual FReply OnTouchMoved
(
const FGeometry& MyGeometry, |
Widgets/Input/SVirtualJoystick.h | ||
virtual FReply OnTouchStarted
(
const FGeometry& MyGeometry, |
Widgets/Input/SVirtualJoystick.h | ||
virtual bool SupportsKeyboardFocus() |
Widgets/Input/SVirtualJoystick.h | ||
virtual void Tick
(
const FGeometry& AllottedGeometry, |
Widgets/Input/SVirtualJoystick.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FVector2D ComputeThumbPosition
(
int32 ControlIndex, |
Widgets/Input/SVirtualJoystick.h | ||
float GetBaseOpacity() |
Return the target opacity to lerp to given the current state | Widgets/Input/SVirtualJoystick.h | |
virtual void HandleDisplayMetricsChanged
(
const FDisplayMetrics& NewDisplayMetric |
Callback for handling display metrics changes. | Widgets/Input/SVirtualJoystick.h | |
virtual bool HandleTouch
(
int32 ControlIndex, |
Process a touch event (on movement and possibly on initial touch) | Widgets/Input/SVirtualJoystick.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static void AlignBoxIntoScreen
(
FVector2D& Position, |
Widgets/Input/SVirtualJoystick.h | ||
static bool ShouldDisplayTouchInterface() |
Static function to return if external users should create/activate/etc a touch interface Note that this function is also used internally, so even if this returns false but an SVirtualJoystick is created, it won't actually show any controls | Widgets/Input/SVirtualJoystick.h |