Disable selection of "out of focus" entities in both Outliner and Viewport. Refactor hover/selection rect painting for branches in the Outliner to fix disabled hover state.

Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com>
2021-09-20 17:07:39 -07:00
parent e0eeb6369c
commit 368c325613
7 changed files with 99 additions and 15 deletions
@@ -21,7 +21,7 @@ AzToolsFramework--EntityOutlinerWidget QTreeView
 AzToolsFramework--EntityOutlinerWidget QTreeView::branch:hover
 , AzToolsFramework--EntityOutlinerWidget QTreeView::item:hover
 {
-    background: rgba(255, 255, 255, 30);
+    background: transparent;
 }

 AzToolsFramework--EntityOutlinerWidget QTreeView::branch:selected
@@ -29,7 +29,7 @@ AzToolsFramework--EntityOutlinerWidget QTreeView::branch:selected
 , AzToolsFramework--EntityOutlinerWidget QTreeView::branch:selected:active
 , AzToolsFramework--EntityOutlinerWidget QTreeView::item:selected:active
 {
-    background: rgba(255, 255, 255, 45);
+    background: transparent;
 }


@@ -44,6 +44,7 @@
 #include <AzToolsFramework/Entity/EditorEntityContextBus.h>
 #include <AzToolsFramework/Entity/EditorEntityHelpers.h>
 #include <AzToolsFramework/Entity/EditorEntityInfoBus.h>
+#include <AzToolsFramework/FocusMode/FocusModeInterface.h>
 #include <AzToolsFramework/ToolsComponents/ComponentAssetMimeDataContainer.h>
 #include <AzToolsFramework/ToolsComponents/ComponentMimeData.h>
 #include <AzToolsFramework/ToolsComponents/EditorEntityIdContainer.h>
@@ -102,10 +103,14 @@ namespace AzToolsFramework
        EntityCompositionNotificationBus::Handler::BusConnect();
        AZ::EntitySystemBus::Handler::BusConnect();

-        m_editorEntityFrameworkInterface = AZ::Interface<AzToolsFramework::EditorEntityUiInterface>::Get();
+        m_editorEntityUiInterface = AZ::Interface<AzToolsFramework::EditorEntityUiInterface>::Get();
+        AZ_Assert(m_editorEntityUiInterface != nullptr,
+            "EntityOutlinerListModel requires a EditorEntityUiInterface instance on Initialize.");

-        AZ_Assert(m_editorEntityFrameworkInterface != nullptr,
-            "EntityOutlinerListModel requires a EditorEntityFrameworkInterface instance on Initialize.");
+        m_focusModeInterface = AZ::Interface<FocusModeFramework::FocusModeInterface>::Get();
+        AZ_Assert(
+            m_focusModeInterface != nullptr,
+            "EntityOutlinerListModel requires a FocusModeInterface instance on Initialize.");
    }

    int EntityOutlinerListModel::rowCount(const QModelIndex& parent) const
@@ -279,7 +284,7 @@ namespace AzToolsFramework

    QVariant EntityOutlinerListModel::GetEntityIcon(const AZ::EntityId& id) const
    {
-        auto entityUiHandler = m_editorEntityFrameworkInterface->GetHandler(id);
+        auto entityUiHandler = m_editorEntityUiInterface->GetHandler(id);
        QIcon icon;

        // Retrieve the icon from the handler
@@ -316,7 +321,7 @@ namespace AzToolsFramework

    QVariant EntityOutlinerListModel::GetEntityTooltip(const AZ::EntityId& id) const
    {
-        auto entityUiHandler = m_editorEntityFrameworkInterface->GetHandler(id);
+        auto entityUiHandler = m_editorEntityUiInterface->GetHandler(id);
        QString tooltip;

        // Retrieve the tooltip from the handler
@@ -349,7 +354,7 @@ namespace AzToolsFramework
    QVariant EntityOutlinerListModel::dataForVisibility(const QModelIndex& index, int role) const
    {
        auto entityId = GetEntityFromIndex(index);
-        auto entityUiHandler = m_editorEntityFrameworkInterface->GetHandler(entityId);
+        auto entityUiHandler = m_editorEntityUiInterface->GetHandler(entityId);

        if (!entityUiHandler || entityUiHandler->CanToggleLockVisibility(entityId))
        {
@@ -377,7 +382,7 @@ namespace AzToolsFramework
    QVariant EntityOutlinerListModel::dataForLock(const QModelIndex& index, int role) const
    {
        auto entityId = GetEntityFromIndex(index);
-        auto entityUiHandler = m_editorEntityFrameworkInterface->GetHandler(entityId);
+        auto entityUiHandler = m_editorEntityUiInterface->GetHandler(entityId);

        if (!entityUiHandler || entityUiHandler->CanToggleLockVisibility(entityId))
        {
@@ -436,7 +441,7 @@ namespace AzToolsFramework
            if (value.canConvert<Qt::CheckState>())
            {
                const auto entityId = GetEntityFromIndex(index);
-                auto entityUiHandler = m_editorEntityFrameworkInterface->GetHandler(entityId);
+                auto entityUiHandler = m_editorEntityUiInterface->GetHandler(entityId);

                if (!entityUiHandler || entityUiHandler->CanToggleLockVisibility(entityId))
                {
@@ -532,6 +537,12 @@ namespace AzToolsFramework
            break;
        }

+        AZ::EntityId entityId = GetEntityFromIndex(index);
+        if (!m_focusModeInterface->IsInFocusSubTree(entityId))
+        {
+            itemFlags &= !Qt::ItemIsEnabled;
+        }
+
        return itemFlags;
    }

@@ -35,6 +35,11 @@

 namespace AzToolsFramework
 {
+    namespace FocusModeFramework
+    {
+        class FocusModeInterface;
+    }
+
    class EditorEntityUiInterface;

    namespace EntityOutliner
@@ -273,7 +278,8 @@ namespace AzToolsFramework
        QVariant GetEntityIcon(const AZ::EntityId& id) const;
        QVariant GetEntityTooltip(const AZ::EntityId& id) const;
        
-        EditorEntityUiInterface* m_editorEntityFrameworkInterface = nullptr;
+        EditorEntityUiInterface* m_editorEntityUiInterface = nullptr;
+        FocusModeFramework::FocusModeInterface* m_focusModeInterface = nullptr;
    };

    class EntityOutlinerCheckBox
@@ -38,6 +38,8 @@ namespace AzToolsFramework

        AZ_Assert((m_editorEntityFrameworkInterface != nullptr),
            "EntityOutlinerTreeView requires a EditorEntityFrameworkInterface instance on Construction.");
+
+        viewport()->setMouseTracking(true);
    }

    EntityOutlinerTreeView::~EntityOutlinerTreeView()
@@ -59,6 +61,11 @@ namespace AzToolsFramework
        }
    }

+    void EntityOutlinerTreeView::leaveEvent(QEvent* /*event*/)
+    {
+        m_mousePosition = QPoint();
+    }
+
    void EntityOutlinerTreeView::mousePressEvent(QMouseEvent* event)
    {
        //postponing normal mouse pressed logic until mouse is released or dragged
@@ -112,6 +119,8 @@ namespace AzToolsFramework
            setSelectionMode(selectionModeBefore);
        }

+        m_mousePosition = event->pos();
+
        //process mouse movement as normal, potentially triggering drag and drop
        QTreeView::mouseMoveEvent(event);
    }
@@ -172,12 +181,46 @@ namespace AzToolsFramework

    void EntityOutlinerTreeView::drawBranches(QPainter* painter, const QRect& rect, const QModelIndex& index) const
    {
+        const bool isEnabled = (this->model()->flags(index) & Qt::ItemIsEnabled);
+
+        const bool isSelected = selectionModel()->isSelected(index);
+        const bool isHovered = (index == indexAt(m_mousePosition)) && isEnabled;
+
+
+        // Paint the branch Selection/Hover Rect
+        PaintBranchSelectionHoverRect(painter, rect, isSelected, isHovered);
+        
        // Paint the branch background as defined by the entity's handler, or its closes ancestor's.
        PaintBranchBackground(painter, rect, index);

        QTreeView::drawBranches(painter, rect, index);
    }

+    void EntityOutlinerTreeView::PaintBranchSelectionHoverRect(
+        QPainter* painter, const QRect& rect, bool isSelected, bool isHovered) const
+    {
+        painter->save();
+        painter->setRenderHint(QPainter::Antialiasing, false);
+
+        if (isSelected || isHovered)
+        {
+            QPainterPath backgroundPath;
+            QRect backgroundRect(rect);
+
+            backgroundPath.addRect(backgroundRect);
+
+            QColor backgroundColor = m_hoverColor;
+            if (isSelected)
+            {
+                backgroundColor = m_selectedColor;
+            }
+
+            painter->fillPath(backgroundPath, backgroundColor);
+        }
+
+        painter->restore();
+    }
+
    void EntityOutlinerTreeView::PaintBranchBackground(QPainter* painter, const QRect& rect, const QModelIndex& index) const
    {
        // Go through ancestors and add them to the stack
@@ -59,6 +59,7 @@ namespace AzToolsFramework
        void startDrag(Qt::DropActions supportedActions) override;
        void dragMoveEvent(QDragMoveEvent* event) override;
        void dropEvent(QDropEvent* event) override;
+        void leaveEvent(QEvent* event) override;

        //! Renders the left side of the item: appropriate background, branch lines, icons.
        void drawBranches(QPainter* painter, const QRect& rect, const QModelIndex& index) const override;
@@ -72,8 +73,10 @@ namespace AzToolsFramework
        void StartCustomDrag(const QModelIndexList& indexList, Qt::DropActions supportedActions) override;

        void PaintBranchBackground(QPainter* painter, const QRect& rect, const QModelIndex& index) const;
+        void PaintBranchSelectionHoverRect(QPainter* painter, const QRect& rect, bool isSelected, bool isHovered) const;
        
        QMouseEvent* m_queuedMouseEvent;
+        QPoint m_mousePosition;
        bool m_draggingUnselectedItem; // This is set when an item is dragged outside its bounding box.

        int m_expandOnlyDelay = -1;
@@ -13,6 +13,7 @@
 #include <AzFramework/Viewport/CameraState.h>
 #include <AzFramework/Viewport/ViewportScreen.h>
 #include <AzFramework/Visibility/BoundsBus.h>
+#include <AzToolsFramework/FocusMode/FocusModeInterface.h>
 #include <AzToolsFramework/API/EditorViewportIconDisplayInterface.h>
 #include <AzToolsFramework/ToolsComponents/EditorEntityIconComponentBus.h>
 #include <AzToolsFramework/Viewport/ViewportMessages.h>
@@ -112,6 +113,17 @@ namespace AzToolsFramework
        }
    }

+    EditorHelpers::EditorHelpers(const EditorVisibleEntityDataCache* entityDataCache)
+        : m_entityDataCache(entityDataCache)
+    {
+        m_focusModeInterface = AZ::Interface<FocusModeFramework::FocusModeInterface>::Get();
+        AZ_Assert(
+            m_focusModeInterface,
+            "EditorHelpers - "
+            "Focus Mode Interface could not be found. "
+            "Check that it is being correctly initialized.");
+    }
+
    AZ::EntityId EditorHelpers::HandleMouseInteraction(
        const AzFramework::CameraState& cameraState, const ViewportInteraction::MouseInteractionEvent& mouseInteraction)
    {
@@ -173,6 +185,12 @@ namespace AzToolsFramework
            }
        }

+        // Verify if the entity Id corresponds to an entity that is focused; if not, halt selection.
+        if (!m_focusModeInterface->IsInFocusSubTree(entityIdUnderCursor))
+        {
+            return AZ::EntityId();
+        }
+
        return entityIdUnderCursor;
    }

@@ -23,6 +23,11 @@ namespace AzToolsFramework
 {
    class EditorVisibleEntityDataCache;

+    namespace FocusModeFramework
+    {
+        class FocusModeInterface;
+    }
+
    namespace ViewportInteraction
    {
        struct MouseInteractionEvent;
@@ -38,10 +43,7 @@ namespace AzToolsFramework

        //! An EditorVisibleEntityDataCache must be passed to EditorHelpers to allow it to
        //! efficiently read entity data without resorting to EBus calls.
-        explicit EditorHelpers(const EditorVisibleEntityDataCache* entityDataCache)
-            : m_entityDataCache(entityDataCache)
-        {
-        }
+        explicit EditorHelpers(const EditorVisibleEntityDataCache* entityDataCache);
        EditorHelpers(const EditorHelpers&) = delete;
        EditorHelpers& operator=(const EditorHelpers&) = delete;
        ~EditorHelpers() = default;
@@ -62,5 +64,6 @@ namespace AzToolsFramework

    private:
        const EditorVisibleEntityDataCache* m_entityDataCache = nullptr; //!< Entity Data queried by the EditorHelpers.
+        FocusModeFramework::FocusModeInterface* m_focusModeInterface = nullptr;
    };
 } // namespace AzToolsFramework