InputKeyEventArgs.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Engine/EngineBaseTypes.h"
#include "InputCoreTypes.h"
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_6
#include "GenericPlatform/GenericPlatformInputDeviceMapper.h"
#include "GenericPlatform/GenericWindow.h"
#endif
 
class FViewport;
 
struct FInputKeyEventArgs
{
public:
 
    FInputKeyEventArgs() = default;
    
    ENGINE_API FInputKeyEventArgs(
        FViewport* InViewport,
        const FInputDeviceId InInputDevice,
        const FKey& InKey,
        const EInputEvent InEvent,
        const float InAmountDepressed,
        const bool bInIsTouchEvent,
        const uint64 InEventTimestamp);
 
    UE_DEPRECATED(5.6, "Use the newer constructors which takes a timestamp instead.")
    FInputKeyEventArgs(
    FViewport* InViewport,
    FInputDeviceId InInputDevice,
    FKey InKey,
    EInputEvent InEvent,
    float InAmountDepressed,
    bool bInIsTouchEvent)
        : FInputKeyEventArgs(InViewport,
        InInputDevice,
        InKey,
        InEvent,
        InAmountDepressed,
        bInIsTouchEvent,
        /*EventTimestamp*/0u)
    {}
 
    FInputKeyEventArgs(
        FViewport* InViewport,
        const FInputDeviceId InInputDevice,
        const FKey& InKey,
        const EInputEvent InEvent,
        const uint64 InEventTimestamp)
        : FInputKeyEventArgs(
         InViewport,
         InInputDevice, 
         InKey, 
         InEvent,
         /*AmountDepressed*/1.0f,
         /*bIsTouch*/ false,
         InEventTimestamp)
    {
    }
 
    UE_DEPRECATED(5.6, "Use the newer constructors which takes a timestamp instead.")
    FInputKeyEventArgs(FViewport* InViewport, FInputDeviceId InInputDevice, FKey InKey, EInputEvent InEvent)
    : FInputKeyEventArgs(
     InViewport,
     InInputDevice, 
     InKey, 
     InEvent,
     /*AmountDepressed*/1.0f,
     /*bIsTouch*/ false,
     0u)
    {
    }
 
    FInputKeyEventArgs(
        FViewport* InViewport,
        const FInputDeviceId InInputDevice,
        const FKey& InKey,
        const float InDelta,
        const float InDeltaTime,
        const int32 InNumSamples,
        const uint64 InEventTimestamp)
        : FInputKeyEventArgs(
            InViewport,
            InInputDevice,
            InKey,
            IE_Axis,
            /*AmountDepressed*/InDelta,
            /*bIsTouchEvent*/ false,
            InEventTimestamp)
    {
        DeltaTime = InDeltaTime;
        NumSamples = InNumSamples;
    }
    
    static ENGINE_API FInputKeyEventArgs CreateSimulated(
        const FKey& InKey,
        const EInputEvent InEvent,
        const float AmountDepressed,
        const int32 InNumSamplesOverride = -1,
        const FInputDeviceId InputDevice = INPUTDEVICEID_NONE,
        const bool bIsTouchEvent = false,
        FViewport* Viewport = nullptr
    );
    
    UE_DEPRECATED(5.6, "Use the newer constructors which take in a FInputDeviceId and a timestamp instead.")
    FInputKeyEventArgs(FViewport* InViewport, int32 InControllerId, FKey InKey, EInputEvent InEvent, float InAmountDepressed, bool bInIsTouchEvent)
        : Viewport(InViewport)
        , ControllerId(InControllerId)
        , InputDevice(FInputDeviceId::CreateFromInternalId(InControllerId))
        , Key(InKey)
        , Event(InEvent)
        , AmountDepressed(InAmountDepressed)
        , bIsTouchEvent(bInIsTouchEvent)
    {
    }
 
    UE_DEPRECATED(5.6, "Use the newer constructors which take in a FInputDeviceId and a timestamp instead.")
    FInputKeyEventArgs(FViewport* InViewport, int32 InControllerId, FKey InKey, EInputEvent InEvent)
        : FInputKeyEventArgs(
            InViewport,
            FInputDeviceId::CreateFromInternalId(InControllerId),
            InKey,
            InEvent,
            /*EventTimestamp*/ 0u)
    {
        ControllerId = InControllerId;
    }
    
    bool IsGamepad() const { return Key.IsGamepadKey(); }
 
    bool IsSimulatedInput() const { return bIsSimulatedInput; }
 
    ENGINE_API FPlatformUserId GetPlatformUser() const;
 
public:
    
    FViewport* Viewport = nullptr;
 
    // The controller which the key event is from.
    int32 ControllerId;
    
    FInputDeviceId InputDevice = INPUTDEVICEID_NONE;
 
    FKey Key = {};
    
    EInputEvent Event = IE_MAX;
    
    float AmountDepressed;
 
    float DeltaTime = 1.0f / 60.f;
 
    int32 NumSamples = 1;
    
    bool bIsTouchEvent = false;
 
private:
 
    bool bIsSimulatedInput = false;
    
public:
    
    uint64 EventTimestamp = 0u;
};