From c2105b0631e6dbc1bd8962a210e08da6f5d68258 Mon Sep 17 00:00:00 2001 From: John Date: Tue, 26 Oct 2021 15:30:08 +0100 Subject: [PATCH] Address PR comments. Signed-off-by: John --- ...ViewportEditorModeTrackerNotificationBus.h | 2 ++ .../Viewport/ViewportEditorModeTests.cpp | 22 ++++++------------- 2 files changed, 9 insertions(+), 15 deletions(-) diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h b/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h index 966b9f8478..2d25dbbafc 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h @@ -43,6 +43,8 @@ namespace AzToolsFramework }; //! Provides a bus to notify when the different editor modes are entered/exit. + //! @note The editor modes are not discrete states but rather each progression of mode retain the active the parent + //! mode that the new mode progressed from. class ViewportEditorModeNotifications : public AZ::EBusTraits { public: diff --git a/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp b/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp index 05d7a0d37d..85b65f3edf 100644 --- a/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp +++ b/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp @@ -72,14 +72,6 @@ namespace UnitTest } } - bool IsComponentModeActive() - { - bool inComponentMode = false; - AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequestBus::BroadcastResult( - inComponentMode, &AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::InComponentMode); - return inComponentMode; - } - // Fixture for testing editor mode states class ViewportEditorModesTestsFixture : public ::testing::Test @@ -543,7 +535,7 @@ namespace UnitTest AZStd::vector{}); // Expect to be in component mode - EXPECT_TRUE(IsComponentModeActive()); + EXPECT_TRUE(AzToolsFramework::ComponentModeFramework::InComponentMode()); // Expect the default and component viewport editor modes to be active EXPECT_TRUE(m_viewportEditorModes->IsModeActive(ViewportEditorMode::Default)); @@ -561,13 +553,13 @@ namespace UnitTest &AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::BeginComponentMode, AZStd::vector{}); - EXPECT_TRUE(IsComponentModeActive()); + EXPECT_TRUE(AzToolsFramework::ComponentModeFramework::InComponentMode()); AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequestBus::Broadcast( &AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::EndComponentMode); // Expect to not be in component mode - EXPECT_FALSE(IsComponentModeActive()); + EXPECT_FALSE(AzToolsFramework::ComponentModeFramework::InComponentMode()); // Expect only the default viewport editor mode to be active ExpectOnlyModeActive(*m_viewportEditorModes, ViewportEditorMode::Default); @@ -634,7 +626,7 @@ namespace UnitTest ExitingFocusModeAfterEnteringFromInitialStateHasOnlyViewportEditorModeDefaultActive) { // When entering and leaving focus mode - m_focusModeInterface->SetFocusRoot(AZ::EntityId(1)); + m_focusModeInterface->SetFocusRoot(AZ::EntityId{ 1 }); m_focusModeInterface->SetFocusRoot(AZ::EntityId()); // Expect only the default mode to be active @@ -650,7 +642,7 @@ namespace UnitTest AZStd::vector{}); // Expect to be in component mode - EXPECT_TRUE(IsComponentModeActive()); + EXPECT_TRUE(AzToolsFramework::ComponentModeFramework::InComponentMode()); // Expect the default, focus and component viewport editor modes to be active EXPECT_TRUE(m_viewportEditorModes->IsModeActive(ViewportEditorMode::Default)); @@ -669,13 +661,13 @@ namespace UnitTest &AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::BeginComponentMode, AZStd::vector{}); - EXPECT_TRUE(IsComponentModeActive()); + EXPECT_TRUE(AzToolsFramework::ComponentModeFramework::InComponentMode()); AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequestBus::Broadcast( &AzToolsFramework::ComponentModeFramework::ComponentModeSystemRequests::EndComponentMode); // Expect to not be in component mode - EXPECT_FALSE(IsComponentModeActive()); + EXPECT_FALSE(AzToolsFramework::ComponentModeFramework::InComponentMode()); // Expect the default and focus viewport editor modes to be active EXPECT_TRUE(m_viewportEditorModes->IsModeActive(ViewportEditorMode::Default));