STouchInterface.h

Go to the documentation of this file.

// Copyright 2024 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Widgets/SCompoundWidget.h"
#include "Widgets/Layout/Anchors.h"
 
class ULayoutComponent;
class UComponentLogic;
class UTouchInputComponent;
class STouchInputComponent;
class UTouchInterfaceSettings;
class SLayoutComponent;
class SConstraintCanvas;
class UTouchInterfaceListener;
class UTouchInterfaceLayout;
class SRetainerWidget;
class ULocalPlayer;
class UMaterialInterface;
 
struct FTouchInterfaceChildren
{
    int32 ZOrder;
    FAnchors Anchors;
    FVector2D Alignment;
    FVector2D Location;
    FVector Size;
    float Angle;
    
    TSharedPtr<SLayoutComponent> Widget;
};
 
DECLARE_DELEGATE_TwoParams(FOnLayoutTouch, int32, FVector2D)
DECLARE_DELEGATE_OneParam(FOnTouchInterfaceNotification, bool)
DECLARE_DELEGATE(FOnTouchInterfaceEvent)
 

 
class TOUCHINTERFACE_API STouchInterface : public SCompoundWidget
{
    
public:
    SLATE_BEGIN_ARGS(STouchInterface)
        : _RenderOpacity(1.0f)
        {}
        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)
        SLATE_ARGUMENT(float, RenderOpacity)
    SLATE_END_ARGS()
 
    STouchInterface();

    void Construct(const FArguments& InArgs);
 
    //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();
 
protected:
    virtual void GenerateLayout(const TObjectPtr<UTouchInterfaceLayout> Layout) = 0;
    
public:
    //Begin SWidget Implementation
    
    //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
 
    TArray<TSharedPtr<SLayoutComponent>> GetComponents() { return Children; }
 
    float GetLayoutOpacity() const;
 
    FVector2D GetGeometrySize() const;
    
    //SETTERS
    
    void SetLayoutVisibility(const bool bIsVisible) const;
 
    void SetRetainRender(const bool bValue);
    void SetRenderOnPhase(const bool bValue);
    void SetRenderOnInvalidation(const bool bValue);
    void SetRenderPhase(const int32 Phase, const int32 PhaseCount);
    void SetRetainerMaterial(TObjectPtr<UMaterialInterface> Value);
    void SetTextureParameterName(const FName Name);
    void SetCanvasRenderOpacity(const float Value);
 
    
    //UTILITY
 
    void EnableDebug();
    void DisableDebug();
    
    bool IsLayoutVisible() const;
 
    FVector2D AbsoluteToLocal(const FVector2D AbsolutePosition) const;
 
    //INPUT
    
    virtual void Rebuild(const TObjectPtr<UTouchInterfaceLayout> Layout);
    
    //virtual void Rebuild(TArray<TSharedPtr<SLayoutComponent>> WidgetComponent);
 
    virtual void SortByPriority();
 
    virtual bool GetAllTouchInputUnderLocation(TArray<TSharedPtr<SLayoutComponent>>& OutComponents, const FVector2D AbsoluteLocation);
 
protected:
    template <typename T>
    TSharedRef<T> AddComponentOfType();
 
    FMargin GenerateOffsetMargin(const FVector2D& Size, const FVector2D& Position);
    
    virtual void HandleDisplayMetricsChanged(const FDisplayMetrics& NewDisplayMetric);
 
    virtual float CalculateScaleFactor(const FGeometry& Geometry) const;
 
protected:
    TSharedPtr<SRetainerWidget> RetainerWidget;
 
    TSharedPtr<SConstraintCanvas> MainCanvas;
 
    TArray<TSharedPtr<SLayoutComponent>> Children;
 
    FOnTouchInterfaceNotification OnActiveStateChanged;
    FOnTouchInterfaceNotification OnVisibilityChanged;
 
    FOnTouchInterfaceEvent OnLayoutGenerated;
 
    TArray<TSharedPtr<SLayoutComponent>> TouchInputWidgets;
    
    float PreviousScalingFactor;
    
    FVector2D PreviousGeometrySize;
 
    FVector2D CurrentGeometrySize;
 
    uint8 bBlockTouchEvent:1;
 
    uint8 bCaptureMouse:1;
 
    uint8 bBlockInput:1;
 
    uint8 bMoveEventAllowed:1;
 
    int32 ActiveFingerCount;
 
    bool bDrawDebug;
 
    int32 DebugType;
 
#if WITH_EDITOR
    friend class STouchInterfaceLayoutEditor;
#endif
};