Clarify ImGui activation in Editor viewport (#1765)

* Clarify ImGui activation in Editor viewport

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

* All working following changes from comments in PR

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

* One more change

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

* fixes from comments in PR.

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

* Fixed git merge error

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

* Added header to ImGuiBus.h

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

* Fix for Jenkins error

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

* Minor typo fix

Signed-off-by: John Jones-Steele <jjjoness@amazon.com>

Code/Editor/MainWindow.cpp

@@ -41,6 +41,7 @@ AZ_POP_DISABLE_WARNING
 
 // AzToolsFramework
 #include <AzToolsFramework/Application/Ticker.h>
+#include <AzToolsFramework/API/EditorWindowRequestBus.h>
 #include <AzToolsFramework/API/EditorAnimationSystemRequestBus.h>
 #include <AzToolsFramework/SourceControl/QtSourceControlNotificationHandler.h>
 #include <AzToolsFramework/PythonTerminal/ScriptTermDialog.h>
@@ -93,6 +94,8 @@ AZ_POP_DISABLE_WARNING
 #include "AssetEditor/AssetEditorWindow.h"
 #include "ActionManager.h"
 
+#include <ImGuiBus.h>
+
 using namespace AZ;
 using namespace AzQtComponents;
 using namespace AzToolsFramework;
@@ -489,6 +492,16 @@ void MainWindow::Initialize()
     ActionOverrideRequestBus::Event(
         GetEntityContextId(), &ActionOverrideRequests::SetupActionOverrideHandler, this);
 
+    if (auto imGuiManager = AZ::Interface<ImGui::IImGuiManager>::Get())
+    {
+        auto handleImGuiStateChangeFn = [](bool enabled)
+        {
+            EditorWindowUIRequestBus::Broadcast(&EditorWindowUIRequests::SetEditorUiEnabled, enabled);
+        };
+        m_handleImGuiStateChangeHandler = ImGui::IImGuiManager::ImGuiSetEnabledEvent::Handler(handleImGuiStateChangeFn);
+        imGuiManager->ConnectImGuiSetEnabledChangedHandler(m_handleImGuiStateChangeHandler);
+    }
+
     AzToolsFramework::EditorEventsBus::Broadcast(&AzToolsFramework::EditorEvents::NotifyMainWindowInitialized, this);
 }
 

Code/Editor/MainWindow.h

@@ -249,6 +249,7 @@ private:
 
     QPointer<ToolbarCustomizationDialog> m_toolbarCustomizationDialog;
     QScopedPointer<AzToolsFramework::QtSourceControlNotificationHandler> m_sourceControlNotifHandler;
+    AZ::Event<bool>::Handler m_handleImGuiStateChangeHandler;
     AZ_POP_DISABLE_DLL_EXPORT_MEMBER_WARNING
 
     static MainWindow* m_instance;

Code/Editor/Plugins/ComponentEntityEditorPlugin/UI/Outliner/OutlinerWidget.cpp

@@ -269,10 +269,12 @@ OutlinerWidget::OutlinerWidget(QWidget* pParent, Qt::WindowFlags flags)
     AzToolsFramework::ComponentModeFramework::EditorComponentModeNotificationBus::Handler::BusConnect(
             AzToolsFramework::GetEntityContextId());
     AzToolsFramework::EditorEntityInfoNotificationBus::Handler::BusConnect();
+    AzToolsFramework::EditorWindowUIRequestBus::Handler::BusConnect();
 }
 
 OutlinerWidget::~OutlinerWidget()
 {
+    AzToolsFramework::EditorWindowUIRequestBus::Handler::BusDisconnect();
     AzToolsFramework::ComponentModeFramework::EditorComponentModeNotificationBus::Handler::BusDisconnect();
     AzToolsFramework::EditorEntityInfoNotificationBus::Handler::BusDisconnect();
     AzToolsFramework::EditorPickModeNotificationBus::Handler::BusDisconnect();
@@ -1321,16 +1323,25 @@ static void SetEntityOutlinerState(Ui::OutlinerWidgetUI* entityOutlinerUi, const
     AzQtComponents::SetWidgetInteractEnabled(entityOutlinerUi->m_searchWidget, on);
 }
 
+void OutlinerWidget::EnableUi(bool enable)
+{
+    SetEntityOutlinerState(m_gui, enable);
+    setEnabled(enable);
+}
+
+void OutlinerWidget::SetEditorUiEnabled(bool enable)
+{
+    EnableUi(enable);
+}
+
 void OutlinerWidget::EnteredComponentMode([[maybe_unused]] const AZStd::vector<AZ::Uuid>& componentModeTypes)
 {
-    SetEntityOutlinerState(m_gui, false);
-    setEnabled(false);
+    EnableUi(false);
 }
 
 void OutlinerWidget::LeftComponentMode([[maybe_unused]] const AZStd::vector<AZ::Uuid>& componentModeTypes)
 {
-    setEnabled(true);
-    SetEntityOutlinerState(m_gui, true);
+    EnableUi(true);
 }
 
 void OutlinerWidget::OnSliceInstantiated(const AZ::Data::AssetId& /*sliceAssetId*/, AZ::SliceComponent::SliceInstanceAddress& sliceAddress, const AzFramework::SliceInstantiationTicket& /*ticket*/)

Code/Editor/Plugins/ComponentEntityEditorPlugin/UI/Outliner/OutlinerWidget.hxx

@@ -13,6 +13,7 @@
 
 #include <AzCore/Memory/SystemAllocator.h>
 #include <AzCore/base.h>
+#include <AzToolsFramework/API/EditorWindowRequestBus.h>
 #include <AzToolsFramework/API/ToolsApplicationAPI.h>
 #include <AzToolsFramework/ComponentMode/EditorComponentModeBus.h>
 #include <AzToolsFramework/Entity/EditorEntityInfoBus.h>
@@ -57,6 +58,7 @@ class OutlinerWidget
     , private AzToolsFramework::SliceEditorEntityOwnershipServiceNotificationBus::Handler
     , private AzToolsFramework::EditorEntityInfoNotificationBus::Handler
     , private AzToolsFramework::ComponentModeFramework::EditorComponentModeNotificationBus::Handler
+    , private AzToolsFramework::EditorWindowUIRequestBus::Handler
 {
     Q_OBJECT;
 public:
@@ -106,6 +108,9 @@ private:
     void EnteredComponentMode(const AZStd::vector<AZ::Uuid>& componentModeTypes) override;
     void LeftComponentMode(const AZStd::vector<AZ::Uuid>& componentModeTypes) override;
 
+    // EditorWindowUIRequestBus overrides
+    void SetEditorUiEnabled(bool enable) override;
+
     // Build a selection object from the given entities. Entities already in the Widget's selection buffers are ignored.
     template <class EntityIdCollection>
     QItemSelection BuildSelectionFromEntities(const EntityIdCollection& entityIds);
@@ -171,6 +176,7 @@ private:
     AZ::EntityId GetEntityIdFromIndex(const QModelIndex& index) const;
     QModelIndex GetIndexFromEntityId(const AZ::EntityId& entityId) const;
     void ExtractEntityIdsFromSelection(const QItemSelection& selection, AzToolsFramework::EntityIdList& entityIdList) const;
+    void EnableUi(bool enable);
 
     // AzToolsFramework::OutlinerModelNotificationBus::Handler
     // Receive notification from the outliner model that we should scroll

Code/Editor/QtViewPaneManager.cpp

@@ -525,6 +525,7 @@ QtViewPaneManager::QtViewPaneManager(QObject* parent)
 
     // view pane manager is interested when we enter/exit ComponentMode
     m_componentModeNotifications.BusConnect(AzToolsFramework::GetEntityContextId());
+    m_windowRequest.BusConnect();
 
     m_componentModeNotifications.SetEnteredComponentModeFunc(
         [this](const AZStd::vector<AZ::Uuid>& /*componentModeTypes*/)
@@ -545,10 +546,23 @@ QtViewPaneManager::QtViewPaneManager(QObject* parent)
             AzQtComponents::SetWidgetInteractEnabled(widget, on);
         });
     });
+
+    m_windowRequest.SetEnableEditorUiFunc(
+        [this](bool enable)
+        {
+            // gray out panels when entering ImGui mode
+            SetDefaultActionsEnabled(
+                enable, m_registeredPanes,
+                [](QWidget* widget, bool on)
+                {
+                    AzQtComponents::SetWidgetInteractEnabled(widget, on);
+                });
+        });
 }
 
 QtViewPaneManager::~QtViewPaneManager()
 {
+    m_windowRequest.BusDisconnect();
     m_componentModeNotifications.BusDisconnect();
 }
 

Code/Editor/QtViewPaneManager.h

@@ -21,6 +21,7 @@
 #include <AzQtComponents/Components/StyledDockWidget.h>
 #include <AzToolsFramework/UI/PropertyEditor/PropertyEditorAPI.h>
 #include <AzToolsFramework/ComponentMode/EditorComponentModeBus.h>
+#include <AzToolsFramework/API/EditorWindowRequestBus.h>
 
 #include <QObject>
 #include <QVector>
@@ -249,8 +250,12 @@ private:
     QPointer<AzQtComponents::FancyDocking> m_advancedDockManager;
 
     using EditorComponentModeNotificationBusImpl = AzToolsFramework::ComponentModeFramework::EditorComponentModeNotificationBusImpl;
-    EditorComponentModeNotificationBusImpl m_componentModeNotifications; /**< Helper for EditorComponentModeNotificationBus so 
-                                                                           *  QtViewPaneManager does not need to inherit directly from it. */
+    EditorComponentModeNotificationBusImpl m_componentModeNotifications; //!< Helper for EditorComponentModeNotificationBus so
+                                                                         //!< QtViewPaneManager does not need to inherit directly from it. */
+
+    using EditorWindowRequestBusImpl = AzToolsFramework::EditorWindowRequestBusImpl;
+    EditorWindowRequestBusImpl m_windowRequest;                         //!< Helper for EditorWindowRequestBus so
+                                                                        //!< QtViewPaneManager does not need to inherit directly from it. */
     AZ_POP_DISABLE_DLL_EXPORT_MEMBER_WARNING
 };