VirtualControlSetup.h

Go to the documentation of this file.

// Copyright 2022 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "InputAction.h"
#include "SlateFwd.h"
#include "UObject/Object.h"
#include "InputCoreTypes.h"
#include "Styling/SlateBrush.h"
#include "Sound/SoundBase.h"
#include "Curves/CurveFloat.h"
#include "Engine/Texture2D.h"
#include "Materials/MaterialInstanceDynamic.h"
#include "VirtualControlSetup.generated.h"
 
class UVirtualInput;
class UVirtualInputScalar;
class ULCInputModifier;
class SDeprecatedTouchInterface;
class UVirtualInputEvent;
 
UENUM(BlueprintType)
enum class EControlType : uint8
{
    Button,
    Joystick,
    TouchRegion UMETA(DisplayName="Touch Region")
};
 
UENUM(BlueprintType, meta=(Bitflags, UseEnumValuesAsMaskValuesInEditor="true"))
enum class ELayerType : uint8
{
    None        = 0x0,  //0
    Background  = 0x01, //1
    Thumb       = 0x02, //2
    Unpressed   = 0x04, //4
    Pressed     = 0x08, //8
    Disabled    = 0x10, //10
};
ENUM_CLASS_FLAGS(ELayerType)
 
/*UENUM(BlueprintType)
enum class ELayerState : uint8
{
    Released,
    Pressed,
    Both
};*/
 
UENUM(BlueprintType)
enum class EHitTestType : uint8
{
    Square,
    Circle
    //Alpha,
    //Custom Shape
};
 
USTRUCT(BlueprintType)
struct FVisualLayer
{
    GENERATED_BODY()
 
    
    UPROPERTY(Category="Layer", EditAnywhere, BlueprintReadWrite, meta=(ShowOnlyInnerProperties))
    FSlateBrush Brush;

    UPROPERTY(Category="Brush Settings", EditAnywhere, BlueprintReadWrite)
    uint8 bUseBrushSize:1;
 
    //Todo: Add anchor position

    UPROPERTY(Category="Transform", EditAnywhere, BlueprintReadWrite)
    FVector2D Offset;

    UPROPERTY(Category="Transform", EditAnywhere, BlueprintReadWrite)
    float Rotation;

    UPROPERTY(Category="Brush Settings", EditAnywhere, BlueprintReadWrite, meta=(Bitmask, BitmaskEnum="/Script/TouchInterface.ELayerType"))
    int32 LayerType;
 
    //UPROPERTY(Category="Layer", EditAnywhere, BlueprintReadWrite)
    UPROPERTY()
    FName ExposedLayerName;
 
    static FORCEINLINE bool Accept(int32 LayerType, TArray<ELayerType> TestLayer)
    {
        if (LayerType != (int32)ELayerType::None)
        {
            for (ELayerType Type : TestLayer)
            {
                if (LayerType & (int32)Type)
                {
                
                }
                else
                {
                    return false;
                }
            }
            return true;
        }
        return false;
    }
 
    FVisualLayer()
    : bUseBrushSize(false)
    , Offset(0.0f)
    , Rotation(0.0f)
    , LayerType(0)
    {
        
    }
    
    /*FVisualLayer(const FSlateBrush Default, const int32 InLayerType, const bool InUseBrushSize = false, const float BrushSize = 80.0f) :
    Brush(Default),
    bUseBrushSize(InUseBrushSize),
    Offset(0.0f),
    LayerType(InLayerType)
    {
        if (InUseBrushSize)
        {
            Brush.ImageSize = FVector2D(BrushSize);
        }
    }*/
 
    FVisualLayer(FName LayerName, UTexture2D* DefaultResource, const int32 InLayerType, const bool InUseBrushSize = false, const float BrushSize = 80.0f)
    : bUseBrushSize(InUseBrushSize)
    , Offset(0.0f)
    , Rotation(0.0f)
    , LayerType(InLayerType)
    , ExposedLayerName(LayerName)
    {
        Brush.SetResourceObject(DefaultResource);
        if (InUseBrushSize)
        {
            Brush.ImageSize = FVector2D(BrushSize);
        }
    }
 
    /*FVisualLayer(UMaterialInterface* DefaultResource, const int32 InLayerType, const bool InUseBrushSize = false, const float BrushSize = 80.0f) :
    bUseBrushSize(InUseBrushSize),
    Offset(0.0f),
    LayerType(InLayerType)
    {
        Brush.SetResourceObject(DefaultResource);
        if (InUseBrushSize)
        {
            Brush.ImageSize = FVector2D(BrushSize);
        }
    }*/
};
 
//Todo: Make class instead of struct ?
USTRUCT(BlueprintType)
struct FVirtualControl
{
    GENERATED_BODY()
 
    //COMMON
 
    //Todo: Add anchor position ?
    
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    FName ControlName;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, ClampMax=1.0f))
    float Opacity;
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    uint8 bStartHidden:1;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    uint8 bRecenterOnTouch:1;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    uint8 bBlockTouchRegion:1;
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    FVector2D LandscapeCenter;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    FVector2D PortraitCenter;
 
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    uint8 bAllowPositionModification:1;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    FVector4f MaxPositionOffset;
 
    // Used only in runtime configurator
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    FVector2D CurrentPositionOffset;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    uint8 bIsChild:1;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    FName ParentName;
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    FVector2D ParentOffset;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    uint8 bMoveWhenParentRecenter:1;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    TArray<FName> Children;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    uint8 bEnableBackgroundBlur:1;
 
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="bEnableBackgroundBlur == true", EditConditionHides))
    float BlurStrength;
 
    //UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="bEnableBackgroundBlur == true", EditConditionHides))
    //FSlateBrush LowQualityFallbackBrush;
 
    // Number of pixel
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="bEnableBackgroundBlur == true", EditConditionHides, ClampMin=1))
    int32 BlurRadius;
 
    // Square by default. Allow you to round corner.
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly, meta=(EditCondition="bEnableBackgroundBlur == true", EditConditionHides))
    FVector4 CornerRadius;
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    TArray<FVisualLayer> VisualLayers;
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    FVector2D VisualSize;
 
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    uint8 bAllowSizeModification:1;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    FVector2D SizeScale;
 
    // Used only in runtime configurator
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    float CurrentSizeScale;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    EHitTestType InteractionShape;
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite, meta=(EditCondition="InteractionShape==EHitTestType::Square", EditConditionHides))
    FVector2D InteractionSize;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite, meta=(ClampMin=1.0f, EditCondition="InteractionShape==EHitTestType::Circle", EditConditionHides))
    float InteractionRadiusSize;

    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadWrite)
    EControlType Type;
    
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly, Instanced)
    TArray<TObjectPtr<ULCInputModifier>> Modifiers;

    //UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly, Instanced)
    //TArray<TObjectPtr<UVirtualInputEvent>> VirtualInputEvent;
 
    UPROPERTY(Category="Virtual Control", EditAnywhere, BlueprintReadOnly)
    TArray<TSubclassOf<UVirtualInputEvent>> VirtualInputEvent;
 
    
    //BUTTON
    
    // The Input Action to use for button. Should be Digital (bool)
    UPROPERTY(Category="Virtual Control|Button", EditAnywhere, BlueprintReadWrite)
    UInputAction* ButtonAction;
 
    
    //JOYSTICK
 
    // For sticks, the size of the thumb. It's absolute
    UPROPERTY(Category="Virtual Control|Joystick", EditAnywhere, BlueprintReadWrite)
    FVector2D ThumbSize;
 
    // The Input Action to use for joystick. Should be Axis2D
    UPROPERTY(Category="Virtual Control|Joystick", EditAnywhere, BlueprintReadWrite)
    UInputAction* JoystickAction;
 
    //TODO: Implements this feature
    // Whether or not thumb position can exceed visual size (thumb appear out of background)
    UPROPERTY(Category="Virtual Control|Joystick", EditAnywhere, BlueprintReadWrite)
    uint8 bClampJoystickPosition:1;
    
 
    // TOUCH REGION

    UPROPERTY(Category="Virtual Control|Touch Region", EditAnywhere, BlueprintReadWrite)
    uint8 bJoystickMode:1;

    UPROPERTY(Category="Virtual Control|Touch Region", EditAnywhere, BlueprintReadWrite, meta=(ClampMin=0.0f, UIMin=0.0f))
    float DeltaThreshold;

    UPROPERTY(Category="Virtual Control|Touch Region", EditAnywhere, BlueprintReadWrite)
    uint8 bBlockMultitouchInput:1;
    
 
    bool IsParent() const
    {
        return Children.Num() > 0;
    }
 
    void ClearLinkData()
    {
        bIsChild = false;
        ParentName = NAME_None;
        ParentOffset = FVector2D::ZeroVector;
        bMoveWhenParentRecenter = false;
        Children.Empty();
    }

    FVirtualControl()
    : Opacity(1.0f)
    , bStartHidden(false)
    , bRecenterOnTouch(false)
    , bBlockTouchRegion(false)
    , LandscapeCenter(0.5f,0.5f)
    , PortraitCenter(0.5f,0.5f)
    , bAllowPositionModification(false)
    , MaxPositionOffset(FVector4f(0,0,0,0))
    , CurrentPositionOffset(ForceInitToZero)
    , bIsChild(false)
    , ParentOffset(ForceInitToZero)
    , bMoveWhenParentRecenter(false)
    
    , bEnableBackgroundBlur(false)
    , BlurStrength(5.0f)
    , BlurRadius(10)
    , VisualSize(60.0f,60.0f)
    , bAllowSizeModification(false)
    , SizeScale(FVector2D::UnitVector)
    , CurrentSizeScale(1.0f)
    , InteractionShape(EHitTestType::Square)
    , InteractionSize(60.0f,60.0f)
    , InteractionRadiusSize(10.0f)
    , Type(EControlType::Button)
 
    //Button
    , ButtonAction(nullptr)
    
    //Joystick
    , ThumbSize(60.0f)
    , JoystickAction(nullptr)
    , bClampJoystickPosition(true)
 
    //Touch Region
    , bJoystickMode(false)
    , DeltaThreshold(0.0f)
    , bBlockMultitouchInput(false)
    {
        ControlName = FName(TEXT("NewControl"));
    }
 
    //Construct new virtual control based on type
    explicit FVirtualControl(EControlType InType)
    : Opacity(1.0f)
    , bStartHidden(false)
    , bRecenterOnTouch(false)
    , bBlockTouchRegion(false)
    , LandscapeCenter(0.5f)
    , PortraitCenter(0.5f)
    , bAllowPositionModification(false)
    , MaxPositionOffset(FVector4f(0,0,0,0))
    , CurrentPositionOffset(ForceInitToZero)
    , bIsChild(false)
    , ParentOffset(ForceInitToZero)
    , bMoveWhenParentRecenter(false)
    , bEnableBackgroundBlur(false)
    , BlurStrength(5.0f)
    , BlurRadius(10)
    , bAllowSizeModification(false)
    , SizeScale(FVector2D::UnitVector)
    , CurrentSizeScale(1.0f)
    , InteractionShape(EHitTestType::Square)
    , Type(InType)
 
    //Button
    , ButtonAction(nullptr)
 
    //Joystick
    , ThumbSize(60.0f)
    , JoystickAction(nullptr)
    , bClampJoystickPosition(true)
 
    //Touch Region
    , bJoystickMode(false)
    , DeltaThreshold(0.0f)
    , bBlockMultitouchInput(false)
    {
        switch (InType)
        {
        case EControlType::Button:
            ControlName = FName(TEXT("NewButton"));
            VisualSize = FVector2D(60.0f);
            InteractionSize = FVector2D(60.0f);
            InteractionRadiusSize = 30.0f;
            break;
        case EControlType::Joystick:
            ControlName = FName(TEXT("NewJoystick"));
            VisualSize = FVector2D(100.0f);
            InteractionSize = FVector2D(60.0f);
            InteractionRadiusSize = 50.0f;
            break;
        case EControlType::TouchRegion:
            ControlName = FName(TEXT("NewTouchRegion"));
            InteractionSize = FVector2D(300.0f, 300.0f);
            InteractionRadiusSize = 150.0f;
            break;
        }
    }
};
 
UCLASS(BlueprintType)
class TOUCHINTERFACE_API UVirtualControlSetup : public UObject
{
    GENERATED_BODY()
 
    UVirtualControlSetup();
 
public:
    // Contain all data for virtual controls
    UPROPERTY(Category="Virtual Control Setup|Virtual Control", EditAnywhere, BlueprintReadOnly)
    TArray<FVirtualControl> VirtualControls;
    
    
    // Opacity (0.0 - 1.0) of all virtual controls while touch interface is active
    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, ClampMax=1.0f, UIMin=0.0f, UIMax=1.0f))
    float ActiveOpacity;
 
    // Opacity (0.0 - 1.0) of all virtual controls while touch interface is inactive (no interaction)
    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, ClampMax=1.0f, UIMin=0.0f, UIMax=1.0f))
    float InactiveOpacity;
 
    // Speed at which active opacity is reached
    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.1f, UIMin=0.1f))
    float ActiveLerpRate;
 
    // Speed at which inactive opacity is reached
    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.1f, UIMin=0.1f))
    float InactiveLerpRate;
 
    // How long after user interaction will all virtual controls fade out to Inactive Opacity
    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float TimeUntilDeactivated;

    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float TimeUntilReset;

    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.0f, UIMin=0.0f))
    float ActivationDelay;

    UPROPERTY(Category="Virtual Control Setup|General Settings", EditAnywhere, BlueprintReadOnly, meta=(ClampMin=0.016f, UIMin=0.016f))
    float StartupDelay;
 
#if WITH_EDITOR
    // Return type of current selected control
    EControlType GetSelectedControlType() const;
    
    // return index of current selected control
    int32 GetSelectedControlIndex() const { return CurrentSelectedControlIndex; }
 
    FName GetUniqueName(const EControlType ControlType);
 
    void SetSelectedControlIndex(const int32 Index);
 
    int32 SelectLastControl();
 
    FVirtualControl GetSelectedControl() const;
 
    FVirtualControl& GetVirtualControlRef(const FName Name);
 
    FVirtualControl GetVirtualControlByName(const FName Name);
 
    
//LAYER
 
    int32 GetCurrentSelectedLayerIndex() const { return CurrentSelectedLayerIndex; }
 
    void SetSelectedLayerIndex(const int32 Index) { CurrentSelectedLayerIndex = Index; }
    bool SetSelectedLayerByName(const FName LayerName);
    
    FVisualLayer GetCurrentSelectedLayer() const;
 
    //bool GetVisualLayerByName(const FName ControlName, const FName LayerName, FVisualLayer& OutVisualLayer);
    //bool GetVisualLayerByIndex(const FName ControlName, const int32 LayerIndex, FVisualLayer& OutVisualLayer);
 
    FName GetUniqueLayerName(FName VirtualControlName);
 
private:
    bool DoesThisNameExistInControl(const FName OtherName);
    bool DoesThisNameExistInVisualLayers(const TArray<FVisualLayer> VisualLayers, const FName OtherName);
 
    int32 GetUniqueId(const EControlType Type);
    int32 GetLastIndex() const;
    
    // Return -1 if not found
    int32 GetControlIndexByName(const FName Name);
    
    int32 CurrentSelectedControlIndex;
    EControlType CurrentSelectedControlType;
 
    int32 CurrentSelectedLayerIndex;
#endif
};