Do not clear input channels everytime focus changes (#5044)

* remove HandleFocusChange from FocusIn/Out events in QtEventToAzInputManager Signed-off-by: hultonha <hultonha@amazon.co.uk> * ensure we clear input channels when application state changes Signed-off-by: hultonha <hultonha@amazon.co.uk> * wip changes for focus switching tests Signed-off-by: hultonha <hultonha@amazon.co.uk> * updates to test to verify focus change not affecting input Signed-off-by: hultonha <hultonha@amazon.co.uk> * add test to ensure input is not cleared when focus changes Signed-off-by: hultonha <hultonha@amazon.co.uk> * ensure key press goes to correct widget Signed-off-by: hultonha <hultonha@amazon.co.uk> * add test to verify input is cleared when application state changes Signed-off-by: hultonha <hultonha@amazon.co.uk> * clear input for all types of application state change Signed-off-by: hultonha <hultonha@amazon.co.uk> * update input key for focus test Signed-off-by: hultonha <hultonha@amazon.co.uk> * use the Settings Registry to tell the InputSystemComponent to disable various devices Signed-off-by: hultonha <hultonha@amazon.co.uk> * update how we simulate the application state change event Signed-off-by: hultonha <hultonha@amazon.co.uk> * revert Settings Registry changes Signed-off-by: hultonha <hultonha@amazon.co.uk>
2021-11-02 09:19:06 +00:00
parent bf6fd2a6d6
commit de6af361ab
3 changed files with 91 additions and 10 deletions
@@ -85,6 +85,7 @@ namespace UnitTest

            m_rootWidget = AZStd::make_unique<QWidget>();
            m_rootWidget->setFixedSize(QSize(100, 100));
+            QApplication::setActiveWindow(m_rootWidget.get());

            m_controllerList = AZStd::make_shared<AzFramework::ViewportControllerList>();
            m_controllerList->RegisterViewportContext(TestViewportId);
@@ -100,6 +101,8 @@ namespace UnitTest
            m_controllerList.reset();
            m_rootWidget.reset();

+            QApplication::setActiveWindow(nullptr);
+
            AllocatorsTestFixture::TearDown();
        }

@@ -110,7 +113,7 @@ namespace UnitTest

    const AzFramework::ViewportId ViewportManipulatorControllerFixture::TestViewportId = AzFramework::ViewportId(0);

-    TEST_F(ViewportManipulatorControllerFixture, An_event_is_not_propagated_to_the_viewport_when_a_manipulator_handles_it_first)
+    TEST_F(ViewportManipulatorControllerFixture, AnEventIsNotPropagatedToTheViewportWhenAManipulatorHandlesItFirst)
    {
        // forward input events to our controller list
        QObject::connect(
@@ -151,4 +154,77 @@ namespace UnitTest

        editorInteractionViewportFake.Disconnect();
    }
+
+    TEST_F(ViewportManipulatorControllerFixture, ChangingFocusDoesNotClearInput)
+    {
+        bool endedEvent = false;
+        // detect input events and ensure that the Alt key press does not end before the end of the test
+        QObject::connect(
+            m_inputChannelMapper.get(), &AzToolsFramework::QtEventToAzInputMapper::InputChannelUpdated, m_rootWidget.get(),
+            [&endedEvent](const AzFramework::InputChannel* inputChannel, [[maybe_unused]] QEvent* event)
+            {
+                if (inputChannel->GetInputChannelId() == AzFramework::InputDeviceKeyboard::Key::ModifierAltL &&
+                    inputChannel->IsStateEnded())
+                {
+                    endedEvent = true;
+                }
+            });
+
+        // given
+        auto* secondaryWidget = new QWidget(m_rootWidget.get());
+
+        m_rootWidget->show();
+        secondaryWidget->show();
+
+        m_rootWidget->setFocus();
+
+        // simulate a key press when root widget has focus
+        QTest::keyPress(m_rootWidget.get(), Qt::Key_Alt, Qt::KeyboardModifier::AltModifier);
+
+        // when
+        // change focus to secondary widget
+        secondaryWidget->setFocus();
+
+        // then
+        // the alt key was not released (cleared)
+        EXPECT_FALSE(endedEvent);
+    }
+
+    // note: Application State Change includes events such as switching to another application or minimizing
+    // the current application
+    TEST_F(ViewportManipulatorControllerFixture, ApplicationStateChangeDoesClearInput)
+    {
+        bool endedEvent = false;
+        // detect input events and ensure that the Alt key press does not end before the end of the test
+        QObject::connect(
+            m_inputChannelMapper.get(), &AzToolsFramework::QtEventToAzInputMapper::InputChannelUpdated, m_rootWidget.get(),
+            [&endedEvent](const AzFramework::InputChannel* inputChannel, [[maybe_unused]] QEvent* event)
+            {
+                if (inputChannel->GetInputChannelId() == AzFramework::InputDeviceKeyboard::Key::AlphanumericW &&
+                    inputChannel->IsStateEnded())
+                {
+                    endedEvent = true;
+                }
+            });
+
+        // given
+        auto* secondaryWidget = new QWidget(m_rootWidget.get());
+
+        m_rootWidget->show();
+        secondaryWidget->show();
+
+        m_rootWidget->setFocus();
+
+        // simulate a key press when root widget has focus
+        QTest::keyPress(m_rootWidget.get(), Qt::Key_W);
+
+        // when
+        // simulate changing the window state
+        QApplicationStateChangeEvent applicationStateChangeEvent(Qt::ApplicationState::ApplicationInactive);
+        QCoreApplication::sendEvent(m_rootWidget.get(), &applicationStateChangeEvent);
+
+        // then
+        // the key was released (cleared)
+        EXPECT_TRUE(endedEvent);
+    }
 } // namespace UnitTest