Fix an issue when using both "ImGui" and "Common UI" plugins where "accept" button presses are consumed by the "CommonAnalogCursor" preprocessor.

AFonsecaSurgentStudios · AFonsecaSurgentStudios · commit 7ae4e897f80e · 2024-11-05T10:37:20.000Z
diff --git a/Source/ImGui/Private/ImGuiInputHandler.cpp b/Source/ImGui/Private/ImGuiInputHandler.cpp
@@ -8,6 +8,7 @@
 #include "ImGuiModuleManager.h"
 #include "ImGuiModuleSettings.h"
 #include "VersionCompatibility.h"
+#include "Widgets/SImGuiWidget.h"
 
 #include <Engine/Console.h>
 #include <Framework/Application/SlateApplication.h>
@@ -329,7 +330,7 @@ void UImGuiInputHandler::OnPostImGuiUpdate()
 	InputState->SetGamepad(PlatformApplication.IsValid() && PlatformApplication->IsGamepadAttached());
 }
 
-void UImGuiInputHandler::Initialize(FImGuiModuleManager* InModuleManager, UGameViewportClient* InGameViewport, int32 InContextIndex)
+void UImGuiInputHandler::Initialize(FImGuiModuleManager* InModuleManager, UGameViewportClient* InGameViewport, int32 InContextIndex, TSharedRef<SImGuiWidget> Widget)
 {
 	ModuleManager = InModuleManager;
 	GameViewport = InGameViewport;
@@ -356,11 +357,14 @@ void UImGuiInputHandler::Initialize(FImGuiModuleManager* InModuleManager, UGameV
 			TEXT("PIE feature allowing execution of stop command in ImGui input mode will be disabled."));
 	}
 #endif // WITH_EDITOR
+
+	InputProcessor = MakeShared<FImGuiInputProcessor>(Widget);
+	FSlateApplication::Get().RegisterInputPreProcessor(InputProcessor, ModuleManager->GetSettings().GetInputProcessorPriority());
 }
 
-void UImGuiInputHandler::BeginDestroy()
+void UImGuiInputHandler::Deinitialize()
 {
-	Super::BeginDestroy();
+	FSlateApplication::Get().UnregisterInputPreProcessor(InputProcessor);
 
 	// To catch leftovers from modules shutdown during PIE session.
 	extern FImGuiModuleManager* ImGuiModuleManager;
@@ -370,3 +374,25 @@ void UImGuiInputHandler::BeginDestroy()
 	}
 }
 
+FImGuiInputProcessor::FImGuiInputProcessor(TSharedRef<SImGuiWidget> InOwnerWidget)
+	: OwnerWidget(InOwnerWidget)
+{
+}
+
+bool FImGuiInputProcessor::HandleKeyDownEvent(FSlateApplication& SlateApp, const FKeyEvent& InKeyEvent)
+{
+	if (OwnerWidget.IsValid())
+	{
+		return OwnerWidget.Pin()->OnKeyDown_Indirect(InKeyEvent).IsEventHandled();
+	}
+	return false;
+}
+
+bool FImGuiInputProcessor::HandleKeyUpEvent(FSlateApplication& SlateApp, const FKeyEvent& InKeyEvent)
+{
+	if (OwnerWidget.IsValid())
+	{
+		return OwnerWidget.Pin()->OnKeyUp_Indirect(InKeyEvent).IsEventHandled();
+	}
+	return false;
+}
diff --git a/Source/ImGui/Private/ImGuiInputHandlerFactory.cpp b/Source/ImGui/Private/ImGuiInputHandlerFactory.cpp
@@ -9,7 +9,7 @@
 #include <InputCoreTypes.h>
 
 
-UImGuiInputHandler* FImGuiInputHandlerFactory::NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex)
+UImGuiInputHandler* FImGuiInputHandlerFactory::NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex, TSharedRef<SImGuiWidget> Widget)
 {
 	UClass* HandlerClass = nullptr;
 	if (HandlerClassReference.IsValid())
@@ -30,7 +30,7 @@ UImGuiInputHandler* FImGuiInputHandlerFactory::NewHandler(const FSoftClassPath&
 	UImGuiInputHandler* Handler = NewObject<UImGuiInputHandler>(GameViewport, HandlerClass);
 	if (Handler)
 	{
-		Handler->Initialize(ModuleManager, GameViewport, ContextIndex);
+		Handler->Initialize(ModuleManager, GameViewport, ContextIndex, Widget);
 		Handler->AddToRoot();
 	}
 	else
@@ -45,6 +45,7 @@ void FImGuiInputHandlerFactory::ReleaseHandler(UImGuiInputHandler* Handler)
 {
 	if (Handler)
 	{
+		Handler->Deinitialize();
 		Handler->RemoveFromRoot();
 	}
 }
diff --git a/Source/ImGui/Private/ImGuiInputHandlerFactory.h b/Source/ImGui/Private/ImGuiInputHandlerFactory.h
@@ -13,7 +13,7 @@ class FImGuiInputHandlerFactory
 {
 public:
 
-	static UImGuiInputHandler* NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex);
+	static UImGuiInputHandler* NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex, TSharedRef<class SImGuiWidget> Widget);
 
 	static void ReleaseHandler(UImGuiInputHandler* Handler);
 };
diff --git a/Source/ImGui/Private/ImGuiModuleSettings.cpp b/Source/ImGui/Private/ImGuiModuleSettings.cpp
@@ -123,6 +123,7 @@ void FImGuiModuleSettings::UpdateSettings()
 		SetShareGamepadInput(SettingsObject->bShareGamepadInput);
 		SetShareMouseInput(SettingsObject->bShareMouseInput);
 		SetUseSoftwareCursor(SettingsObject->bUseSoftwareCursor);
+		SetInputProcessorPriority(SettingsObject->InputProcessorPriority);
 		SetToggleInputKey(SettingsObject->ToggleInput);
 		SetCanvasSizeInfo(SettingsObject->CanvasSize);
 	}
@@ -181,6 +182,11 @@ void FImGuiModuleSettings::SetUseSoftwareCursor(bool bUse)
 	}
 }
 
+void FImGuiModuleSettings::SetInputProcessorPriority(int32 Priority)
+{
+	InputProcessorPriority = Priority;
+}
+
 void FImGuiModuleSettings::SetToggleInputKey(const FImGuiKeyInfo& KeyInfo)
 {
 	if (ToggleInputKey != KeyInfo)
diff --git a/Source/ImGui/Private/ImGuiModuleSettings.h b/Source/ImGui/Private/ImGuiModuleSettings.h
@@ -202,6 +202,14 @@ class UImGuiSettings : public UObject
 	UPROPERTY(EditAnywhere, config, Category = "Input", AdvancedDisplay)
 	bool bUseSoftwareCursor = false;
 
+	// The input processor priority when registering.
+	// This is used to fix an issue where the CommonAnalogCursor preprocessor would consume "accept" button presses on controller.
+	// An earlier priority means it will receive input earlier and other processors won't be able to block it from receiving
+	// events. A later priority means it won't block other processors when inputs are pressed. The priority needs to have a value
+	// that balances between these 2 scenarios. -1 means the input processor will be added to the end of the input processor list.
+	UPROPERTY(EditAnywhere, config, Category = "Input", AdvancedDisplay)
+	int32 InputProcessorPriority = 2;
+
 	// Define a shortcut key to 'ImGui.ToggleInput' command. Binding is only set if the key field is valid.
 	// Note that modifier key properties can be set to one of the three values: undetermined means that state of the given
 	// modifier is not important, checked means that it needs to be pressed and unchecked means that it cannot be pressed.
@@ -258,6 +266,8 @@ class FImGuiModuleSettings
 	// Get the software cursor configuration.
 	bool UseSoftwareCursor() const { return bUseSoftwareCursor; }
 
+	int32 GetInputProcessorPriority() const { return InputProcessorPriority; }
+
 	// Get the shortcut configuration for 'ImGui.ToggleInput' command.
 	const FImGuiKeyInfo& GetToggleInputKey() const { return ToggleInputKey; }
 
@@ -290,6 +300,7 @@ class FImGuiModuleSettings
 	void SetShareGamepadInput(bool bShare);
 	void SetShareMouseInput(bool bShare);
 	void SetUseSoftwareCursor(bool bUse);
+	void SetInputProcessorPriority(int32 Priority);
 	void SetToggleInputKey(const FImGuiKeyInfo& KeyInfo);
 	void SetCanvasSizeInfo(const FImGuiCanvasSizeInfo& CanvasSizeInfo);
 	void SetDPIScaleInfo(const FImGuiDPIScaleInfo& ScaleInfo);
@@ -309,4 +320,5 @@ class FImGuiModuleSettings
 	bool bShareGamepadInput = false;
 	bool bShareMouseInput = false;
 	bool bUseSoftwareCursor = false;
+	int32 InputProcessorPriority = 2;
 };
diff --git a/Source/ImGui/Private/Widgets/SImGuiWidget.cpp b/Source/ImGui/Private/Widgets/SImGuiWidget.cpp
@@ -160,16 +160,24 @@ FReply SImGuiWidget::OnKeyChar(const FGeometry& MyGeometry, const FCharacterEven
 	return InputHandler->OnKeyChar(CharacterEvent);
 }
 
-FReply SImGuiWidget::OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& KeyEvent)
+FReply SImGuiWidget::OnKeyDown_Indirect(const FKeyEvent& KeyEvent)
 {
-	UpdateCanvasControlMode(KeyEvent);
-	return InputHandler->OnKeyDown(KeyEvent);
+	if (HasKeyboardFocus())
+	{
+		UpdateCanvasControlMode(KeyEvent);
+		return InputHandler->OnKeyDown(KeyEvent);
+	}
+	return FReply::Unhandled();
 }
 
-FReply SImGuiWidget::OnKeyUp(const FGeometry& MyGeometry, const FKeyEvent& KeyEvent)
+FReply SImGuiWidget::OnKeyUp_Indirect(const FKeyEvent& KeyEvent)
 {
-	UpdateCanvasControlMode(KeyEvent);
-	return InputHandler->OnKeyUp(KeyEvent);
+	if (HasKeyboardFocus())
+	{
+		UpdateCanvasControlMode(KeyEvent);
+		return InputHandler->OnKeyUp(KeyEvent);
+	}
+	return FReply::Unhandled();
 }
 
 FReply SImGuiWidget::OnAnalogValueChanged(const FGeometry& MyGeometry, const FAnalogInputEvent& AnalogInputEvent)
@@ -284,7 +292,7 @@ void SImGuiWidget::CreateInputHandler(const FSoftClassPath& HandlerClassReferenc
 
 	if (!InputHandler.IsValid())
 	{
-		InputHandler = FImGuiInputHandlerFactory::NewHandler(HandlerClassReference, ModuleManager, GameViewport.Get(), ContextIndex);
+		InputHandler = FImGuiInputHandlerFactory::NewHandler(HandlerClassReference, ModuleManager, GameViewport.Get(), ContextIndex, SharedThis(this));
 	}
 }
 
diff --git a/Source/ImGui/Private/Widgets/SImGuiWidget.h b/Source/ImGui/Private/Widgets/SImGuiWidget.h
@@ -52,9 +52,9 @@ class SImGuiWidget : public SCompoundWidget
 
 	virtual FReply OnKeyChar(const FGeometry& MyGeometry, const FCharacterEvent& CharacterEvent) override;
 
-	virtual FReply OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& KeyEvent) override;
+	virtual FReply OnKeyDown_Indirect(const FKeyEvent& KeyEvent);
 
-	virtual FReply OnKeyUp(const FGeometry& MyGeometry, const FKeyEvent& KeyEvent) override;
+	virtual FReply OnKeyUp_Indirect(const FKeyEvent& KeyEvent);
 
 	virtual FReply OnAnalogValueChanged(const FGeometry& MyGeometry, const FAnalogInputEvent& AnalogInputEvent) override;
 
diff --git a/Source/ImGui/Public/ImGuiInputHandler.h b/Source/ImGui/Public/ImGuiInputHandler.h
@@ -3,6 +3,7 @@
 #pragma once
 
 #include <CoreMinimal.h>
+#include <Framework/Application/IInputProcessor.h>
 #include <Input/Reply.h>
 #include <UObject/Object.h>
 #include <UObject/WeakObjectPtr.h>
@@ -174,9 +175,9 @@ class IMGUI_API UImGuiInputHandler : public UObject
 
 	void OnPostImGuiUpdate();
 
-	void Initialize(FImGuiModuleManager* InModuleManager, UGameViewportClient* InGameViewport, int32 InContextIndex);
+	void Initialize(FImGuiModuleManager* InModuleManager, UGameViewportClient* InGameViewport, int32 InContextIndex, TSharedRef<class SImGuiWidget> Widget);
 
-	virtual void BeginDestroy() override;
+	void Deinitialize();
 
 	class FImGuiInputState* InputState = nullptr;
 
@@ -188,6 +189,8 @@ class IMGUI_API UImGuiInputHandler : public UObject
 
 	TWeakObjectPtr<UGameViewportClient> GameViewport;
 
+	TSharedPtr<class FImGuiInputProcessor> InputProcessor;
+
 	int32 ContextIndex = -1;
 
 #if WITH_EDITOR
@@ -196,3 +199,16 @@ class IMGUI_API UImGuiInputHandler : public UObject
 
 	friend class FImGuiInputHandlerFactory;
 };
+
+class FImGuiInputProcessor : public IInputProcessor
+{
+public:
+	FImGuiInputProcessor(TSharedRef<class SImGuiWidget> InOwnerWidget);
+	void Tick(const float DeltaTime, FSlateApplication& SlateApp, TSharedRef<ICursor> Cursor) override {};
+	bool HandleKeyDownEvent(FSlateApplication& SlateApp, const FKeyEvent& InKeyEvent) override;
+	bool HandleKeyUpEvent(FSlateApplication& SlateApp, const FKeyEvent& InKeyEvent) override;
+
+private:
+	TWeakPtr<class SImGuiWidget> OwnerWidget;
+};
+

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`#include <InputCoreTypes.h>`
`10`	`10`
`11`	`11`
`12`		`-UImGuiInputHandler* FImGuiInputHandlerFactory::NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex)`
	`12`	`+UImGuiInputHandler* FImGuiInputHandlerFactory::NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex, TSharedRef<SImGuiWidget> Widget)`
`13`	`13`	`{`
`14`	`14`	`UClass* HandlerClass = nullptr;`
`15`	`15`	`if (HandlerClassReference.IsValid())`
`@@ -30,7 +30,7 @@ UImGuiInputHandler* FImGuiInputHandlerFactory::NewHandler(const FSoftClassPath&`
`30`	`30`	`UImGuiInputHandler* Handler = NewObject<UImGuiInputHandler>(GameViewport, HandlerClass);`
`31`	`31`	`if (Handler)`
`32`	`32`	`{`
`33`		`- Handler->Initialize(ModuleManager, GameViewport, ContextIndex);`
	`33`	`+ Handler->Initialize(ModuleManager, GameViewport, ContextIndex, Widget);`
`34`	`34`	`Handler->AddToRoot();`
`35`	`35`	`}`
`36`	`36`	`else`
`@@ -45,6 +45,7 @@ void FImGuiInputHandlerFactory::ReleaseHandler(UImGuiInputHandler* Handler)`
`45`	`45`	`{`
`46`	`46`	`if (Handler)`
`47`	`47`	`{`
	`48`	`+ Handler->Deinitialize();`
`48`	`49`	`Handler->RemoveFromRoot();`
`49`	`50`	`}`
`50`	`51`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class FImGuiInputHandlerFactory`
`13`	`13`	`{`
`14`	`14`	`public:`
`15`	`15`
`16`		`- static UImGuiInputHandler* NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex);`
	`16`	`+ static UImGuiInputHandler* NewHandler(const FSoftClassPath& HandlerClassReference, FImGuiModuleManager* ModuleManager, UGameViewportClient* GameViewport, int32 ContextIndex, TSharedRef<class SImGuiWidget> Widget);`
`17`	`17`
`18`	`18`	`static void ReleaseHandler(UImGuiInputHandler* Handler);`
`19`	`19`	`};`
Original file line number	Diff line number	Diff line change
`@@ -123,6 +123,7 @@ void FImGuiModuleSettings::UpdateSettings()`
`123`	`123`	`SetShareGamepadInput(SettingsObject->bShareGamepadInput);`
`124`	`124`	`SetShareMouseInput(SettingsObject->bShareMouseInput);`
`125`	`125`	`SetUseSoftwareCursor(SettingsObject->bUseSoftwareCursor);`
	`126`	`+ SetInputProcessorPriority(SettingsObject->InputProcessorPriority);`
`126`	`127`	`SetToggleInputKey(SettingsObject->ToggleInput);`
`127`	`128`	`SetCanvasSizeInfo(SettingsObject->CanvasSize);`
`128`	`129`	`}`
`@@ -181,6 +182,11 @@ void FImGuiModuleSettings::SetUseSoftwareCursor(bool bUse)`
`181`	`182`	`}`
`182`	`183`	`}`
`183`	`184`
	`185`	`+void FImGuiModuleSettings::SetInputProcessorPriority(int32 Priority)`
	`186`	`+{`
	`187`	`+ InputProcessorPriority = Priority;`
	`188`	`+}`
	`189`	`+`
`184`	`190`	`void FImGuiModuleSettings::SetToggleInputKey(const FImGuiKeyInfo& KeyInfo)`
`185`	`191`	`{`
`186`	`192`	`if (ToggleInputKey != KeyInfo)`
Original file line number	Diff line number	Diff line change
`@@ -160,16 +160,24 @@ FReply SImGuiWidget::OnKeyChar(const FGeometry& MyGeometry, const FCharacterEven`
`160`	`160`	`return InputHandler->OnKeyChar(CharacterEvent);`
`161`	`161`	`}`
`162`	`162`
`163`		`-FReply SImGuiWidget::OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& KeyEvent)`
	`163`	`+FReply SImGuiWidget::OnKeyDown_Indirect(const FKeyEvent& KeyEvent)`
`164`	`164`	`{`
`165`		`- UpdateCanvasControlMode(KeyEvent);`
`166`		`- return InputHandler->OnKeyDown(KeyEvent);`
	`165`	`+ if (HasKeyboardFocus())`
	`166`	`+ {`
	`167`	`+ UpdateCanvasControlMode(KeyEvent);`
	`168`	`+ return InputHandler->OnKeyDown(KeyEvent);`
	`169`	`+ }`
	`170`	`+ return FReply::Unhandled();`
`167`	`171`	`}`
`168`	`172`
`169`		`-FReply SImGuiWidget::OnKeyUp(const FGeometry& MyGeometry, const FKeyEvent& KeyEvent)`
	`173`	`+FReply SImGuiWidget::OnKeyUp_Indirect(const FKeyEvent& KeyEvent)`
`170`	`174`	`{`
`171`		`- UpdateCanvasControlMode(KeyEvent);`
`172`		`- return InputHandler->OnKeyUp(KeyEvent);`
	`175`	`+ if (HasKeyboardFocus())`
	`176`	`+ {`
	`177`	`+ UpdateCanvasControlMode(KeyEvent);`
	`178`	`+ return InputHandler->OnKeyUp(KeyEvent);`
	`179`	`+ }`
	`180`	`+ return FReply::Unhandled();`
`173`	`181`	`}`
`174`	`182`
`175`	`183`	`FReply SImGuiWidget::OnAnalogValueChanged(const FGeometry& MyGeometry, const FAnalogInputEvent& AnalogInputEvent)`
`@@ -284,7 +292,7 @@ void SImGuiWidget::CreateInputHandler(const FSoftClassPath& HandlerClassReferenc`
`284`	`292`
`285`	`293`	`if (!InputHandler.IsValid())`
`286`	`294`	`{`
`287`		`- InputHandler = FImGuiInputHandlerFactory::NewHandler(HandlerClassReference, ModuleManager, GameViewport.Get(), ContextIndex);`
	`295`	`+ InputHandler = FImGuiInputHandlerFactory::NewHandler(HandlerClassReference, ModuleManager, GameViewport.Get(), ContextIndex, SharedThis(this));`
`288`	`296`	`}`
`289`	`297`	`}`
`290`	`298`