InputRouter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "InputBehavior.h"
#include "InputBehaviorSet.h"
#include "InputState.h"
#include "Misc/Change.h"
#include "ToolContextInterfaces.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ObjectPtr.h"
#include "UObject/UObjectGlobals.h"
 
#include "InputRouter.generated.h"
 
class IInputBehaviorSource;
class IToolsContextTransactionsAPI;
class UInputBehaviorSet;
struct FInputDeviceState;
 
 
UCLASS(Transient, MinimalAPI)
class UInputRouter : public UObject
{
    GENERATED_BODY()
 
protected:
    friend class UInteractiveToolsContext;      // to call Initialize/Shutdown
 
    INTERACTIVETOOLSFRAMEWORK_API UInputRouter();
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Initialize(IToolsContextTransactionsAPI* TransactionsAPI);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void Shutdown();
 
public:
    INTERACTIVETOOLSFRAMEWORK_API virtual void RegisterSource(IInputBehaviorSource* Source);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void DeregisterSource(IInputBehaviorSource* Source);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool PostInputEvent(const FInputDeviceState& Input);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual bool HasActiveMouseCapture() const;
 
    // TODO: other capture queries
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void PostHoverInputEvent(const FInputDeviceState& Input);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void ForceTerminateSource(IInputBehaviorSource* Source);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void ForceTerminateAll();
 
 
public:
    UPROPERTY()
    bool bAutoInvalidateOnHover;
 
    UPROPERTY()
    bool bAutoInvalidateOnCapture;
 
 
protected:
    IToolsContextTransactionsAPI* TransactionsAPI;
 
    UPROPERTY()
    TObjectPtr<UInputBehaviorSet> ActiveInputBehaviors;
 
    UInputBehavior* ActiveKeyboardCapture = nullptr;
    void* ActiveKeyboardCaptureOwner = nullptr;
    FInputCaptureData ActiveKeyboardCaptureData;
 
    UInputBehavior* ActiveLeftCapture = nullptr;
    void* ActiveLeftCaptureOwner = nullptr;
    FInputCaptureData ActiveLeftCaptureData;
 
    UInputBehavior* ActiveRightCapture = nullptr;
    void* ActiveRightCaptureOwner = nullptr;
    FInputCaptureData ActiveRightCaptureData;
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void PostInputEvent_Keyboard(const FInputDeviceState& Input);
    INTERACTIVETOOLSFRAMEWORK_API void CheckForKeyboardCaptures(const FInputDeviceState& Input);
    INTERACTIVETOOLSFRAMEWORK_API void HandleCapturedKeyboardInput(const FInputDeviceState& Input);
 
    INTERACTIVETOOLSFRAMEWORK_API virtual void PostInputEvent_Mouse(const FInputDeviceState& Input);
    INTERACTIVETOOLSFRAMEWORK_API void CheckForMouseCaptures(const FInputDeviceState& Input);
    INTERACTIVETOOLSFRAMEWORK_API void HandleCapturedMouseInput(const FInputDeviceState& Input);
 
    //
    // Hover support
    //
 
    UInputBehavior* ActiveLeftHoverCapture = nullptr;
    void* ActiveLeftHoverCaptureOwner = nullptr;
 
    FInputDeviceState LastMouseInputState;
 
    INTERACTIVETOOLSFRAMEWORK_API void TerminateHover(EInputCaptureSide Side);
    INTERACTIVETOOLSFRAMEWORK_API bool ProcessMouseHover(const FInputDeviceState& Input);
    INTERACTIVETOOLSFRAMEWORK_API bool UpdateExistingHoverCaptureIfPresent(const FInputDeviceState& Input);
    INTERACTIVETOOLSFRAMEWORK_API void OnApplicationFocusChanged(bool bInIsFocused);
};