1. Epic GamesDeveloper
  3. SVirtualJoystick

SVirtualJoystick

A virtual joystsick

Unreal Engine C++ API Reference > Runtime > Slate > Widgets > Input

Inheritance Hierarchy

References

   
Module Slate
Header /Engine/Source/Runtime/Slate/Public/Widgets/Input/SVirtualJoystick.h
Include #include "Widgets/Input/SVirtualJoystick.h"

Syntax

class SVirtualJoystick : public SLeafWidget

Remarks

A virtual joystsick

Variables

  Type Name Description
Protected variable float ActivationDelay  
Protected variable float ActiveOpacity Global settings from the UTouchInterface
Protected variable uint32: 1 bCenterOnEvent If true, this zone will have it's "center" set when you touch it, otherwise the center will be set to the center of the zone
Protected variable uint32: 1 bPreventReCenter If true, ignore re-centering
Protected variable uint32: 1 bVisible True if the joystick should be visible
Protected variable TControlArray< FControlData > Controls List of controls set by the UTouchInterface
Protected variable float Countdown Countdown until next state change
Protected variable float CurrentOpacity Target opacity
Protected variable float InactiveOpacity  
Protected variable float PreviousScalingFactor Last used scaling value for
Protected variable float StartupDelay  
Protected variable EVirtualJoystickState State The current state of all controls
Protected variable float TimeUntilDeactive  
Protected variable float TimeUntilReset  

Functions

  Type Name Description
Public function void

AddControl ( const FControlInfo& Control
)

  
Protected function Static void

AlignBoxIntoScreen ( FVector2D& Position,
const FVector2D& Size,
const FVector2D& ScreenSize
)

  
Public function void  
Protected function FVector2D

ComputeThumbPosition ( int32 ControlIndex,
const FVector2D& LocalCoord,
float* OutDistanceToTouchSqr,
float* OutDistanceToEdgeSqr
)

  
Public function void

Construct ( const FArguments& InArgs
)

  
Protected function float Return the target opacity to lerp to given the current state
Protected function Virtual void

HandleDisplayMetricsChanged ( const FDisplayMetrics& NewDisplayMetric
)

 Callback for handling display metrics changes.
Protected function Virtual bool

HandleTouch ( int32 ControlIndex,
const FVector2D& LocalCoord,
const FVector2D& ScreenSize
)

 Process a touch event (on movement and possibly on initial touch)
Public function void

SetControls ( const TArray< FControlInfo >& InControls
)

  
Public function void

SetGlobalParameters ( float InActiveOpacity,
float InInactiveOpacity,
float InTimeUntilDeactive,
float InTimeUntilReset,
float InActivationDelay,
bool InbPreventReCenter,
float InStartupDelay
)

 Sets parameters that control all controls
Public function void

SetJoystickVisibility ( const bool bVisible,
const bool bFade
)

 Shows or hides the controls (for instance during cinematics)
Public function Static bool 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

Overridden from SWidget

  Type Name Description
Public function Virtual Const FVector2D

ComputeDesiredSize ( float
)

 Overwritten from SWidget.
Public function Virtual Const int32

OnPaint ( const FPaintArgs& Args,
const FGeometry& AllottedGeometry,
const FSlateRect& MyCullingRect,
FSlateWindowElementList& OutDrawElements,
int32 LayerId,
const FWidgetStyle& InWidgetStyle,
bool bParentEnabled
)

 Overwritten from SWidget.
Public function Virtual FReply

OnTouchEnded ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is ended (finger lifted)
Public function Virtual FReply

OnTouchMoved ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is moved (finger moved)
Public function Virtual FReply

OnTouchStarted ( const FGeometry& MyGeometry,
const FPointerEvent& InTouchEvent
)

 Called when a touchpad touch is started (finger down)
Public function Virtual Const bool Checks to see if this widget supports keyboard focus. Override this in derived classes.
Public function Virtual void

Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

 Ticks this widget with Geometry.

Classes

  Type Name Description
Public struct FArguments    
Public struct FControlData The settings and current state of each zone we render  
Public struct FControlInfo The settings of each zone we render  

Enums

  Type Name Description
Protected enum EVirtualJoystickState    

Typedefs

Name Description
TControlArray TArray specialization for controls.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page