TouchInterfaceSettings.h

Go to the documentation of this file.

// Copyright Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
//#include "CoreMinimal.h"
#include "Engine/DeveloperSettings.h"
#include "Runtime/Launch/Resources/Version.h"
#include "TouchInterfaceSettings.generated.h"
 
class UVirtualShapeDrawer;
class UVirtualControlSetup;
class UVirtualShape;
 
/*UENUM()
enum class EInputMode
{
    //Only gamepad respond to input. Touch Interface and other widget do not respond to input
    GameOnly,
 
    //Only UI respond to input. Gamepad, keyboard or mouse do not respond to input.
    UIOnly,
 
    //UI respond first to input. If UI do not intercept input, gamepad, keyboard or mouse has a chance.
    GameAndUI
};*/
 
USTRUCT(BlueprintType)
struct FGesturesConfig
{
    GENERATED_BODY()
 
    
    UPROPERTY(Category="Tap", EditDefaultsOnly)
    float TapTime;
    
    UPROPERTY(Category="Long Press", EditDefaultsOnly)
    float LongPressDuration;

    UPROPERTY(Category="Long Press", EditDefaultsOnly)
    float MovementThreshold;

    UPROPERTY(Category="Drag", EditDefaultsOnly)
    uint8 bSendDragAfterLongPress:1;

    UPROPERTY(Category="Drag", EditDefaultsOnly)
    uint8 bBlockDragIfSlideIsDetected:1;

    UPROPERTY(Category="Swipe", EditDefaultsOnly, meta=(ClampMin=0.8f, ClampMax=1.0f))
    float DirectionThreshold;
    
    UPROPERTY(Category="Swipe", EditDefaultsOnly)
    float SwipeThreshold;

    UPROPERTY(Category="Swipe", EditDefaultsOnly)
    float SwipeVelocityThreshold;
 
    //TODO: Block Swipe if long press is detected

    UPROPERTY(Category="Two Finger Swipe", EditDefaultsOnly)
    float TwoFingerSwipeClosenessThreshold;

    UPROPERTY(Category="Zoom", EditDefaultsOnly)
    float MinimumDeltaToSendEvent;

    UPROPERTY(Category="Zoom", EditDefaultsOnly)
    uint8 bSendDragEventWhenZoomOrRotateGestureDetected:1;
 
    FGesturesConfig()
    : TapTime(0.18f)
    , LongPressDuration(0.8f)
    , MovementThreshold(10.0f)
    , bSendDragAfterLongPress(false)
    , bBlockDragIfSlideIsDetected(false)
    , DirectionThreshold(0.98f)
    , SwipeThreshold(500.0f)
    , SwipeVelocityThreshold(3000.0f)
    , TwoFingerSwipeClosenessThreshold(200.0f)
    , MinimumDeltaToSendEvent(1.0f)
    , bSendDragEventWhenZoomOrRotateGestureDetected(false)
    {
        
    }
};
 
UENUM(BlueprintType, meta=(Bitflags, UseEnumValuesAsMaskValuesInEditor="true"))
enum class EDebugType : uint8
{
    None                = 0x0 UMETA(Hidden),    // 0
    Outline             = 0x01,                 // 1
    HitBox              = 0x02,                 // 2
    ComponentName       = 0x04,                 // 4
    ComponentSize       = 0x08,                 // 8
    ComponentCenter     = 0x10,                 // 16
    Pivot               = 0x20,                 // 32
    FingerLocation      = 0x40                  // 64
};
ENUM_CLASS_FLAGS(EDebugType)
 
UENUM()
enum class EScalingMode
{
    // No scaling
    NONE UMETA(DisplayName="Disabled"),
 
    // Use desktop DPI Curve based on geometry size
    DPI UMETA(DisplayName="Desktop DPI Curve"),
 
    // Scaling the touch interface based on the reference design size (DesiredWidth)
    DesignSize,
 
    // Use your own scaling algorithm
    Custom
    
    //Mobile DPI Curve based on viewport size
};
 
/*UENUM()
enum class EScaleSide
{
    // Use the shortest side for DPI Curve or Design Size based scaling
    ShortestSide,
 
    // Use the longest side for DPI Curve or Design Size based scaling
    LargestSide,
 
    // Use the X-axis of geometry (viewport) for DPI Curve or Design Size based scaling
    Horizontal,
 
    // Use the Y-axis of geometry (viewport) for DPI Curve or Design Size based scaling
    Vertical
};*/

UCLASS(Config=Engine, defaultConfig, meta=(DisplayName="Touch Interface"))
class TOUCHINTERFACE_API UTouchInterfaceSettings : public UDeveloperSettings
{
    GENERATED_BODY()
    
public:
    UTouchInterfaceSettings();
 
#if WITH_EDITOR
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
#endif
 
    float GetScaleFactor(const FVector2D Size, const float LayoutScale = 1.0f, const bool InEditorMode = true) const;
 
    bool CustomScalingClassIsValid() const { return CustomTouchInterfaceScalingInstance != nullptr; }
 
    // Get the resolution size associated with a key whose value is equal to scale
    bool GetResolutionSizeFromDpiCurveScale(const float Scale, float& ResolutionSize) const;
 
    bool UseEnhancedInput() const;
    
 
    //Todo: Use SoftObjectPtr with no empty feature and make a basic interface by default
    // In case you forget to fill in an interface in the TouchDesignerController, it will use this one by default
    UPROPERTY(Category="General", Config, EditAnywhere, meta=(AllowedClasses="/Script/TouchInterface.VirtualControlSetup"))
    FSoftObjectPath DefaultVirtualControlSetup;
 
    // Should touch interface be shown in desktop platform
    UPROPERTY(Category="General", Config, EditAnywhere)
    bool bShowInDesktopPlatform;
 
    //If enabled, the subsystem remove touch interface from player screen automatically on level load
    UPROPERTY(Category="General", EditAnywhere, Config)
    bool bAutomaticallyRemoveOnLevelLoad;

    UPROPERTY(Category="General", Config, EditAnywhere)
    int32 ZOrder;
 
    
    // Max layer to draw for one virtual input
    UPROPERTY(Category="Visual Layer", Config, EditAnywhere)
    int32 MaxLayer;
 
    
    // Max layer to draw per component decorator (Aka per component)
    UPROPERTY(Category="Decorator", EditAnywhere, Config)
    int32 MaxLayerPerComponentDecorator;
 
    
    // Scaling Mode
    UPROPERTY(Category="Scaling", Config, EditAnywhere)
    EScalingMode ScalingMode;
    
    // The design width of Touch interface used as reference for scaling calculation in DesignSize mode
    UPROPERTY(Category="Scaling", Config, EditAnywhere, meta=(EditCondition="ScalingMode == EScalingMode::DesignSize", EditConditionHides))
    float DesignWidth;

    //UPROPERTY(Config, EditAnywhere, Category="Scaling", meta=(EditCondition="ScalingMode == EScalingMode::DesignSize", EditConditionHides))
    //EScaleSide ScaleSideRule;
    
    //UPROPERTY(Config, EditAnywhere, Category="Scaling", meta=(EditCondition="ScalingMode == EScalingMode::DPI", EditConditionHides))
    //FRuntimeFloatCurve TouchInterfaceScaleCurve;
 
    //Todo: Use TSoftClassPtr with NoClear meta
    // This class will be used for touch interface scaling.
    UPROPERTY(Category="Scaling", config, EditAnywhere, meta=(MetaClass="/Script/TouchInterface.CustomTouchInterfaceScaling", EditCondition="ScalingMode == EScalingMode::Custom", EditConditionHides))
    FSoftClassPath CustomTouchInterfaceScalingClass;

    UPROPERTY(Category="Scaling", Config, EditAnywhere)
    float ScaleMultiplier;

    UPROPERTY(Category="Input", Config, EditAnywhere)
    bool bBlockTouchEvent;

    UPROPERTY(Category="Input", Config, EditAnywhere)
    bool bCaptureMouse;

    UPROPERTY(Category="Touch Interface Listener", EditAnywhere, Config)
    bool bSendInputEvenIfTouchInputIsHit;
 
    //TODO: Remove this
    // Enable the recognition of gestures
    UPROPERTY(Category="Gestures Recognizer", Config, EditAnywhere)
    bool bEnableGestureRecognizer;
 
    // This is the default gestures config used in Gesture Manager Component
    UPROPERTY(Category="Gestures Recognizer", Config, EditAnywhere, meta=(EditCondition="bEnableGestureRecognizer", EditConditionHides))
    FGesturesConfig DefaultGesturesConfig;
 
    //TODO: Remove this
    // EXPERIMENTAL! Enable detection of user-drawn shapes
    UPROPERTY(Category="Shape Recognizer", Config, EditAnywhere)
    bool bEnableShapeRecognizer;
 
    UPROPERTY(Category="Shape Recognizer", Config, EditAnywhere, meta=(EditCondition="bEnableShapeRecognizer", EditConditionHides, ClampMin=0.1f, ClampMax=1.0f))
    float CornerDetectionThreshold;
 
    float ShapeDotDistance;
    
    UPROPERTY(Category="Shape Recognizer", Config, EditAnywhere, meta=(EditCondition="bEnableShapeRecognizer", EditConditionHides, ClampMin=0.1f, ClampMax=1.0f))
    int32 MaxPoint;
 
    //TODO: Implement
    // Default shape recognized by all shape recognizer components
    //UPROPERTY(Category="Shape Recognizer", Config, EditAnywhere, meta=(AllowedClasses="/Script/TouchInterface.VirtualShape", EditCondition="bEnableShapeRecognizer", EditConditionHides))
    //TArray<FSoftObjectPath> DefaultVirtualShapes;
    
    UPROPERTY(Category="Shape Recognizer", Config, EditAnywhere, meta=(EditCondition="bEnableShapeRecognizer", EditConditionHides))
    uint8 bUseTimer:1;
    
    UPROPERTY(Category="Shape Recognizer", Config, EditAnywhere, meta=(AllowedClasses="/Script/TouchInterface.VirtualShape", EditCondition="bEnableShapeRecognizer", EditConditionHides))
    float DelayBetweenEndDrawAndComputation;
 
    UPROPERTY(Category="Shape Recognizer", Config, EditAnywhere, meta=(EditCondition="bEnableShapeRecognizer", EditConditionHides))
    float MinMatchingScoreToTriggerEvent;
    
 
    // EXPERIMENTAL! Enable detection of device movements based on gyroscope data
    UPROPERTY(Category="Motion Recognizer", Config, EditAnywhere)
    uint8 bEnableMotionRecognizer:1;
 
    
    UPROPERTY( Category="Gamepad", Config, EditAnywhere)
    bool bHideTouchInterfaceWhenGamepadIsConnected;

    /*UPROPERTY( Category="Gamepad", Config, EditAnywhere)
    bool bOverrideInputMode;*/
    
    // Base input mode when gamepad is disconnected
    /*UPROPERTY( Category="Gamepad", Config, EditAnywhere, meta=(EditCondition="bOverrideInputMode==true"))
    EInputMode BaseInputMode;*/
 
    // Input mode set when gamepad is connected to device
    /*UPROPERTY( Category="Gamepad", Config, EditAnywhere, meta=(EditCondition="bOverrideInputMode==true"))
    EInputMode GamepadInputMode;*/
    
    
    // Slot name for saved configuration of Touch Interface at runtime
    UPROPERTY(Category="Build-in Save System", Config, EditAnywhere, BlueprintReadOnly)
    FString SaveSlotName;
    
 
    
    UPROPERTY( Category="Debugging", Config, EditAnywhere)
    bool bDrawDebug;
 
    // Show some information for debugging like Fingers position, component name, hit box, size, etc.
    UPROPERTY(Category="Debugging", Config, EditAnywhere, BlueprintReadOnly, meta=(Bitmask, BitmaskEnum="/Script/TouchInterface.EDebugType"), meta=(EditCondition="bDrawDebug", EditConditionHides))
    int32 DebugType;
 
    // Opacity of debug information
    UPROPERTY(Category="Debugging", Config, EditAnywhere, meta=(ClampMin=0.0f, UIMin=0.0f, ClampMax=1.0f, UIMax=1.0f), meta=(EditCondition="bDrawDebug", EditConditionHides))
    float DebugOpacity;
 
 
private:
    TObjectPtr<class UCustomTouchInterfaceScaling> CustomTouchInterfaceScalingInstance;
};