TouchInterfaceSubsystem.h

Go to the documentation of this file.

// Copyright 2022 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "Subsystems/LocalPlayerSubsystem.h"
#include "TouchInterface/VirtualControlSetup.h"
#include "Runtime/Launch/Resources/Version.h"
#include "TouchInterfaceSubsystem.generated.h"
 
struct FLayoutSaveData;
class STouchInterfaceRuntime;
class UTouchInterfaceLayout;
struct FTouchInterfaceConfiguration;
class UVirtualShapeDrawer;
class UTouchInterfaceListener;
class SDeprecatedTouchInterface;
class UWorld;
class ULocalPlayer;
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnStateChangedSignature, bool, Value);
DECLARE_DYNAMIC_MULTICAST_DELEGATE(FOnSubsystemNotification);
 
USTRUCT(BlueprintType)
struct FTouchInterfaceInit
{
    GENERATED_BODY()
 
    UPROPERTY(Category="Touch Interface", EditAnywhere, BlueprintReadWrite)
    bool IsVisible;
 
    UPROPERTY(Category="Touch Interface", EditAnywhere, BlueprintReadWrite)
    bool bBlockInput;
 
    UPROPERTY(Category="Touch Interface", EditAnywhere, BlueprintReadWrite)
    bool bBlockRecognizers;
 
    UPROPERTY(Category="Touch Interface", EditAnywhere, BlueprintReadWrite)
    bool bLoadConfiguration;
 
    UPROPERTY(Category="Touch Interface", EditAnywhere, BlueprintReadWrite)
    int32 UserIndex;
    
    UPROPERTY(Category="Touch Interface", EditAnywhere, BlueprintReadWrite)
    int32 ConfigIndex;
 
    FTouchInterfaceInit() :
    IsVisible(true),
    bBlockInput(false),
    bBlockRecognizers(false),
    bLoadConfiguration(false),
    UserIndex(0),
    ConfigIndex(0)
    {
        
    }
};
 
UENUM(BlueprintType)
enum class EFailReason : uint8
{
    NoFileInDisk,
    LoadError,
    InvalidSnapshot
};

UCLASS()
class TOUCHINTERFACE_API UTouchInterfaceSubsystem : public ULocalPlayerSubsystem
{
    GENERATED_BODY()
    
public:
    UTouchInterfaceSubsystem();
    
    virtual bool ShouldCreateSubsystem(UObject* Outer) const override;
    
    virtual void Initialize(FSubsystemCollectionBase& Collection) override;
    virtual void Deinitialize() override;
 
    // Register this component to receive input
    UFUNCTION(Category="Touch Interface", BlueprintCallable)
    bool RegisterTouchListenerComponent(UTouchInterfaceListener* Listener);

    UFUNCTION(Category="Touch Interface", BlueprintCallable)
    bool UnregisterTouchListenerComponent(UTouchInterfaceListener* Listener);
 
private:
    bool ShouldDisplayTouchInterface();
    
public:
    UVirtualInputEvent* CreateAndRegisterVirtualInputEvent(TSubclassOf<UVirtualInputEvent> Class);
    
    UFUNCTION(Category="Touch Interface", BlueprintCallable, meta=(AutoCreateRefTerm = "State", DeprecatedFunction, DepreciationMessage="Use Add Touch Interface instead"))
    virtual void AddToPlayerScreen(UVirtualControlSetup* NewTouchInterface, const FTouchInterfaceInit& State);

    UFUNCTION(Category="Touch Interface", BlueprintCallable)
    virtual UTouchInterfaceLayout* AddTouchInterface(UTouchInterfaceLayout* Layout = nullptr/*, bool bDeferredConstruction*/, const bool bLoadSave = false, const int32 SnapshotID = 0);
 
    //TODO: Allow dev to add touch interface to screen later (construction, then add to screen later).
    
    // Add new touch interface from virtual control setup
    //UFUNCTION(Category="Touch Interface", BlueprintCallable)
    //virtual void AddTouchInterface(UVirtualControlSetup* TouchInterface);
    
    // Add new touch interface from configuration saved in disk
    //UFUNCTION(Category="Touch Interface", BlueprintCallable)
    //virtual void AddTouchInterfaceFromSave(int32 UserIndex, int32 ConfigIndex);
    
    // Remove touch interface from player screen
    UFUNCTION(Category="Touch Interface", BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use Remove Touch Interface instead"))
    virtual void RemoveFromPlayerScreen();
 
    UFUNCTION(Category="Touch Interface", BlueprintCallable)
    virtual void RemoveTouchInterface();

    TSharedPtr<SDeprecatedTouchInterface> GetTouchInterfaceInstance();

    TSharedPtr<STouchInterfaceRuntime> GetTouchInterfaceWidget();
 
    UFUNCTION(Category="Touch Interface", BlueprintCallable, BlueprintPure)
    UTouchInterfaceLayout* GetLayoutInstance() const { return LayoutInstance.Get(); }
 
    UFUNCTION(Category="Touch Interface", BlueprintCallable)
    const FGeometry& GetTouchInterfaceGeometry() const;
    
    //VISIBILITY
    
    // Display touch interface
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use Show Touch Interface instead"))
    virtual void ShowWidget(bool bEnableInput, bool bEnableGesture);
 
    //Set touch interface widget to visible
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void ShowTouchInterface();
 
    //Todo: Replace by bKeepGestureEnabled ?
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable, meta=(DeprecatedFunction, DeprecationMessage="Use Hide Touch Interface instead"))
    virtual void HideWidget(bool bDisableGesture);
 
    //TODO: Allow to choose if gesture continue to work and only layout is hidden? Use hide function in layout object
    
    //Set touch interface widget to hidden (no interaction)
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void HideTouchInterface();
 
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void ShowVirtualControl(const FName Name, bool bIncludeChild);
 
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void HideVirtualControl(const FName Name, bool bIncludeChild);
 
    // Displays all virtual inputs in touch interface
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void ShowAllVirtualInput();
 
    // Hide all virtual inputs in touch interface
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void HideAllVirtualInput();
 
    // Displays all virtual inputs except the named one
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void ShowAllExcept(const FName Name);
 
    // Hide all virtual inputs except the named one
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void HideAllExcept(const FName Name);
 
    // Displays all virtual inputs except the named one
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void ShowAllExceptNamedOnes(const TArray<FName> Names);
 
    // Hide all virtual inputs except the named one
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    virtual void HideAllExceptNamedOnes(const TArray<FName> Names);
 
    // Get opacity value of virtual input
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    float GetVirtualInputOpacity(const FName InputName);
 
    // Set opacity value of virtual input
    UFUNCTION(Category="Touch Interface|Visibility", BlueprintCallable)
    void SetVirtualInputOpacity(const FName InputName, const float NewOpacity);
 
    
    //DRAWER
 
    // Add drawer widget to player screen
    UFUNCTION(Category="Touch Interface|Drawer", BlueprintCallable)
    virtual UVirtualShapeDrawer* AddDrawer(TSubclassOf<UVirtualShapeDrawer> Drawer, int32 ZOrder = 1);
 
    // Get instance of widget added to player screen
    UFUNCTION(Category="Touch Interface|Drawer", BlueprintCallable, BlueprintPure)
    UVirtualShapeDrawer* GetDrawerInstance() const;
 
    // Display drawer widget
    UFUNCTION(Category="Touch Interface|Drawer", BlueprintCallable)
    virtual void ShowDrawer();
 
    // Hide drawer widget
    UFUNCTION(Category="Touch Interface|Drawer", BlueprintCallable)
    virtual void HideDrawer();
    
    // Remove drawer widget from player screen
    UFUNCTION(Category="Touch Interface|Drawer", BlueprintCallable)
    virtual void RemoveDrawer();
 
    
    //INPUT
    
    // Enable input in touch interface
    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable)
    virtual void EnableInput();
 
    // Disable input in touch interface (no interaction)
    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable)
    virtual void DisableInput();
 
    // Enable virtual input
    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable, meta=(DeprecatedFunction))
    virtual void EnableVirtualInput(const FName InputName);
 
    // Disable virtual input (no interaction)
    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable)
    virtual void DisableVirtualInput(const FName InputName);
 
    // Enable gesture in touch interface
    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable)
    virtual void EnableGesture();
 
    // Disable gesture in touch interface (no interaction)
    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable)
    virtual void DisableGesture();

    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable)
    virtual void TryRecognizeShape();

    UFUNCTION(Category="Touch Interface|Input", BlueprintCallable)
    bool SetInputAction(const FName ControlName, UInputAction* InputAction);
 
    
    //DATA
 
    // Get virtual control data by ref
    UFUNCTION(Category="Touch Interface|Data", BlueprintCallable)
    virtual bool GetVirtualControlDataByRef(const FName ControlName, FVirtualControl& Data);
 
    // Get a reference of virtual control data
    UFUNCTION(Category="Touch Interface|Data", BlueprintCallable)
    virtual FVirtualControl& GetVirtualControlDataRef(const FName ControlName);
 
    // Get a copy of virtual control data
    UFUNCTION(Category="Touch Interface|Data", BlueprintCallable)
    virtual bool GetVirtualControlData(const FName ControlName, FVirtualControl& Data);

    UFUNCTION(Category="Touch Interface|Data", BlueprintCallable)
    virtual void AddVirtualInput(class UVirtualInput* VirtualInput, FVector2D LandscapePosition, FVector2D PortraitPosition);
 
    UFUNCTION(Category="Touch Interface|Data", BlueprintCallable)
    virtual void RemoveVirtualInput(class UVirtualInput* VirtualInput);
 
    UFUNCTION(Category="Touch Interface|Data", BlueprintCallable)
    virtual void ResetToDefault();

    UFUNCTION(Category ="Touch Interface|Data", BlueprintCallable,  meta=(DeterminesOutputType = "Class", DeprecatedFunction))
    ULCInputModifier* GetVirtualInputModifierByClass(const FName ControlName, TSubclassOf<ULCInputModifier> Class);

    UFUNCTION(Category="Touch Interface|Data", BlueprintCallable, meta=(DeterminesOutputType = "Class"))
    UVirtualInputEvent* GetVirtualInputEventByClass(const FName ControlName, TSubclassOf<UVirtualInputEvent> Class);

    //UFUNCTION(Category="Touch Interface|Data", Blueprintable, meta=(DeterminesOutputType = "Class"))
    //UVirtualInputEvent* AddVirtualInputEvent(const FName ControlName, TSubclassOf<UVirtualInputEvent> Class);
 
    // Remove the virtual input instance
    //UFUNCTION(Category="Touch Interface|Data", Blueprintable)
    //bool RemoveVirtualInputEvent(const FName ControlName, UVirtualInputEvent* VirtualInputEventToRemove);
    
    //TODO: Add virtual input event instance by class
    //TODO: Remove virtual input event instance by class
    
    // VISUAL
 
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable)
    virtual void SetVirtualControlAppearance(const FName ControlName, TArray<FVisualLayer> Layers);
 
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable, BlueprintPure)
    virtual void GetVirtualControlLayer(const FName ControlName, const FName LayerName, FVisualLayer& OutLayer);
 
    //TODO: Ref BeginVisualModifications(const FName VirtualInputName)
    //TODO: EndVisualModification(TArray<FVisualLayer> Layers)
    
    //TODO: Get Visual Layer by Ref
    //virtual FVisualLayer& GetVirtualInputLayer(const FName VirtualInputName, const FName LayerName, bool& Return);
 
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable)
    virtual void SetVirtualControlLayer(const FName ControlName, const FVisualLayer& Layer);
    
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable)
    virtual FName AddNewLayer(const FName ControlName, const FName LayerName, FVisualLayer Layer);
 
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable, meta=(ReturnDisplayName="Layer Name"))
    virtual FName InsertNewLayer(const FName ControlName, const FName LayerName, FVisualLayer Layer, int32 Index);
 
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable)
    virtual void RemoveLayer(const FName ControlName, const FName LayerName);
 
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable)
    virtual void RemoveLayerAt(const FName ControlName, const int32 Index);
    
    UFUNCTION(Category="Touch Interface|Visual", BlueprintCallable)
    virtual bool GetDynamicMaterialInstanceFromLayer(const FName ControlName, const FName LayerName, UMaterialInstanceDynamic* &DMI);
 
 
    //SIZE & POSITION

    //void BeginModifications(const FName VirtualAnchorName);
 
    //void BeginVirtualInputModifications(const FName VirtualAnchorName, const FName VirtualInputName);
 
    //Should be called after BeginModification()
    //void EndModification();
    
    //virtual void SetVirtualInputSize(const FName VirtualInputName, const FVector2D Size);
 
    //virtual void SetVirtualInputSizeScale(const FName VirtualInputName, float SizeScale);
    
    UFUNCTION(Category="Touch Interface|Size and Position", BlueprintCallable)
    virtual void ChangeButtonSize(const FName ControlName, const FVector2D NewVisualSize, const FVector2D NewInteractionSize);

    UFUNCTION(Category="Touch Interface|Size and Position", BlueprintCallable)
    virtual void ChangeJoystickSize(const FName ControlName, const FVector2D NewVisualSize, const FVector2D NewThumbSize, const FVector2D NewInteractionSize);

    UFUNCTION(Category="Touch Interface|Size and Position", BlueprintCallable)
    virtual void ChangeTouchRegionSize(const FName ControlName, const FVector2D NewInteractionSize);
    
    UFUNCTION(Category="Touch Interface|Size and Position", BlueprintCallable)
    virtual bool ChangePosition(const FName ControlName, const FVector2D NewCenter, const bool LandscapePosition = true);
    
 
    // UTILITIES
    
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    bool TouchInterfaceExist() const;
    
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    EControlType GetTypeOfVirtualControl(const FName ControlName) const;
 
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    virtual bool ContainName(const FName ControlName);
    
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    virtual bool GetAllControlsName(TArray<FName>& Names);
    
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    virtual bool GetLayerNames(const FName ControlName, TArray<FName>& Names);

    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    bool IsInterfaceActive() const;
    
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    bool IsVisible() const;
    
    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable)
    void SetScaleMultiplier(const float NewScaleMultiplier);

    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable, BlueprintPure, meta=(CompactNodeTitle="To Normalized"))
    FVector2D LocalToNormalized(const FVector2D LocalPosition) const;

    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable, BlueprintPure, meta=(CompactNodeTitle="To Local"))
    FVector2D NormalizedToLocal(const FVector2D NormalizedPosition) const;

    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable, BlueprintPure, meta=(CompactNodeTitle="Absolute To Local"))
    FVector2D AbsoluteToLocal(const FVector2D AbsolutePosition) const;

    UFUNCTION(Category="Touch Interface|Utility", BlueprintCallable, BlueprintPure, meta=(CompactNodeTitle="Local To Absolute"))
    FVector2D LocalToAbsolute(const FVector2D LocalPosition) const;
    
 
    // SAVE

    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable, BlueprintPure)
    virtual bool CanSave(const int32 SnapshotId, EFailReason& FailReason);
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable, BlueprintPure)
    virtual bool TouchInterfaceSaveFileExist();
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable, BlueprintPure)
    virtual bool TouchInterfaceConfigurationExist(const int32 ConfigIndex);
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool ConvertSaveDataByConfigIndex(const int32 UserIndex, const int32 ConfigIndex);
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool ConvertSaveData(const int32 UserIndex, UVirtualControlSetup* VirtualControlSetup, UTouchInterfaceLayout* TouchInterfaceLayout);
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool SaveConfigurationFromCurrentSetup(const int32 UserIndex, const int32 ConfigIndex);
 
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool SaveConfigurationWithSetup(const int32 UserIndex, const int32 ConfigIndex, UVirtualControlSetup* Setup);
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool Save(const int32 SnapshotID, UTouchInterfaceLayout* LayoutReference);
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool LoadConfiguration(const int32 UserIndex, const int32 ConfigIndex);

    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool ApplySnapshot(const int32 SnapshotID);

    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable, BlueprintPure)
    virtual bool GetSnapshot(const int32 SnapshotID, FLayoutSaveData& Snapshot);
    
    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable, BlueprintPure)
    virtual bool GetConfiguration(const int32 UserIndex, const int32 ConfigIndex, FTouchInterfaceConfiguration& Configuration);

    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool DeleteConfiguration(const int32 UserIndex, const int32 ConfigIndex);

    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool DeleteSnapshot(const int32 SnapshotID);

    UFUNCTION(Category="Touch Interface|Save and Load", BlueprintCallable)
    virtual bool DeleteTouchInterfaceSaveFile(const int32 UserIndex);
 
    
    //DEBUG
    
    UFUNCTION(Category="Touch Interface|Debug", BlueprintCallable)
    void EnableDebug() const;
 
    //Hide debug data
    UFUNCTION(Category="Touch Interface|Debug", BlueprintCallable)
    void DisableDebug() const;
 
    //EVENTS
    
    UPROPERTY(Category="Touch Interface|State", BlueprintAssignable)
    FOnStateChangedSignature OnActiveStateChanged;

    UPROPERTY(Category="Touch Interface|State", BlueprintAssignable)
    FOnStateChangedSignature OnVisibilityStateChanged;
 
    // Called when subsystem create new touch interface and add to player's viewport
    UPROPERTY(Category="Touch Interface|State", BlueprintAssignable)
    FOnSubsystemNotification OnTouchInterfaceCreated;
 
    //Called when subsystem remove touch interface from viewport's player
    UPROPERTY(Category="Touch Interface|State", BlueprintAssignable)
    FOnSubsystemNotification OnTouchInterfaceRemoved;
 
    //Called when a gamepad is connected to device (can be slow or not called on some devices)
    UPROPERTY(Category="Touch Interface|State", BlueprintAssignable)
    FOnSubsystemNotification OnGamepadConnected;
    
    //Called when a gamepad is disconnected from device (can be slow or not called on some devices)
    UPROPERTY(Category="Touch Interface|State", BlueprintAssignable)
    FOnSubsystemNotification OnGamepadDisconnected;
    
private:
    UFUNCTION()
    ULocalPlayer* GetLocalPlayerInstance() const { return LocalPlayerInstance; }
 
    void HandleOnPreLoadMap(const FString& MapName);
 
    //void BindTouchInputOnPlayerController();
    
    void HandleBeganTouchEvent(const int32 FingerIndex, const FVector2D LocalPosition);
    void HandleMovedTouchEvent(const int32 FingerIndex, const FVector2D LocalPosition);
    void HandleEndedTouchEvent(const int32 FingerIndex, const FVector2D LocalPosition);
 
    void HandleOnActiveStateChangedEvent(const bool IsActive);
    void HandleOnVisibilityStateChangedEvent(const bool IsVisible);
    
    void HandleOnControllerConnexionChange(EInputDeviceConnectionState ConnectionState, FPlatformUserId UserId, FInputDeviceId DeviceId);
    
    void HandleOnAnyKeyPressed(FKey KeyPressed);
    void HandleOnTouch(ETouchIndex::Type Index, FVector Coordinate);
    
    /*~ MyOtherFunction shows flags named after the values from EColorBits. */
    /*UFUNCTION(BlueprintCallable)
    void MyOtherFunction(UPARAM(meta=(Bitmask, BitmaskEnum = "EColorBits")) int32 ColorFlagsParam)*/
    
    
    UPROPERTY()
    TObjectPtr<UVirtualControlSetup> CurrentVirtualControlSetup;
 
    UPROPERTY()
    TObjectPtr<UTouchInterfaceLayout> LayoutInstance;
 
    TSharedPtr<SDeprecatedTouchInterface> DeprecatedTouchInterfaceInstance;
 
    TSharedPtr<STouchInterfaceRuntime> TouchInterfaceInstance;
 
    UPROPERTY()
    UVirtualShapeDrawer* VirtualShapeDrawerInstance;
 
    UPROPERTY()
    ULocalPlayer* LocalPlayerInstance;

    uint8 bIsTouchInput:1;
 
    UPROPERTY()
    TMap<FName, UMaterialInstanceDynamic*> CachedMaterialInstance;
 
    UPROPERTY()
    UTexture2D* DebugTexture;
 
    uint8 bIsInitialized:1;
 
    // Virtual Input Event instance is saved here to avoid GC and memory leak
    UPROPERTY()
    TArray<TObjectPtr<UVirtualInputEvent>> VirtualInputEvents;
 
    uint8 bHiddenByGamepad:1;
};