KeyInputBehavior.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "BaseBehaviors/BehaviorTargetInterfaces.h"
#include "BaseBehaviors/InputBehaviorModifierStates.h"
#include "CoreMinimal.h"
#include "InputBehavior.h"
#include "InputCoreTypes.h"
#include "InputState.h"
#include "InteractiveTool.h"
#include "Templates/Function.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
 
#include "KeyInputBehavior.generated.h"
 
class IModifierToggleBehaviorTarget;
class UObject;
 
 
UCLASS(MinimalAPI)
class UKeyInputBehavior : public UInputBehavior
{
    GENERATED_BODY()
 
public:
    INTERACTIVETOOLSFRAMEWORK_API UKeyInputBehavior();
 
    virtual EInputDevices GetSupportedDevices() override
    {
        return EInputDevices::Keyboard;
    }
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Initialize(IKeyInputBehaviorTarget* Target, const FKey& Key);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Initialize(IKeyInputBehaviorTarget* Target, const TArray<FKey>& Keys);
 
    TFunction<bool(const FInputDeviceState&)> ModifierCheckFunc = nullptr;
 
    // UInputBehavior implementation
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputCaptureRequest WantsCapture(const FInputDeviceState& Input) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputCaptureUpdate BeginCapture(const FInputDeviceState& Input, EInputCaptureSide Side) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual FInputCaptureUpdate UpdateCapture(const FInputDeviceState& Input, const FInputCaptureData& Data) override;
    INTERACTIVETOOLSFRAMEWORK_API virtual void ForceEndCapture(const FInputCaptureData& Data) override;
 
    INTERACTIVETOOLSFRAMEWORK_API bool IsKeyPressed(FKey InKey) const;
 
    FInputBehaviorModifierStates Modifiers;
 
    bool bRequireAllKeys = true;
 
protected:
    IKeyInputBehaviorTarget* Target;
 
    TArray<FKey> TargetKeys;
    TArray<bool> KeyActivations;
    
private:
    void InitializeKeyActivations();
    bool IsTargetedKey(const FInputDeviceState& Input);
    bool UpdateActivations(const FInputDeviceState& Input, bool bEmitOnChange);
    bool IsAnyKeyPressed() const;
    bool AreAllKeysPressed() const;
 
    bool bAllKeysSeenPressed = false;
};