LYN-7279 + LYN-7192 | Focus Mode - Container unit tests + Clear container entity open state on new level load (#4558)

* Change SetContainerOpenState to SetContainerOpen. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Introduce Clear function to avoid retaining all lingering open states when switching contexts/loading a new level. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Minor FocusMode fixture refactors to support ContainerEntity tests Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Introduce tests for the ContainerEntity API Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Add include to fix issue with EntityContextId not being defined. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Minor comment fixes. Moved environment clear functions to TearDown function of test fixture. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Use default editor context id in ContainerEntitySystemComponent Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com> * Revert previous change as the EditorEntityContextId would not be initialized correctly on ContainerEntitySystemComponent Activate. Signed-off-by: Danilo Aimini <82231674+AMZN-daimini@users.noreply.github.com>
2021-10-12 13:34:51 -07:00
parent c38c9739da
commit 6318247b3d
12 changed files with 575 additions and 130 deletions
@@ -0,0 +1,99 @@
+/*
+ * Copyright (c) Contributors to the Open 3D Engine Project.
+ * For complete copyright and license terms please see the LICENSE at the root of this distribution.
+ *
+ * SPDX-License-Identifier: Apache-2.0 OR MIT
+ *
+ */
+
+#include <Tests/FocusMode/EditorFocusModeSelectionFixture.h>
+
+namespace AzToolsFramework
+{
+    TEST_F(EditorFocusModeSelectionFixture, ContainerEntitySelectionTests_FindHighestSelectableEntityWithNoContainers)
+    {
+        // When no containers are in the way, the function will just return the entityId of the entity that was clicked.
+        
+        // Click on Car Entity
+        ClickAtWorldPositionOnViewport(WorldCarEntityPosition);
+
+        // Verify the correct entity is selected
+        auto selectedEntitiesAfter = GetSelectedEntities();
+        EXPECT_EQ(selectedEntitiesAfter.size(), 1);
+        EXPECT_EQ(selectedEntitiesAfter.front(), m_entityMap[CarEntityName]);
+    }
+
+    TEST_F(EditorFocusModeSelectionFixture, ContainerEntitySelectionTests_FindHighestSelectableEntityWithClosedContainer)
+    {
+        // If a closed container is an ancestor of the queried entity, the closed container is selected.
+        m_containerEntityInterface->RegisterEntityAsContainer(m_entityMap[StreetEntityName]); // Containers are closed by default
+
+        // Click on Car Entity
+        ClickAtWorldPositionOnViewport(WorldCarEntityPosition);
+
+        // Verify the correct entity is selected
+        auto selectedEntitiesAfter = GetSelectedEntities();
+        EXPECT_EQ(selectedEntitiesAfter.size(), 1);
+        EXPECT_EQ(selectedEntitiesAfter.front(), m_entityMap[StreetEntityName]);
+
+        // Restore default state for other tests.
+        m_containerEntityInterface->UnregisterEntityAsContainer(m_entityMap[StreetEntityName]);
+    }
+
+    TEST_F(EditorFocusModeSelectionFixture, ContainerEntitySelectionTests_FindHighestSelectableEntityWithOpenContainer)
+    {
+        // If a closed container is an ancestor of the queried entity, the closed container is selected.
+        m_containerEntityInterface->RegisterEntityAsContainer(m_entityMap[StreetEntityName]);
+        m_containerEntityInterface->SetContainerOpen(m_entityMap[StreetEntityName], true);
+
+        // Click on Car Entity
+        ClickAtWorldPositionOnViewport(WorldCarEntityPosition);
+
+        // Verify the correct entity is selected
+        auto selectedEntitiesAfter = GetSelectedEntities();
+        EXPECT_EQ(selectedEntitiesAfter.size(), 1);
+        EXPECT_EQ(selectedEntitiesAfter.front(), m_entityMap[CarEntityName]);
+
+        // Restore default state for other tests.
+        m_containerEntityInterface->UnregisterEntityAsContainer(m_entityMap[StreetEntityName]);
+    }
+
+    TEST_F(EditorFocusModeSelectionFixture, ContainerEntitySelectionTests_FindHighestSelectableEntityWithMultipleClosedContainers)
+    {
+        // If multiple closed containers are ancestors of the queried entity, the highest closed container is selected.
+        m_containerEntityInterface->RegisterEntityAsContainer(m_entityMap[StreetEntityName]);
+        m_containerEntityInterface->RegisterEntityAsContainer(m_entityMap[CityEntityName]);
+
+        // Click on Car Entity
+        ClickAtWorldPositionOnViewport(WorldCarEntityPosition);
+
+        // Verify the correct entity is selected
+        auto selectedEntitiesAfter = GetSelectedEntities();
+        EXPECT_EQ(selectedEntitiesAfter.size(), 1);
+        EXPECT_EQ(selectedEntitiesAfter.front(), m_entityMap[CityEntityName]);
+
+        // Restore default state for other tests.
+        m_containerEntityInterface->UnregisterEntityAsContainer(m_entityMap[StreetEntityName]);
+        m_containerEntityInterface->UnregisterEntityAsContainer(m_entityMap[CityEntityName]);
+    }
+
+    TEST_F(EditorFocusModeSelectionFixture, ContainerEntitySelectionTests_FindHighestSelectableEntityWithMultipleContainers)
+    {
+        // If multiple containers are ancestors of the queried entity, the highest closed container is selected.
+        m_containerEntityInterface->RegisterEntityAsContainer(m_entityMap[StreetEntityName]);
+        m_containerEntityInterface->RegisterEntityAsContainer(m_entityMap[CityEntityName]);
+        m_containerEntityInterface->SetContainerOpen(m_entityMap[CityEntityName], true);
+
+        // Click on Car Entity
+        ClickAtWorldPositionOnViewport(WorldCarEntityPosition);
+
+        // Verify the correct entity is selected
+        auto selectedEntitiesAfter = GetSelectedEntities();
+        EXPECT_EQ(selectedEntitiesAfter.size(), 1);
+        EXPECT_EQ(selectedEntitiesAfter.front(), m_entityMap[StreetEntityName]);
+
+        // Restore default state for other tests.
+        m_containerEntityInterface->UnregisterEntityAsContainer(m_entityMap[StreetEntityName]);
+        m_containerEntityInterface->UnregisterEntityAsContainer(m_entityMap[CityEntityName]);
+    }
+}