STouchInterfaceRuntime.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "STouchInterface.h"
#include "VirtualShape/VirtualShapeDrawer.h"
#include "Widgets/SCompoundWidget.h"
 
class ULayoutComponent;
class UComponentLogic;
class UTouchInputComponent;
class STouchInputComponent;
class UTouchInterfaceSettings;
class SLayoutComponent;
class SConstraintCanvas;
class UTouchInterfaceListener;
class UTouchInterfaceLayout;
class SRetainerWidget;
class ULocalPlayer;
 
DECLARE_DELEGATE_TwoParams(FOnLayoutTouch, int32, FVector2D)
DECLARE_DELEGATE_OneParam(FOnTouchInterfaceNotification, bool)
DECLARE_DELEGATE(FOnTouchInterfaceEvent)
 

class TOUCHINTERFACE_API STouchInterfaceRuntime : public STouchInterface
{
    
public:
    SLATE_BEGIN_ARGS(STouchInterfaceRuntime)
        : _bLoadLayoutFromSave(false)
        , _LayoutIndex(0)
        {}
        //Begin STouchInterface
        SLATE_ARGUMENT(bool, bRenderOnInvalidation)
        SLATE_ARGUMENT(bool, bRenderOnPhase)
        SLATE_ARGUMENT(bool, bRetainRender)
        SLATE_ARGUMENT(int32, Phase)
        SLATE_ARGUMENT(int32, PhaseCount)
        SLATE_ARGUMENT(TObjectPtr<UMaterialInterface>, RetainerMaterial)
        SLATE_ARGUMENT(FName, TextureParamName)
        //End STouchInterface
        
        SLATE_ARGUMENT(bool, bLoadLayoutFromSave)
        SLATE_ARGUMENT(int32, LayoutIndex)
        SLATE_ARGUMENT(TObjectPtr<ULocalPlayer>, LocalPlayer)
        SLATE_ARGUMENT(bool, EnableShapeDrawer)
        SLATE_ARGUMENT(TSubclassOf<UVirtualShapeDrawer>, DrawerClass)
        SLATE_ARGUMENT(int32, DebugType)
 
        SLATE_EVENT(FOnLayoutTouch, OnTouchBegan)
        SLATE_EVENT(FOnLayoutTouch, OnTouchMove)
        SLATE_EVENT(FOnLayoutTouch, OnTouchEnd)
        SLATE_EVENT(FOnTouchInterfaceNotification, OnActiveStateChanged)
        SLATE_EVENT(FOnTouchInterfaceNotification, OnVisibilityChanged)
        SLATE_EVENT(FOnTouchInterfaceEvent, OnLayoutGenerated)
 
        //TODO: TAttribute to get children in layout object?
        //TODO: RetainerSettings?
        //TODO TAttribute for opacity
    SLATE_END_ARGS()
 
    STouchInterfaceRuntime();

    void Construct(const FArguments& InArgs, TObjectPtr<UTouchInterfaceLayout> Layout);
 
    //TODO: STouchInterface contains only functions that are used both in editor and runtime (Shares code between the editor and runtime)
    
    //Called by subsystem on deinitialization or before this widget is removed from viewport
    virtual void Clean() override;
 
protected:
    EActiveTimerReturnType ActivateTouchInterface(double InCurrentTime, float InDeltaTime);
 
    virtual EActiveTimerReturnType BeginGenerateLayout(double InCurrentTime, float InDeltaTime);
 
    virtual void GenerateLayout(TObjectPtr<UTouchInterfaceLayout> Layout) override;
    
public:
    //Begin SWidget Implementation
    virtual bool SupportsKeyboardFocus() const override { return false; }
    virtual FVector2D ComputeDesiredSize(float) const override { return FVector2D(100, 100); }
 
    virtual FReply OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent) override;
    
    virtual FReply OnMouseButtonDown(const FGeometry& MyGeometry, const FPointerEvent& MouseEvent) override;
    virtual FReply OnMouseButtonDoubleClick(const FGeometry& InMyGeometry, const FPointerEvent& InMouseEvent) 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& InTouchEvent) override;
    virtual FReply OnTouchMoved(const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent) override;
    virtual FReply OnTouchEnded(const FGeometry& MyGeometry, const FPointerEvent& InTouchEvent) override;
    virtual FReply OnTouchFirstMove(const FGeometry& MyGeometry, const FPointerEvent& TouchEvent) override;
    virtual FReply OnTouchForceChanged(const FGeometry& MyGeometry, const FPointerEvent& TouchEvent) 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;
    //End SWidget Implementation
 
 
    //GETTERS
    
    UWorld* GetWorldContext() const;
 
    TArray<UTouchInterfaceListener*>& GetListeners() { return Listeners; }
 
    ULocalPlayer* GetLocalPlayer() const { return LocalPlayer; }
    
    
    //SETTERS
 
    void SetListenerList(TArray<UTouchInterfaceListener*> NewListenerList);
 
 
    //UTILITY
    
    bool IsActive() const { return State == State_Active; }
 
    UVirtualShapeDrawer* GetShapeDrawerInstance() const { return ShapeDrawerInstance; }
 
    UVirtualShapeDrawer* AddShapeDrawer(TSubclassOf<UVirtualShapeDrawer> ShapeDrawerClass);
    void RemoveShapeDrawer();
 
    void ShowShapeDrawer() const;
    void HideShapeDrawer() const;
 
    void ResetComponentLocation();
 
    //INPUT
    
    // Whether or not input is enabled
    void BlockInput(const bool bBlock) { bBlockInput = bBlock; }
 
    // Whether or not gesture is enabled
    //void BlockRecognizerOfType(TSubclassOf<UTouchInterfaceListener> RecognizerClass);
 
 
    //Check if layout children has changed. If so, add or remove widget accordingly
    virtual void AddOrRemoveComponent();
    
    virtual void Rebuild(const TObjectPtr<UTouchInterfaceLayout> Layout) override;
 
private:
    // Callback for handling device orientation changes
    virtual void HandleOnOrientationChanged(const int32 Mode);
 
    virtual float CalculateScaleFactor(const FGeometry& Geometry) const override;
 
    bool CanSendInputsToRecognizer(const bool bHitControl) const;
 
 
protected:
    TObjectPtr<UTouchInterfaceLayout> CurrentLayout;
 
    const UTouchInterfaceSettings* Settings;
 
    //TSharedPtr<SRetainerWidget> RetainerWidget;
 
    //TSharedPtr<SConstraintCanvas> MainCanvas;
 
    //TArray<TSharedPtr<SLayoutComponent>> Children;
 
    FOnLayoutTouch OnTouchBegan;
    FOnLayoutTouch OnTouchMove;
    FOnLayoutTouch OnTouchEnd;
 
    //FOnTouchInterfaceNotification OnActiveStateChanged;
    //FOnTouchInterfaceNotification OnVisibilityChanged;
 
    //FOnTouchInterfaceEvent OnLayoutGenerated;
 
private:
    TArray<UTouchInterfaceListener*> Listeners;
 
    UVirtualShapeDrawer* ShapeDrawerInstance;
 
    struct FFingerDebugData
    {
        uint32 FingerIndex;
        FVector2D Position;
 
        FFingerDebugData(const uint32 InFingerIndex, const FVector2D InPosition) :
        FingerIndex(InFingerIndex),
        Position(InPosition)
        {
        
        }
    };
 
    uint8 bDrawDebug:1;
    
    TArray<FFingerDebugData> Fingers;
    
    uint8 bLoadLayoutFromSave:1;
    int32 LayoutIndex;
 
    UWorld* WorldContext;
    ULocalPlayer* LocalPlayer;
 
    enum ELayoutState
    {
        State_GoingToActive,
        State_Active,
        State_CountingDownToInactive,
        State_CountingDownToReset,
        State_GoingToInactive,
        State_Inactive,
    };
 
    ELayoutState State;
    
    //Countdown until next state change
    float Countdown;
 
    //GESTURE RECOGNIZER
    
    uint8 bGestureRecognizerEnabled:1;
    
    uint8 bBlockRecognizers:1;
 
 
    //SHAPE RECOGNIZER
    
    // True if the widget should send input to the Shape Recognition Manager
    uint8 bShapeRecognizerEnabled:1;
    
    uint8 bBlockShapeRecognition:1;
};