Touch Interface Designer 2025.2
Create touch interface with a visual editor and manage all mobile inputs like gestures
Loading...
Searching...
No Matches
SDeprecatedTouchInterface Class Reference

#include <SDeprecatedTouchInterface.h>

Inheritance diagram for SDeprecatedTouchInterface:
Inheritance graph
[legend]
Collaboration diagram for SDeprecatedTouchInterface:
Collaboration graph
[legend]

Public Member Functions

virtual FReply OnMouseButtonDown (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
virtual FReply OnMouseMove (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
virtual FReply OnMouseButtonUp (const FGeometry &MyGeometry, const FPointerEvent &MouseEvent) override
virtual FReply OnTouchStarted (const FGeometry &MyGeometry, const FPointerEvent &Event) override
virtual FReply OnTouchMoved (const FGeometry &MyGeometry, const FPointerEvent &Event) override
virtual FReply OnTouchEnded (const FGeometry &MyGeometry, const FPointerEvent &Event) override
virtual void Tick (const FGeometry &AllottedGeometry, const double InCurrentTime, const float InDeltaTime) override
virtual int32 OnPaint (const FPaintArgs &Args, const FGeometry &AllottedGeometry, const FSlateRect &MyCullingRect, FSlateWindowElementList &OutDrawElements, int32 LayerId, const FWidgetStyle &InWidgetStyle, bool bParentEnabled) const override
virtual bool SupportsKeyboardFocus () const override
virtual FVector2D ComputeDesiredSize (float) const override
virtual void RebuildTouchInterface (const bool bLoadConfig, const int32 InUserIndex, const int32 InConfigIndex)
virtual void PreDestruct ()
int32 GetControllerId () const
UWorld * GetWorldContext () const
TArray< UTouchInterfaceListener * > & GetListeners ()
TSharedPtr< SVirtualControl > GetVirtualControlWidget (const FName ControlName)
bool RegisterTouchInputComponent (UTouchInterfaceListener *ManagerComp)
bool UnregisterTouchInputComponent (UTouchInterfaceListener *ManagerComp)
void UnregisterAllManagerComponents ()
void BlockInput (const bool bBlock)
void BlockGesture (const bool bBlock)
bool ChangeInputAction (const FName ControlName, UInputAction *Action)
void EnableVirtualInput (const FName InputName)
void DisableVirtualInput (const FName InputName)
void SetWidgetVisibility (const bool bInVisible, const bool bInBlockInput, const bool bInBlockGesture)
void SetVirtualInputVisibility (const FName Name, const bool bInVisible, const bool bIncludeChildren)
void ShowAllVirtualInputs ()
void HideAllVirtualInputs ()
float GetVirtualInputOpacity (const FName ControlName)
void SetVirtualInputOpacity (const FName ControlName, const float NewOpacity)
bool GetVirtualControlData (const FName ControlName, FVirtualControl &VirtualControl)
FVirtualControl & GetVirtualControl (const FName ControlName)
TArray< FVirtualControl > GetAllControls (const bool IncludeButton=true, const bool IncludeJoystick=false, const bool IncludeTouchRegion=false)
void AddControl (const FVirtualControl &NewControl)
void RemoveControl (const FName Name, const bool bRemoveChildren)
void ResetToDefault ()
void SetVirtualControlVisualLayers (const FName ControlName, TArray< FVisualLayer > Layers)
void GetVirtualControlLayer (const FName ControlName, const FName LayerName, FVisualLayer &OutLayer)
void SetVirtualControlLayer (const FName ControlName, const FVisualLayer &Layer)
FName AddNewLayer (const FName ControlName, FVisualLayer &Layer)
FName InsertNewLayer (const FName ControlName, FVisualLayer &Layer, const int32 Index)
void RemoveLayer (const FName ControlName, const FName LayerName)
void RemoveLayerAt (const FName ControlName, const int32 Index)
UMaterialInstanceDynamic * GetLayerDynamicMaterialInstance (const FName ControlName, const FName LayerName, UObject *InOuter)
void SetControlSize (const FName Name, const FVector2D NewVisualSize, const FVector2D NewThumbSize, const FVector2D NewInteractionSize)
bool SetControlPosition (const FName Name, const FVector2D NewPosition, const bool InLandscape)
TArray< UTouchInterfaceListener * > GetAllListener ()
bool GetTypeOfControl (const FName ControlName, EControlType &Type)
bool ContainName (const FName ControlName)
TArray< FName > GetAllControlNames ()
TArray< FName > GetLayerNames (const FName ControlName)
UEnhancedInputLocalPlayerSubsystem * GetEnhancedInputSubsystem () const
bool IsActive () const
bool IsVisible () const
void SetScaleMultiplier (const float NewScale)
FVector2D LocalToNormalized (const FVector2D LocalPosition) const
FVector2D NormalizedToLocal (const FVector2D NormalizedPosition) const
bool SaveConfigurationFromCurrentSetup (const uint32 InUserIndex, const uint32 InConfigIndex)
bool LoadConfiguration (const uint32 InUserIndex, const uint32 InConfigIndex)
float GetVirtualControlOpacity () const
float GetCurrentScaleFactor () const
bool GetDrawDebug () const
float GetScaleFactor (const FGeometry &Geometry)

Static Public Member Functions

static FName GenerateUniqueLayerName (const TArray< FVisualLayer > &VisualLayers)
static bool DoesThisNameExistInVisualLayer (const TArray< FVisualLayer > VisualLayers, const FName OtherName)
static float GetDebugOpacity ()

Public Attributes

FOnTouchEvent OnTouchBeganEvent
FOnTouchEvent OnTouchMovedEvent
FOnTouchEvent OnTouchEndedEvent
FOnStateChangedEvent OnActiveStateChanged
FOnStateChangedEvent OnVisibilityStateChanged

Member Function Documentation

◆ AddControl()

void SDeprecatedTouchInterface::AddControl ( const FVirtualControl & NewControl)

Add new virtual control

◆ AddNewLayer()

FName SDeprecatedTouchInterface::AddNewLayer ( const FName ControlName,
FVisualLayer & Layer )

Add new layer in visual layer array

◆ BlockGesture()

void SDeprecatedTouchInterface::BlockGesture ( const bool bBlock)
inline

◆ BlockInput()

void SDeprecatedTouchInterface::BlockInput ( const bool bBlock)
inline

◆ ChangeInputAction()

bool SDeprecatedTouchInterface::ChangeInputAction ( const FName ControlName,
UInputAction * Action )

◆ ComputeDesiredSize()

virtual FVector2D SDeprecatedTouchInterface::ComputeDesiredSize ( float ) const
inlineoverridevirtual

◆ ContainName()

bool SDeprecatedTouchInterface::ContainName ( const FName ControlName)

◆ DisableVirtualInput()

void SDeprecatedTouchInterface::DisableVirtualInput ( const FName InputName)

◆ DoesThisNameExistInVisualLayer()

bool SDeprecatedTouchInterface::DoesThisNameExistInVisualLayer ( const TArray< FVisualLayer > VisualLayers,
const FName OtherName )
static

◆ EnableVirtualInput()

void SDeprecatedTouchInterface::EnableVirtualInput ( const FName InputName)

◆ GenerateUniqueLayerName()

FName SDeprecatedTouchInterface::GenerateUniqueLayerName ( const TArray< FVisualLayer > & VisualLayers)
static

Static function to return a unique layer name

◆ GetAllControlNames()

TArray< FName > SDeprecatedTouchInterface::GetAllControlNames ( )

◆ GetAllControls()

TArray< FVirtualControl > SDeprecatedTouchInterface::GetAllControls ( const bool IncludeButton = true,
const bool IncludeJoystick = false,
const bool IncludeTouchRegion = false )

Get all virtual controls data by type

◆ GetAllListener()

TArray< UTouchInterfaceListener * > SDeprecatedTouchInterface::GetAllListener ( )

◆ GetControllerId()

int32 SDeprecatedTouchInterface::GetControllerId ( ) const
inline

Get current controller id from player controller

◆ GetCurrentScaleFactor()

float SDeprecatedTouchInterface::GetCurrentScaleFactor ( ) const
inline

◆ GetDebugOpacity()

float SDeprecatedTouchInterface::GetDebugOpacity ( )
static

◆ GetDrawDebug()

bool SDeprecatedTouchInterface::GetDrawDebug ( ) const
inline

◆ GetEnhancedInputSubsystem()

UEnhancedInputLocalPlayerSubsystem * SDeprecatedTouchInterface::GetEnhancedInputSubsystem ( ) const
inline

◆ GetLayerDynamicMaterialInstance()

UMaterialInstanceDynamic * SDeprecatedTouchInterface::GetLayerDynamicMaterialInstance ( const FName ControlName,
const FName LayerName,
UObject * InOuter )

Create or get dynamic material instance from layer DO NOT CALL THIS EVERY FRAME!

◆ GetLayerNames()

TArray< FName > SDeprecatedTouchInterface::GetLayerNames ( const FName ControlName)

◆ GetListeners()

TArray< UTouchInterfaceListener * > & SDeprecatedTouchInterface::GetListeners ( )
inline

◆ GetScaleFactor()

float SDeprecatedTouchInterface::GetScaleFactor ( const FGeometry & Geometry)

◆ GetTypeOfControl()

bool SDeprecatedTouchInterface::GetTypeOfControl ( const FName ControlName,
EControlType & Type )

◆ GetVirtualControl()

FVirtualControl & SDeprecatedTouchInterface::GetVirtualControl ( const FName ControlName)

◆ GetVirtualControlData()

bool SDeprecatedTouchInterface::GetVirtualControlData ( const FName ControlName,
FVirtualControl & VirtualControl )

Get data of virtual control

◆ GetVirtualControlLayer()

void SDeprecatedTouchInterface::GetVirtualControlLayer ( const FName ControlName,
const FName LayerName,
FVisualLayer & OutLayer )

Get visual layer of virtual control

◆ GetVirtualControlOpacity()

float SDeprecatedTouchInterface::GetVirtualControlOpacity ( ) const
inline

◆ GetVirtualControlWidget()

TSharedPtr< SVirtualControl > SDeprecatedTouchInterface::GetVirtualControlWidget ( const FName ControlName)

◆ GetVirtualInputOpacity()

float SDeprecatedTouchInterface::GetVirtualInputOpacity ( const FName ControlName)

◆ GetWorldContext()

UWorld * SDeprecatedTouchInterface::GetWorldContext ( ) const

Get world context object

◆ HideAllVirtualInputs()

void SDeprecatedTouchInterface::HideAllVirtualInputs ( )

◆ InsertNewLayer()

FName SDeprecatedTouchInterface::InsertNewLayer ( const FName ControlName,
FVisualLayer & Layer,
const int32 Index )

Insert new layer into the visual layer array at given location

◆ IsActive()

bool SDeprecatedTouchInterface::IsActive ( ) const
inline

◆ IsVisible()

bool SDeprecatedTouchInterface::IsVisible ( ) const
inline

◆ LoadConfiguration()

bool SDeprecatedTouchInterface::LoadConfiguration ( const uint32 InUserIndex,
const uint32 InConfigIndex )

◆ LocalToNormalized()

FVector2D SDeprecatedTouchInterface::LocalToNormalized ( const FVector2D LocalPosition) const

Transform Local position (Touch Interface Geometry) to normalized (0 to 1)

◆ NormalizedToLocal()

FVector2D SDeprecatedTouchInterface::NormalizedToLocal ( const FVector2D NormalizedPosition) const

Transform normalized (0 to 1) to Local position (Touch Interface Geometry)

◆ OnMouseButtonDown()

FReply SDeprecatedTouchInterface::OnMouseButtonDown ( const FGeometry & MyGeometry,
const FPointerEvent & MouseEvent )
overridevirtual

This event can be called on mobile device and when Use Mouse For Touch is enabled. For touch, there is another event called On Touch Started So, for now, we are checking that the pointer event comes from a touch device, and this event is not taken into account (unhandled)

◆ OnMouseButtonUp()

FReply SDeprecatedTouchInterface::OnMouseButtonUp ( const FGeometry & MyGeometry,
const FPointerEvent & MouseEvent )
overridevirtual

◆ OnMouseMove()

FReply SDeprecatedTouchInterface::OnMouseMove ( const FGeometry & MyGeometry,
const FPointerEvent & MouseEvent )
overridevirtual

◆ OnPaint()

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

◆ OnTouchEnded()

FReply SDeprecatedTouchInterface::OnTouchEnded ( const FGeometry & MyGeometry,
const FPointerEvent & Event )
overridevirtual

◆ OnTouchMoved()

FReply SDeprecatedTouchInterface::OnTouchMoved ( const FGeometry & MyGeometry,
const FPointerEvent & Event )
overridevirtual

◆ OnTouchStarted()

FReply SDeprecatedTouchInterface::OnTouchStarted ( const FGeometry & MyGeometry,
const FPointerEvent & Event )
overridevirtual

◆ PreDestruct()

void SDeprecatedTouchInterface::PreDestruct ( )
virtual

◆ RebuildTouchInterface()

void SDeprecatedTouchInterface::RebuildTouchInterface ( const bool bLoadConfig,
const int32 InUserIndex,
const int32 InConfigIndex )
virtual

Force the reconstruction of all virtual controls Do not call this every frame!

◆ RegisterTouchInputComponent()

bool SDeprecatedTouchInterface::RegisterTouchInputComponent ( UTouchInterfaceListener * ManagerComp)

◆ RemoveControl()

void SDeprecatedTouchInterface::RemoveControl ( const FName Name,
const bool bRemoveChildren )

Remove virtual control from struct by name

◆ RemoveLayer()

void SDeprecatedTouchInterface::RemoveLayer ( const FName ControlName,
const FName LayerName )

Remove layer from visual layer array

◆ RemoveLayerAt()

void SDeprecatedTouchInterface::RemoveLayerAt ( const FName ControlName,
const int32 Index )

◆ ResetToDefault()

void SDeprecatedTouchInterface::ResetToDefault ( )

Remove all virtual controls added

◆ SaveConfigurationFromCurrentSetup()

bool SDeprecatedTouchInterface::SaveConfigurationFromCurrentSetup ( const uint32 InUserIndex,
const uint32 InConfigIndex )

◆ SetControlPosition()

bool SDeprecatedTouchInterface::SetControlPosition ( const FName Name,
const FVector2D NewPosition,
const bool InLandscape )

◆ SetControlSize()

void SDeprecatedTouchInterface::SetControlSize ( const FName Name,
const FVector2D NewVisualSize,
const FVector2D NewThumbSize,
const FVector2D NewInteractionSize )

◆ SetScaleMultiplier()

void SDeprecatedTouchInterface::SetScaleMultiplier ( const float NewScale)
inline

◆ SetVirtualControlLayer()

void SDeprecatedTouchInterface::SetVirtualControlLayer ( const FName ControlName,
const FVisualLayer & Layer )

Set visual layer of virtual control

◆ SetVirtualControlVisualLayers()

void SDeprecatedTouchInterface::SetVirtualControlVisualLayers ( const FName ControlName,
TArray< FVisualLayer > Layers )

Change visual layer of virtual control

◆ SetVirtualInputOpacity()

void SDeprecatedTouchInterface::SetVirtualInputOpacity ( const FName ControlName,
const float NewOpacity )

◆ SetVirtualInputVisibility()

void SDeprecatedTouchInterface::SetVirtualInputVisibility ( const FName Name,
const bool bInVisible,
const bool bIncludeChildren )

◆ SetWidgetVisibility()

void SDeprecatedTouchInterface::SetWidgetVisibility ( const bool bInVisible,
const bool bInBlockInput,
const bool bInBlockGesture )

◆ ShowAllVirtualInputs()

void SDeprecatedTouchInterface::ShowAllVirtualInputs ( )

◆ SupportsKeyboardFocus()

virtual bool SDeprecatedTouchInterface::SupportsKeyboardFocus ( ) const
inlineoverridevirtual

◆ Tick()

void SDeprecatedTouchInterface::Tick ( const FGeometry & AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime )
overridevirtual

◆ UnregisterAllManagerComponents()

void SDeprecatedTouchInterface::UnregisterAllManagerComponents ( )

◆ UnregisterTouchInputComponent()

bool SDeprecatedTouchInterface::UnregisterTouchInputComponent ( UTouchInterfaceListener * ManagerComp)

Member Data Documentation

◆ OnActiveStateChanged

FOnStateChangedEvent SDeprecatedTouchInterface::OnActiveStateChanged

◆ OnTouchBeganEvent

FOnTouchEvent SDeprecatedTouchInterface::OnTouchBeganEvent

◆ OnTouchEndedEvent

FOnTouchEvent SDeprecatedTouchInterface::OnTouchEndedEvent

◆ OnTouchMovedEvent

FOnTouchEvent SDeprecatedTouchInterface::OnTouchMovedEvent

◆ OnVisibilityStateChanged

FOnStateChangedEvent SDeprecatedTouchInterface::OnVisibilityStateChanged
The documentation for this class was generated from the following files:
  • D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Public/TouchInterface/SDeprecatedTouchInterface.h
  • D:/MEGA/TouchProject/TouchProjectNext/Plugins/TouchInterfaceDesigner/Source/TouchInterface/Private/TouchInterface/SDeprecatedTouchInterface.cpp