GestureRecognizerComp.h

Go to the documentation of this file.

// Copyright 2022 Lost in Game Studio. All Rights Reserved.
 
#pragma once
 
//#include "CoreMinimal.h"
#include "Listeners/TouchInterfaceListener.h"
#include "Settings/TouchInterfaceSettings.h"
#include "Components/ActorComponent.h"
#include "Layout/Geometry.h"
#include "Input/Events.h"
//#include "Gestures/GestureBase.h"
#include "GestureRecognizerComp.generated.h"
 
//class UGestureBase;
 
class UGestureBase;
 
enum class ETouchMode : uint8
{
    SingleTouch,

    DoubleTouch,

    MultiTouch
};

UENUM()
enum class EMultiTouchBehavior : uint8
{
    DoNothing,

    KeepExistingIndex,

    KeepFirstAndUpdateLast,

    UpdateBoth
};
 
UENUM(BlueprintType)
enum class ESwipeDirection : uint8
{
    Custom,
    Up,
    Right,
    Down,
    Left,
    RightUp,
    RightDown,
    LeftUp,
    LeftDown
};
 
UENUM(BlueprintType)
enum class ESlideDirection : uint8
{
    Horizontal,
    Vertical
};
 
USTRUCT(BlueprintType)
struct FSwipeData
{
    GENERATED_BODY()
 
    UPROPERTY(Category="Swipe Data", BlueprintReadOnly)
    ESwipeDirection Direction;
 
    UPROPERTY(Category="Swipe Data", BlueprintReadOnly)
    FVector2D BeginPosition;
    
    UPROPERTY(Category="Swipe Data", BlueprintReadOnly)
    FVector2D EndPosition;
 
    UPROPERTY(Category="Swipe Data", BlueprintReadOnly)
    FVector2D CustomDirection;
 
    UPROPERTY(Category="Swipe Data", BlueprintReadOnly)
    FVector2D Offset;
 
    UPROPERTY(Category="Swipe Data", BlueprintReadOnly)
    float Velocity;
 
    UPROPERTY(Category="Swipe Data", BlueprintReadOnly)
    float Duration;
 
    FSwipeData() :
    Direction(ESwipeDirection::Down),
    BeginPosition(ForceInitToZero),
    EndPosition(ForceInitToZero),
    CustomDirection(ForceInitToZero),
    Offset(ForceInitToZero),
    Velocity(0.0f),
    Duration(0.0f)
    {
        
    }
};
 
struct FFingerData
{
    uint32 PointerIndex;
    
    double LastTapTime;
    int32 TapAmount;
    float PressDuration;
    double TouchStartTime;
    double TouchEndTime;
    double StartTapTime;
    double AccumulatedTime;
    
    FVector2D BeginPosition;
    FVector2D CurrentPosition;
    FVector2D LastPosition;
    FVector2D OffsetFromBegin;
    FVector2D LastTapPosition;
 
    bool AcceptPointerIndex(const uint32 InPointerIndex) const
    {
        return PointerIndex == InPointerIndex;
    }
 
    FFingerData()
    : PointerIndex(-1)
    , LastTapTime(0.0f)
    , TapAmount(0)
    , PressDuration(0.0f)
    , TouchStartTime(0.0f)
    , TouchEndTime(0.0f)
    , StartTapTime(0.0f)
    , AccumulatedTime(0.0f)
    , BeginPosition(ForceInitToZero)
    , LastPosition(ForceInitToZero)
    , OffsetFromBegin(ForceInitToZero)
    , bActive(false)
    , bDetected(false)
    , bFirstTouchDetected(false)
    , bDoubleTapDetected(false)
    , bLongPressDetected(false)
    , bDragDetected(false)
    , bFirstTapSend(false)
    , bSlideDetected(false)
    , bSlideVertically(false)
    , bBlockDrag(false)
    {
        FMemory::Memzero(this, sizeof(*this));
    }
    
private:
    friend class UGestureRecognizerComp;

    uint8 bActive:1;
    
    uint8 bDetected:1;
    uint8 bFirstTouchDetected:1;
    uint8 bDoubleTapDetected:1;
    uint8 bLongPressDetected:1;
    uint8 bDragDetected:1;
    uint8 bFirstTapSend:1;
    uint8 bSlideDetected:1;
    uint8 bSlideVertically:1;
    uint8 bBlockDrag:1;
    
    FTimerHandle TapHandle;
    
    void Reset()
    {
        PointerIndex = -1;
        TapAmount = 0;
        LastTapTime = 0.0f;
        PressDuration = 0.0f;
        TouchStartTime = 0.0f;
        AccumulatedTime = 0.0f;
        BeginPosition = FVector2D::ZeroVector;
        LastPosition = FVector2D::ZeroVector;
        OffsetFromBegin = FVector2D::ZeroVector;
        LastTapPosition = FVector2D::ZeroVector;
        bDetected = false;
        bFirstTouchDetected = false;
        bDoubleTapDetected = false;
        bLongPressDetected = false;
        bDragDetected = false;
        bActive = false;
    }
 
    void ResetTapData()
    {
        TapAmount = 0;
        LastTapTime = 0.0f;
        AccumulatedTime = 0.0f;
        LastTapPosition = FVector2D::ZeroVector;
        bDoubleTapDetected = false;
    }
};
 
USTRUCT(BlueprintType)
struct FTouch
{
    GENERATED_BODY()
 
    UPROPERTY(Category="Touch", BlueprintReadOnly)
    int32 FingerIndex;
 
    UPROPERTY(Category="Touch", BlueprintReadOnly)
    double StartTime;
 
    UPROPERTY(Category="Touch", BlueprintReadOnly)
    double PressDuration;
 
    UPROPERTY(Category="Touch", BlueprintReadOnly)
    FVector2D BeginLocation;
 
    UPROPERTY(Category="Touch", BlueprintReadOnly)
    FVector2D Location;
 
    UPROPERTY(Category="Touch", BlueprintReadOnly)
    FVector2D OffsetFromStart;
 
    UPROPERTY(Category="Touch", BlueprintReadOnly)
    FVector2D Delta;
 
    FTouch()
    : FingerIndex(-1)
    , StartTime(0.0f)
    , PressDuration(0.0f)
    , BeginLocation(ForceInitToZero)
    , Location(ForceInitToZero)
    , OffsetFromStart(ForceInitToZero)
    , Delta(ForceInitToZero)
    {
        
    }
 
    explicit FTouch(const FFingerData& FingersData)
    : FingerIndex(FingersData.PointerIndex)
    , StartTime(FingersData.TouchStartTime)
    , PressDuration(FingersData.PressDuration)
    , BeginLocation(FingersData.BeginPosition)
    , Location(FingersData.CurrentPosition)
    , OffsetFromStart(FingersData.OffsetFromBegin)
    {
        Delta.X = FingersData.LastPosition.X - FingersData.CurrentPosition.X;
        //Invert Y
        Delta.Y = (FingersData.LastPosition.Y - FingersData.CurrentPosition.Y) * -1.0f;
    }
};
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSimpleGestureSignature, int32, FingerIndex, FVector2D, Location);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FOnComplexGesture, float, Delta, float, CurrentOffset, FVector2D, Direction);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSwipeGestureSignature, int32, FingerIndex, FSwipeData, SwipeData);
 
DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnMultiTouchSignature, FTouch, Touch, FVector2D, AveragePosition);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_ThreeParams(FOnMultiTapSignature, int32, FingerIndex, int32, TapAmount, FVector2D, Location);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnDragSignature, FTouch, Touch);
DECLARE_DYNAMIC_MULTICAST_DELEGATE_FourParams(FOnSlideSignature, int32, FingerIndex, ESlideDirection, Direction, FVector2D, Location, float, Delta);

UCLASS(ClassGroup=(TouchInterfaceDesigner), meta=(BlueprintSpawnableComponent, DisplayName="Gesture Recognizer"))
class TOUCHINTERFACE_API UGestureRecognizerComp : public UTouchInterfaceListener
{
    GENERATED_BODY()
 
public:
    UGestureRecognizerComp();
 
protected:
    virtual void BeginPlay() override;
 
public:
    virtual bool OnTouchStarted(const int32 FingerIndex, const FVector2D Location) override;
    virtual void OnTouchMoved(const int32 FingerIndex, const FVector2D Location) override;
    virtual void OnTouchEnded(const int32 FingerIndex, const FVector2D Location) override;
    
    virtual void TickComponent(float DeltaTime, ELevelTick TickType, FActorComponentTickFunction* ThisTickFunction) override;
 
private:
    virtual void TapGesture(FFingerData& FingerData, FVector2D Location);
    virtual void SlideGesture(FFingerData& FingerData, FVector2D Location);
    virtual void DragGesture(FFingerData& FingerData, FVector2D Location);
    virtual void SwipeGesture(FFingerData& FingerData, FVector2D Location);
    virtual void ZoomGesture(FFingerData& FirstFinger, FFingerData& SecondFinger);
    virtual void RotateGesture(FFingerData& FirstFinger, FFingerData& SecondFinger);
 
    virtual void TwoFingerSwipe(FFingerData& FirstFinger, FFingerData& SecondFinger);
    virtual void TwoFingerTap(FFingerData& FirstFinger, FFingerData& SecondFinger);
 
public:
    virtual void HandleOnOrientationChanged() override;

    UFUNCTION(Category="Gesture Manager", BlueprintCallable, BlueprintPure)
    bool IsThereAnActiveFinger();

    UFUNCTION(Category="Gesture Manager", BlueprintCallable, BlueprintPure)
    int32 GetActiveFingerCount();

    UFUNCTION(Category="Gesture Manager", BlueprintCallable, BlueprintPure)
    TArray<FVector2D> GetFingerPositions();

    UFUNCTION(Category="Gesture Manager", BlueprintCallable, BlueprintPure)
    FVector2D GetFingerAveragePosition();
    
    //TODO: Change mode, warning! reset all data
    
private:
    void ResetGesture();
 
    TArray<int32> GetActiveFingerIndex();
 
    bool GetLastTwoActiveFinger(int32& First, int32& Second);
 
    bool GetLastFingerTouchingScreen(int32& FingerIndex);
    
    
    UPROPERTY(Category="General", EditAnywhere, BlueprintReadWrite, meta=(AllowPrivateAccess="true"))
    uint8 bEnableTwoFingerGesture:1;

    UPROPERTY(Category="General", EditAnywhere, BlueprintReadWrite, meta=(AllowPrivateAccess="true"))
    EMultiTouchBehavior MultiTouchBehavior;
 
    UPROPERTY(Category="Gesture Config", EditAnywhere, BlueprintReadWrite, meta=(AllowPrivateAccess="true"))
    uint8 bOverrideGestureConfig:1;
 
    UPROPERTY(Category="Gesture Config", EditAnywhere, BlueprintReadWrite, meta=(AllowPrivateAccess="true", EditCondition="bOverrideGestureConfig", EditConditionHides))
    FGesturesConfig GesturesConfig;
 
    //Add any gestures you wish to recognize.
    UPROPERTY(Category="General", EditAnywhere, BlueprintReadWrite, Instanced, meta=(AllowPrivateAccess="true"))
    TArray<TObjectPtr<UGestureBase>> Gestures;
 
public:
    //EVENTS
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSimpleGestureSignature OnTouchBegin;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSimpleGestureSignature OnTouchMove;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSimpleGestureSignature OnTouchEnd;
 
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnMultiTouchSignature OnMultiTouch;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSimpleGestureSignature OnTap;

    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSimpleGestureSignature OnTwoFingerTap;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSimpleGestureSignature OnDoubleTap;

    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnMultiTapSignature OnMultiTap;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSimpleGestureSignature OnLongPress;

    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnDragSignature OnDragBegin;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnDragSignature OnDrag;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnDragSignature OnDragEnd;

    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSlideSignature OnSlide;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSwipeGestureSignature OnSwipe;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnSwipeGestureSignature OnTwoFingerSwipe;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnComplexGesture OnZoom;
    
    UPROPERTY(Category="Gesture Manager|Gestures", BlueprintAssignable)
    FOnComplexGesture OnRotate;
    
private:
    FGesturesConfig Config;
    
    TArray<FFingerData> GestureData;
 
    //TArray<FGestureData> SavedGestureData;
 
    ETouchMode CurrentTouchMode;
    
    double CurrentTime;
 
    FVector2D StartDirection;
    
    int32 GestureFirstIndex;
    int32 GestureSecondIndex;
 
    uint8 bTwoFingerGestureDetected:1;
 
    float StartOffsetBetweenFinger;
    float LastZoomOffset;
    float LastRotationOffset;
    
    float TotalRotationAngle;
};