NavigationConfig.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "InputCoreTypes.h"
#include "Input/Events.h"
 
struct FKeyEvent;
enum class EUINavigation : uint8;
 
/* Since we now support multiple analog values driving the same navigation axis,
 * we need to key their repeat-state by both FKey and EUINavigation */
struct FAnalogNavigationKey
{
    FKey AnalogKey;
    EUINavigation NavigationDir;
 
    FAnalogNavigationKey(const FKey& InKey, const EUINavigation InNavDir)
        : AnalogKey(InKey)
        , NavigationDir(InNavDir)
    {}
 
    bool operator==(const FAnalogNavigationKey& Rhs) const
    {
        return     AnalogKey == Rhs.AnalogKey
            && NavigationDir == Rhs.NavigationDir;
    }
 
    friend uint32 GetTypeHash(const FAnalogNavigationKey& InAnalogNavKey)
    {
        const uint32 KeyHash = GetTypeHash(InAnalogNavKey.AnalogKey);
        const uint32 NavDirHash = GetTypeHash(InAnalogNavKey.NavigationDir);
        return HashCombine(KeyHash, NavDirHash);
    }
};
 
struct FAnalogNavigationState
{
    double LastNavigationTime;
    int32 Repeats;
 
    FAnalogNavigationState()
        : LastNavigationTime(0)
        , Repeats(0)
    {
    }
};
 
struct FUserNavigationState
{
public:
    TMap<FAnalogNavigationKey, FAnalogNavigationState> AnalogNavigationState;
};
 
class FNavigationConfig : public TSharedFromThis<FNavigationConfig>
{
public:
    SLATE_API FNavigationConfig();
    SLATE_API virtual ~FNavigationConfig();
 
    SLATE_API virtual EUINavigation GetNavigationDirectionFromKey(const FKeyEvent& InKeyEvent) const;
    SLATE_API virtual EUINavigation GetNavigationDirectionFromAnalog(const FAnalogInputEvent& InAnalogEvent);
 
    SLATE_API virtual void OnRegister();
    SLATE_API virtual void OnUnregister();
    SLATE_API virtual void OnUserRemoved(int32 UserIndex);
 
    virtual void OnNavigationChangedFocus(TSharedPtr<SWidget> OldWidget, TSharedPtr<SWidget> NewWidget, FFocusEvent FocusEvent) {}
 
    SLATE_API virtual EUINavigationAction GetNavigationActionFromKey(const FKeyEvent& InKeyEvent) const;
 
    UE_DEPRECATED(4.24, "GetNavigationActionForKey doesn't handle multiple users properly, use GetNavigationActionFromKey instead")
    SLATE_API virtual EUINavigationAction GetNavigationActionForKey(const FKey& InKey) const;
 
    SLATE_API virtual FString ToString() const;
 
    bool IsAnalogEventBeyondNavigationThreshold(const FAnalogInputEvent& InAnalogEvent) const;
 
public:
    bool bTabNavigation;
    bool bKeyNavigation;
    bool bAnalogNavigation;
    bool bIgnoreModifiersForNavigationActions;
 
    float AnalogNavigationHorizontalThreshold;
    float AnalogNavigationVerticalThreshold;
 
    FKey AnalogHorizontalKey;
    FKey AnalogVerticalKey;
 
    TMap<FKey, EUINavigation> KeyEventRules;
 
    TMap<FKey, EUINavigationAction> KeyActionRules;
 
protected:
    SLATE_API virtual float GetRepeatRateForPressure(float InPressure, int32 InRepeats) const;
 
    SLATE_API virtual EUINavigation GetNavigationDirectionFromAnalogInternal(const FAnalogInputEvent& InAnalogEvent);
 
    virtual bool IsAnalogHorizontalKey(const FKey& InKey) const { return InKey == AnalogHorizontalKey; }
    virtual bool IsAnalogVerticalKey  (const FKey& InKey) const { return InKey == AnalogVerticalKey;   }
 
    TMap<int, FUserNavigationState> UserNavigationState;
};
 
 
class FNullNavigationConfig : public FNavigationConfig
{
public:
    FNullNavigationConfig()
    {
        bTabNavigation = false;
        bKeyNavigation = false;
        bAnalogNavigation = false;
    }
};
 
class FTwinStickNavigationConfig : public FNavigationConfig
{
public:
    SLATE_API FTwinStickNavigationConfig();
    
protected:
    SLATE_API virtual bool IsAnalogHorizontalKey(const FKey& InKey) const override;
    SLATE_API virtual bool IsAnalogVerticalKey(const FKey& InKey) const override;
};