InputChord.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "GenericPlatform/GenericApplication.h"
#include "InputCoreTypes.h"
#include "Internationalization/Text.h"
#include "Misc/Optional.h"
#include "UObject/ObjectMacros.h"
 
#include "InputChord.generated.h"
 
struct FInputChord;
 
// Was supposed to be deprecated in 4.8, but was never properly marked up
UE_DEPRECATED(4.21, "Use FInputChord instead of FInputGesture") 
typedef struct FInputChord FInputGesture;
 
USTRUCT(BlueprintType)
struct FInputChord
{
    GENERATED_USTRUCT_BODY()
 
    
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Key)
    FKey Key;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Modifier)
    uint32 bShift:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Modifier)
    uint32 bCtrl:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Modifier)
    uint32 bAlt:1;
 
    UPROPERTY(EditAnywhere, BlueprintReadWrite, Category = Modifier)
    uint32 bCmd:1;
 
    enum class ERelationshipType
    {
        None,
        Same,
        Masked,
        Masks
    };
 
    SLATE_API ERelationshipType GetRelationship(const FInputChord& OtherChord) const;
 
    SLATE_API FInputChord();
 
    FInputChord(const FKey InKey)
        : Key(InKey)
        , bShift(false)
        , bCtrl(false)
        , bAlt(false)
        , bCmd(false)
    {
    }
 
    FInputChord(const FKey InKey, const bool bInShift, const bool bInCtrl, const bool bInAlt, const bool bInCmd)
        : Key(InKey)
        , bShift(bInShift)
        , bCtrl(bInCtrl)
        , bAlt(bInAlt)
        , bCmd(bInCmd)
    {
    }
 
    FInputChord( const EModifierKey::Type InModifierKeys, const FKey InKey )
        : Key(InKey)
        , bShift((InModifierKeys & EModifierKey::Shift) !=0)
        , bCtrl((InModifierKeys & EModifierKey::Control) != 0)
        , bAlt((InModifierKeys & EModifierKey::Alt) != 0)
        , bCmd((InModifierKeys & EModifierKey::Command) != 0)
    {
    }
 
    FInputChord( const FKey InKey, const EModifierKey::Type InModifierKeys )
        : Key(InKey)
        , bShift((InModifierKeys & EModifierKey::Shift) !=0)
        , bCtrl((InModifierKeys & EModifierKey::Control) != 0)
        , bAlt((InModifierKeys & EModifierKey::Alt) != 0)
        , bCmd((InModifierKeys & EModifierKey::Command) != 0)
    {
    }
 
    FInputChord(const FInputChord& Other) = default;
 
    FInputChord(FInputChord&& Other) = default;
 
    FInputChord& operator=(const FInputChord& Other) = default;
 
    FInputChord& operator=(FInputChord&& Other) = default;
 
    bool operator==(const FInputChord& Other) const
    {
        return (   Key == Other.Key
                && bShift == Other.bShift
                && bCtrl == Other.bCtrl
                && bAlt == Other.bAlt
                && bCmd == Other.bCmd);
    }
 
    bool operator!=( const FInputChord& Other ) const
    {
        return !(*this == Other);
    }
 
#if PLATFORM_MAC
    bool NeedsControl() const { return bCmd; }
    bool NeedsCommand() const { return bCtrl; }
#else
    bool NeedsControl() const { return bCtrl; }
    bool NeedsCommand() const { return bCmd; }
#endif
    bool NeedsAlt() const { return bAlt; }
    bool NeedsShift() const { return bShift; }
 
    SLATE_API FText GetInputText(const bool bLongDisplayName = true) const;
    
    SLATE_API FText GetKeyText(const bool bLongDisplayName = true) const;
 
    SLATE_API FText GetModifierText(TOptional<FText> ModifierAppender = TOptional<FText>()) const;
 
    bool HasAnyModifierKeys( ) const
    {
        return (bAlt || bCtrl || bCmd || bShift);
    }
 
    bool IsValidChord( ) const
    {
        return (Key.IsValid() && !Key.IsModifierKey());
    }
 
    void Set( const FInputChord& InTemplate )
    {
        *this = InTemplate;
    }
 
public:
 
    friend uint32 GetTypeHash( const FInputChord& Chord )
    {
        return GetTypeHash(Chord.Key) ^ (Chord.bShift | Chord.bCtrl << 1 | Chord.bAlt << 2 | Chord.bCmd << 3);
    }
};