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>
2021-07-09 18:03:20 +01:00
parent 76cef6e91f
commit 1b530195fc
17 changed files with 201 additions and 18 deletions
@@ -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);
 }

@@ -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;
@@ -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*/)
@@ -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
@@ -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();
 }

@@ -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
 };

@@ -36,8 +36,47 @@ namespace AzToolsFramework
        /// Retrieve the main application window.
        virtual QWidget* GetAppMainWindow() { return nullptr; }
    };
-
    using EditorWindowRequestBus = AZ::EBus<EditorWindowRequests>;
+
+    class EditorWindowUIRequests : public AZ::EBusTraits
+    {
+    public:
+        using Bus = AZ::EBus<EditorWindowUIRequests>;
+
+        //////////////////////////////////////////////////////////////////////////
+        // EBusTraits overrides
+        static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple;
+        //////////////////////////////////////////////////////////////////////////
+
+        /// Enable/Disable the Editor UI.
+        virtual void SetEditorUiEnabled([[maybe_unused]] bool enable) {}
+    };
+    using EditorWindowUIRequestBus = AZ::EBus<EditorWindowUIRequests>;
+
+    using EnableUiFunction = AZStd::function<void(bool)>;
+
+    /// Helper for EditorWindowRequests to be used as a 
+    /// member instead of inheriting from EBus directly.
+    class EditorWindowRequestBusImpl
+        : public EditorWindowUIRequestBus::Handler
+    {
+    public:
+        /// Set the function to be called when entering ImGui Mode.
+        void SetEnableEditorUiFunc(const EnableUiFunction enableEditorUiFunc)
+        {
+            m_enableEditorUiFunc = AZStd::move(enableEditorUiFunc);
+        }
+
+        private:
+        // EditorWindowRequestBus
+        void SetEditorUiEnabled( [[maybe_unused]] bool enable) override
+        {
+            m_enableEditorUiFunc(enable);
+        }
+
+        EnableUiFunction m_enableEditorUiFunc; ///< Function to call when entering ImGui Mode.
+    };
+
 } // namespace AzToolsFramework

 #endif // AZTOOLSFRAMEWORK_EDITORWINDOWREQUESTBUS_H
@@ -291,10 +291,12 @@ namespace AzToolsFramework
            GetEntityContextId());
        EditorEntityInfoNotificationBus::Handler::BusConnect();
        Prefab::PrefabPublicNotificationBus::Handler::BusConnect();
+        EditorWindowUIRequestBus::Handler::BusConnect();
    }

    EntityOutlinerWidget::~EntityOutlinerWidget()
    {
+        EditorWindowUIRequestBus::Handler::BusDisconnect();
        Prefab::PrefabPublicNotificationBus::Handler::BusDisconnect();
        ComponentModeFramework::EditorComponentModeNotificationBus::Handler::BusDisconnect();
        EditorEntityInfoNotificationBus::Handler::BusDisconnect();
@@ -1106,16 +1108,25 @@ namespace AzToolsFramework
        AzQtComponents::SetWidgetInteractEnabled(entityOutlinerUi->m_searchWidget, on);
    }

+    void EntityOutlinerWidget::EnableUi(bool enable)
+    {
+        SetEntityOutlinerState(m_gui, enable);
+        setEnabled(enable);
+    }
+
+    void EntityOutlinerWidget::SetEditorUiEnabled(bool enable)
+    {
+        EnableUi(enable);
+    }
+
    void EntityOutlinerWidget::EnteredComponentMode([[maybe_unused]] const AZStd::vector<AZ::Uuid>& componentModeTypes)
    {
-        SetEntityOutlinerState(m_gui, false);
-        setEnabled(false);
+        EnableUi(false);
    }

    void EntityOutlinerWidget::LeftComponentMode([[maybe_unused]] const AZStd::vector<AZ::Uuid>& componentModeTypes)
    {
-        setEnabled(true);
-        SetEntityOutlinerState(m_gui, true);
+        EnableUi(true);
    }

    void EntityOutlinerWidget::OnPrefabInstancePropagationBegin()
@@ -11,6 +11,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>
@@ -58,6 +59,7 @@ namespace AzToolsFramework
        , private EditorEntityInfoNotificationBus::Handler
        , private ComponentModeFramework::EditorComponentModeNotificationBus::Handler
        , private Prefab::PrefabPublicNotificationBus::Handler
+        , private EditorWindowUIRequestBus::Handler
    {
        Q_OBJECT;
    public:
@@ -105,6 +107,9 @@ namespace AzToolsFramework
        void OnPrefabInstancePropagationBegin() override;
        void OnPrefabInstancePropagationEnd() 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);
@@ -155,6 +160,7 @@ namespace AzToolsFramework
        AZ::EntityId GetEntityIdFromIndex(const QModelIndex& index) const;
        QModelIndex GetIndexFromEntityId(const AZ::EntityId& entityId) const;
        void ExtractEntityIdsFromSelection(const QItemSelection& selection, EntityIdList& entityIdList) const;
+        void EnableUi(bool enable);

        // OutlinerModelNotificationBus::Handler
        // Receive notification from the outliner model that we should scroll
@@ -376,6 +376,7 @@ namespace AzToolsFramework
        ToolsApplicationEvents::Bus::Handler::BusConnect();
        AZ::EntitySystemBus::Handler::BusConnect();
        EntityPropertyEditorRequestBus::Handler::BusConnect();
+        EditorWindowUIRequestBus::Handler::BusConnect();
        m_spacer = nullptr;

        m_emptyIcon = QIcon();
@@ -421,6 +422,7 @@ namespace AzToolsFramework
    {
        qApp->removeEventFilter(this);

+        EditorWindowUIRequestBus::Handler::BusDisconnect();
        EntityPropertyEditorRequestBus::Handler::BusDisconnect();
        ToolsApplicationEvents::Bus::Handler::BusDisconnect();
        AZ::EntitySystemBus::Handler::BusDisconnect();
@@ -4961,6 +4963,27 @@ namespace AzToolsFramework
        EnableDisableComponentActions(widget, actions, false);
    }

+    void EntityPropertyEditor::SetEditorUiEnabled(bool enable)
+    {
+        if (enable)
+        {
+            EnableComponentActions(this, m_entityComponentActions);
+        }
+        else
+        {
+            DisableComponentActions(this, m_entityComponentActions);
+        }
+        m_disabled = !enable;
+        SetPropertyEditorState(m_gui, enable);
+
+        for (auto componentEditor : m_componentEditors)
+        {
+            AzQtComponents::SetWidgetInteractEnabled(componentEditor, enable);
+        }
+        // record the selected state after entering/leaving component mode
+        SaveComponentEditorState();
+    }
+
    void EntityPropertyEditor::EnteredComponentMode(const AZStd::vector<AZ::Uuid>& componentModeTypes)
    {
        DisableComponentActions(this, m_entityComponentActions);
@@ -21,6 +21,7 @@
 #include <AzCore/Asset/AssetCommon.h>
 #include <AzToolsFramework/UI/PropertyEditor/PropertyEditorAPI.h>
 #include <AzToolsFramework/Undo/UndoSystem.h>
+#include <AzToolsFramework/API/EditorWindowRequestBus.h>
 #include <AzToolsFramework/API/ToolsApplicationAPI.h>
 #include <AzToolsFramework/API/EntityPropertyEditorRequestsBus.h>
 #include <AzToolsFramework/ComponentMode/EditorComponentModeBus.h>
@@ -108,6 +109,7 @@ namespace AzToolsFramework
        , public EditorInspectorComponentNotificationBus::MultiHandler
        , private AzToolsFramework::ComponentModeFramework::EditorComponentModeNotificationBus::Handler
        , public AZ::EntitySystemBus::Handler
+        , private EditorWindowUIRequestBus::Handler
    {
        Q_OBJECT;
    public:
@@ -208,6 +210,9 @@ namespace AzToolsFramework
        void GetSelectedEntities(EntityIdList& selectedEntityIds) override;
        void SetNewComponentId(AZ::ComponentId componentId) override;

+        // EditorWindowRequestBus overrides
+        void SetEditorUiEnabled(bool enable) override;
+
        bool IsEntitySelected(const AZ::EntityId& id) const;
        bool IsSingleEntitySelected(const AZ::EntityId& id) const;