o3de/Code/Framework/AzToolsFramework/Tests/FocusMode/EditorFocusModeTests.cpp

/*
 * 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/EditorFocusModeFixture.h>
#include <AzToolsFramework/API/ToolsApplicationAPI.h>

namespace UnitTest
{
    TEST_F(EditorFocusModeFixture, SetFocus)
    {
        // When an entity is set as the focus root, GetFocusRoot should return its EntityId.
        m_focusModeInterface->SetFocusRoot(m_entityMap[CarEntityName]);
        EXPECT_EQ(m_focusModeInterface->GetFocusRoot(m_editorEntityContextId), m_entityMap[CarEntityName]);

        // Restore default expected focus.
        m_focusModeInterface->ClearFocusRoot(m_editorEntityContextId);
    }

    TEST_F(EditorFocusModeFixture, ClearFocus)
    {
        // Change the value from the default.
        m_focusModeInterface->SetFocusRoot(m_entityMap[CarEntityName]);

        // Calling ClearFocusRoot restores the default focus root (which is an invalid EntityId).
        m_focusModeInterface->ClearFocusRoot(m_editorEntityContextId);
        EXPECT_EQ(m_focusModeInterface->GetFocusRoot(m_editorEntityContextId), AZ::EntityId());
    }

    TEST_F(EditorFocusModeFixture, GetFocusedEntitiesRoot)
    {
        AzToolsFramework::EntityIdList entities = m_focusModeInterface->GetFocusedEntities(m_editorEntityContextId);
        
        using ::testing::UnorderedElementsAre;
        EXPECT_EQ(entities.size(), 6);
        EXPECT_THAT(
            entities,
            UnorderedElementsAre(
                m_entityMap[CityEntityName],
                m_entityMap[StreetEntityName],
                m_entityMap[CarEntityName],
                m_entityMap[Passenger1EntityName],
                m_entityMap[SportsCarEntityName],
                m_entityMap[Passenger2EntityName]
            )
        );
    }

    TEST_F(EditorFocusModeFixture, GetFocusedEntitiesClear)
    {
        m_focusModeInterface->ClearFocusRoot(m_editorEntityContextId);

        AzToolsFramework::EntityIdList entities = m_focusModeInterface->GetFocusedEntities(m_editorEntityContextId);

        using ::testing::UnorderedElementsAre;
        EXPECT_EQ(entities.size(), 6);
        EXPECT_THAT(
            entities,
            UnorderedElementsAre(
                m_entityMap[CityEntityName], m_entityMap[StreetEntityName], m_entityMap[CarEntityName], m_entityMap[Passenger1EntityName],
                m_entityMap[SportsCarEntityName], m_entityMap[Passenger2EntityName]));
    }

    TEST_F(EditorFocusModeFixture, GetFocusedEntitiesBase)
    {
        m_focusModeInterface->SetFocusRoot(m_entityMap[StreetEntityName]);

        AzToolsFramework::EntityIdList entities = m_focusModeInterface->GetFocusedEntities(m_editorEntityContextId);

        using ::testing::UnorderedElementsAre;
        EXPECT_EQ(entities.size(), 5);
        EXPECT_THAT(
            entities,
            UnorderedElementsAre(
                m_entityMap[StreetEntityName],
                m_entityMap[CarEntityName],
                m_entityMap[Passenger1EntityName],
                m_entityMap[SportsCarEntityName],
                m_entityMap[Passenger2EntityName]
            )
        );
    }

    TEST_F(EditorFocusModeFixture, GetFocusedEntitiesSiblings)
    {
        m_focusModeInterface->SetFocusRoot(m_entityMap[SportsCarEntityName]);

        AzToolsFramework::EntityIdList entities = m_focusModeInterface->GetFocusedEntities(m_editorEntityContextId);

        using ::testing::UnorderedElementsAre;
        EXPECT_EQ(entities.size(), 2);
        EXPECT_THAT(entities, UnorderedElementsAre(m_entityMap[SportsCarEntityName], m_entityMap[Passenger2EntityName]));
    }

    TEST_F(EditorFocusModeFixture, GetFocusedEntitiesAddEntity)
    {
        m_focusModeInterface->SetFocusRoot(m_entityMap[SportsCarEntityName]);

        AZ::EntityId testEntityId = CreateEditorEntity("Test", m_entityMap[Passenger2EntityName]);

        AzToolsFramework::EntityIdList entities = m_focusModeInterface->GetFocusedEntities(m_editorEntityContextId);

        EXPECT_EQ(entities.size(), 3);
        EXPECT_TRUE(AZStd::find(entities.begin(), entities.end(), m_entityMap[SportsCarEntityName]) != entities.end());
        EXPECT_TRUE(AZStd::find(entities.begin(), entities.end(), m_entityMap[Passenger2EntityName]) != entities.end());
        EXPECT_TRUE(AZStd::find(entities.begin(), entities.end(), testEntityId) != entities.end());
    }

    TEST_F(EditorFocusModeFixture, GetFocusedEntitiesRemoveEntity)
    {
        m_focusModeInterface->SetFocusRoot(m_entityMap[SportsCarEntityName]);

        AzToolsFramework::ToolsApplicationRequestBus::Broadcast(
            &AzToolsFramework::ToolsApplicationRequests::DeleteEntityAndAllDescendants, m_entityMap[Passenger2EntityName]);

        AzToolsFramework::EntityIdList entities = m_focusModeInterface->GetFocusedEntities(m_editorEntityContextId);

        EXPECT_EQ(entities.size(), 1);
        EXPECT_TRUE(AZStd::find(entities.begin(), entities.end(), m_entityMap[SportsCarEntityName]) != entities.end());
    }

    TEST_F(EditorFocusModeFixture, IsInFocusSubTreeAncestorsDescendants)
    {
        // When the focus is set to an entity, all its descendants are in the focus subtree while the ancestors aren't.
        m_focusModeInterface->SetFocusRoot(m_entityMap[StreetEntityName]);

        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CityEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[StreetEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CarEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger1EntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[SportsCarEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger2EntityName]), true);
    }

    TEST_F(EditorFocusModeFixture, IsInFocusSubTreeSiblings)
    {
        // If the root entity has siblings, they are also outside of the focus subtree.
        m_focusModeInterface->SetFocusRoot(m_entityMap[CarEntityName]);

        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CityEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[StreetEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CarEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger1EntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[SportsCarEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger2EntityName]), false);
    }

    TEST_F(EditorFocusModeFixture, IsInFocusSubTreeLeaf)
    {
        // If the root is a leaf, then the focus subtree will consists of just that entity.
        m_focusModeInterface->SetFocusRoot(m_entityMap[Passenger2EntityName]);

        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CityEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[StreetEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CarEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger1EntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[SportsCarEntityName]), false);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger2EntityName]), true);
    }

    TEST_F(EditorFocusModeFixture, IsInFocusSubTreeClear)
    {
        // Change the value from the default.
        m_focusModeInterface->SetFocusRoot(m_entityMap[StreetEntityName]);

        // When the focus is cleared, the whole level is in the focus subtree; so we expect all entities to return true.
        m_focusModeInterface->ClearFocusRoot(m_editorEntityContextId);

        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CityEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[StreetEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[CarEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger1EntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[SportsCarEntityName]), true);
        EXPECT_EQ(m_focusModeInterface->IsInFocusSubTree(m_entityMap[Passenger2EntityName]), true);
    }
} // namespace UnitTest