birkeh/o3de
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rename Enter/ExitMode to Register/UnregisterMode.

Browse Source 
Signed-off-by: John <jonawals@amazon.com>
This commit is contained in:
John
2021-09-17 17:02:28 +01:00
parent 15ae8c2c06
commit c713077e07
4 changed files with 35 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerInterface.h
+4 -4
View File
@@ -21,11 +21,11 @@ namespace AzToolsFramework
virtual ~ViewportEditorModeTrackerInterface() = default;
//! Enters the specified editor mode for the specified viewport.
virtual void EnterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) = 0;
//! Registers the specified editor mode as active for the specified viewport.
virtual void RegisterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) = 0;
//! Exits the specified editor mode for the specified viewport.
virtual void ExitMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) = 0;
//! Unregisters the specified editor mode as active for the specified viewport.
virtual void UnregisterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) = 0;
//! Attempts to retrieve the editor mode state for the specified viewport, otherwise returns nullptr.
virtual const ViewportEditorModesInterface* GetViewportEditorModes(const ViewportEditorModeInfo& viewportEditorModeInfo) const = 0;
Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.cpp
+5 -5
View File
@@ -59,19 +59,19 @@ namespace AzToolsFramework
}
}
void ViewportEditorModeTracker::EnterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode)
void ViewportEditorModeTracker::RegisterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode)
{
auto& editorModes = m_viewportEditorModesMap[viewportEditorModeInfo.m_id];
AZ_Warning(
ViewportEditorModeLogWindow, !editorModes.IsModeActive(mode),
AZStd::string::format(
"Duplicate call to EnterMode for mode '%u' on id '%i'", static_cast<AZ::u32>(mode), viewportEditorModeInfo.m_id).c_str());
"Duplicate call to RegisterMode for mode '%u' on id '%i'", static_cast<AZ::u32>(mode), viewportEditorModeInfo.m_id).c_str());
editorModes.SetModeActive(mode);
ViewportEditorModeNotificationsBus::Event(
viewportEditorModeInfo.m_id, &ViewportEditorModeNotificationsBus::Events::OnEditorModeEnter, editorModes, mode);
}
void ViewportEditorModeTracker::ExitMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode)
void ViewportEditorModeTracker::UnregisterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode)
{
ViewportEditorModes* editorModes = nullptr;
if (m_viewportEditorModesMap.count(viewportEditorModeInfo.m_id))
@@ -80,12 +80,12 @@ namespace AzToolsFramework
AZ_Warning(
ViewportEditorModeLogWindow, editorModes->IsModeActive(mode),
AZStd::string::format(
"Duplicate call to ExitMode for mode '%u' on id '%i'", static_cast<AZ::u32>(mode), viewportEditorModeInfo.m_id).c_str());
"Duplicate call to UnregisterMode for mode '%u' on id '%i'", static_cast<AZ::u32>(mode), viewportEditorModeInfo.m_id).c_str());
}
else
{
AZ_Warning(
ViewportEditorModeLogWindow, false, "Call to ExitMode for mode '%u' on id '%i' without precursor call to EnterMode",
ViewportEditorModeLogWindow, false, "Call to UnregisterMode for mode '%u' on id '%i' without precursor call to RegisterMode",
static_cast<AZ::u32>(mode), viewportEditorModeInfo.m_id);
editorModes = &m_viewportEditorModesMap[viewportEditorModeInfo.m_id];
Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.h
+3 -3
View File
@@ -48,9 +48,9 @@ namespace AzToolsFramework
//! Unregisters this object with the AZ::Interface.
void UnregisterInterface();
// ViewportEditorModeTrackerInterface ...
void EnterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) override;
void ExitMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) override;
// ViewportEditorModeTrackerInterface overrides ...
void RegisterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) override;
void UnregisterMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) override;
const ViewportEditorModesInterface* GetViewportEditorModes(const ViewportEditorModeInfo& viewportEditorModeInfo) const override;
size_t GetTrackedViewportCount() const override;
bool IsViewportModeTracked(const ViewportEditorModeInfo& viewportEditorModeInfo) const override;
Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp
+23 -23
View File
@@ -73,7 +73,7 @@ namespace UnitTest
struct ReceivedEvents
{
bool m_onEnter = false;
bool m_onLeave = false;
bool m_onExit = false;
};
using EditModeTracker = AZStd::unordered_map<ViewportEditorMode, ReceivedEvents>;
@@ -106,7 +106,7 @@ namespace UnitTest
virtual void OnEditorModeExit([[maybe_unused]] const ViewportEditorModesInterface& editorModeState, ViewportEditorMode mode) override
{
m_editorModes[mode].m_onLeave = true;
m_editorModes[mode].m_onExit = true;
}
private:
@@ -286,7 +286,7 @@ namespace UnitTest
EXPECT_EQ(m_viewportEditorModeTracker.GetTrackedViewportCount(), 0);
}
TEST_F(ViewportEditorModeTrackerTestFixture, EnteringViewportEditorModeForNonExistentIdCreatesViewportEditorModesForThatId)
TEST_F(ViewportEditorModeTrackerTestFixture, RegisteringViewportEditorModeForNonExistentIdCreatesViewportEditorModesForThatId)
{
// Given a viewport not currently being tracked
const ViewportId viewportid = 0;
@@ -295,7 +295,7 @@ namespace UnitTest
// When a mode is activated for that viewport
const auto editorMode = ViewportEditorMode::Default;
m_viewportEditorModeTracker.EnterMode({ viewportid }, editorMode);
m_viewportEditorModeTracker.RegisterMode({ viewportid }, editorMode);
const auto* viewportEditorModeState = m_viewportEditorModeTracker.GetViewportEditorModes({ viewportid });
// Expect that viewport to now be tracked
@@ -306,7 +306,7 @@ namespace UnitTest
EXPECT_TRUE(viewportEditorModeState->IsModeActive(editorMode));
}
TEST_F(ViewportEditorModeTrackerTestFixture, ExitingViewportEditorModeForNonExistentIdCreatesViewportEditorModesForThatIdButIssuesErrorMsg)
TEST_F(ViewportEditorModeTrackerTestFixture, UnregisteringViewportEditorModeForNonExistentIdCreatesViewportEditorModesForThatIdButIssuesErrorMsg)
{
// Given a viewport not currently being tracked
const ViewportId viewportid = 0;
@@ -316,8 +316,8 @@ namespace UnitTest
// When a mode is deactivated for that viewport
const auto editorMode = ViewportEditorMode::Default;
UnitTest::ErrorHandler errorHandler(AZStd::string::format(
"Call to ExitMode for mode '%u' on id '%i' without precursor call to EnterMode", static_cast<AZ::u32>(editorMode), viewportid).c_str());
m_viewportEditorModeTracker.ExitMode({ viewportid }, editorMode);
"Call to UnregisterMode for mode '%u' on id '%i' without precursor call to RegisterMode", static_cast<AZ::u32>(editorMode), viewportid).c_str());
m_viewportEditorModeTracker.UnregisterMode({ viewportid }, editorMode);
// Expect a warning to be issued due to no precursor activation of that mode
EXPECT_EQ(errorHandler.GetExpectedWarningCount(), 1);
@@ -338,7 +338,7 @@ namespace UnitTest
EXPECT_EQ(m_viewportEditorModeTracker.GetViewportEditorModes({ viewportid }), nullptr);
}
TEST_F(ViewportEditorModeTrackerTestFixture, EnteringViewportEditorModesForExistingIdInThatStateIssuesWarningMsg)
TEST_F(ViewportEditorModeTrackerTestFixture, RegisteringViewportEditorModesForExistingIdInThatStateIssuesWarningMsg)
{
// Given a viewport not currently tracked
const ViewportId viewportid = 0;
@@ -347,13 +347,13 @@ namespace UnitTest
const auto editorMode = ViewportEditorMode::Default;
const auto expectedWarning = AZStd::string::format(
"Duplicate call to EnterMode for mode '%u' on id '%i'", static_cast<AZ::u32>(editorMode), viewportid);
"Duplicate call to RegisterMode for mode '%u' on id '%i'", static_cast<AZ::u32>(editorMode), viewportid);
{
UnitTest::ErrorHandler errorHandler(expectedWarning.c_str());
// When the mode is activated for the viewport
m_viewportEditorModeTracker.EnterMode({ viewportid }, editorMode);
m_viewportEditorModeTracker.RegisterMode({ viewportid }, editorMode);
// Expect no warning to be issued as there is no duplicate activation
EXPECT_EQ(errorHandler.GetExpectedWarningCount(), 0);
@@ -367,7 +367,7 @@ namespace UnitTest
{
// When the mode is activated again for the viewport
UnitTest::ErrorHandler errorHandler(expectedWarning.c_str());
m_viewportEditorModeTracker.EnterMode({ viewportid }, editorMode);
m_viewportEditorModeTracker.RegisterMode({ viewportid }, editorMode);
// Expect a warning to be issued for the duplicate activation
EXPECT_EQ(errorHandler.GetExpectedWarningCount(), 1);
@@ -380,7 +380,7 @@ namespace UnitTest
}
}
TEST_F(ViewportEditorModeTrackerTestFixture, ExitingViewportEditorModesForExistingIdNotInThatStateIssuesWarningMsg)
TEST_F(ViewportEditorModeTrackerTestFixture, UnregisteringViewportEditorModesForExistingIdNotInThatStateIssuesWarningMsg)
{
// Given a viewport not currently tracked
const ViewportId viewportid = 0;
@@ -389,14 +389,14 @@ namespace UnitTest
const auto editorMode = ViewportEditorMode::Default;
const auto expectedWarning =
AZStd::string::format("Duplicate call to ExitMode for mode '%u' on id '%i'", static_cast<AZ::u32>(editorMode), viewportid);
AZStd::string::format("Duplicate call to UnregisterMode for mode '%u' on id '%i'", static_cast<AZ::u32>(editorMode), viewportid);
{
UnitTest::ErrorHandler errorHandler(expectedWarning.c_str());
// When the mode is activated and then deactivated for the viewport
m_viewportEditorModeTracker.EnterMode({ viewportid }, editorMode);
m_viewportEditorModeTracker.ExitMode({ viewportid }, editorMode);
m_viewportEditorModeTracker.RegisterMode({ viewportid }, editorMode);
m_viewportEditorModeTracker.UnregisterMode({ viewportid }, editorMode);
// Expect no warning to be issued as there is no duplicate deactivation
EXPECT_EQ(errorHandler.GetExpectedWarningCount(), 0);
@@ -411,7 +411,7 @@ namespace UnitTest
UnitTest::ErrorHandler errorHandler(expectedWarning.c_str());
// When the mode is deactivated again for the viewport
m_viewportEditorModeTracker.ExitMode({ viewportid }, editorMode);
m_viewportEditorModeTracker.UnregisterMode({ viewportid }, editorMode);
// Expect a warning to be issued for the duplicate deactivation
EXPECT_EQ(errorHandler.GetExpectedWarningCount(), 1);
@@ -426,7 +426,7 @@ namespace UnitTest
TEST_F(
ViewportEditorModePublisherTestFixture,
EnteringViewportEditorModesForExistingIdPublishesOnViewportEditorModeEnterEventForAllSubscribers)
RegisteringViewportEditorModesForExistingIdPublishesOnViewportEditorModeRegisterEventForAllSubscribers)
{
// Given a set of subscribers tracking the editor modes for their exclusive viewport
for (auto mode = 0; mode < ViewportEditorModes::NumEditorModes; mode++)
@@ -440,7 +440,7 @@ namespace UnitTest
{
const ViewportId viewportId = mode;
const ViewportEditorMode editorMode = static_cast<ViewportEditorMode>(mode);
m_viewportEditorModeTracker.EnterMode({ mode }, editorMode);
m_viewportEditorModeTracker.RegisterMode({ mode }, editorMode);
}
for (auto mode = 0; mode < ViewportEditorModes::NumEditorModes; mode++)
@@ -453,13 +453,13 @@ namespace UnitTest
const auto& expectedEditorModeSet = editorModes.find(editorMode);
EXPECT_NE(expectedEditorModeSet, editorModes.end());
EXPECT_TRUE(expectedEditorModeSet->second.m_onEnter);
EXPECT_FALSE(expectedEditorModeSet->second.m_onLeave);
EXPECT_FALSE(expectedEditorModeSet->second.m_onExit);
}
}
TEST_F(
ViewportEditorModePublisherTestFixture,
ExitingViewportEditorModesForExistingIdPublishesOnViewportEditorModeExitEventForAllSubscribers)
UnregisteringViewportEditorModesForExistingIdPublishesOnViewportEditorModeUnregisterEventForAllSubscribers)
{
// Given a set of subscribers tracking the editor modes for their exclusive viewport
for (auto mode = 0; mode < ViewportEditorModes::NumEditorModes; mode++)
@@ -472,8 +472,8 @@ namespace UnitTest
{
const ViewportId viewportId = mode;
const ViewportEditorMode editorMode = static_cast<ViewportEditorMode>(mode);
m_viewportEditorModeTracker.EnterMode({ mode }, editorMode);
m_viewportEditorModeTracker.ExitMode({ mode }, editorMode);
m_viewportEditorModeTracker.RegisterMode({ mode }, editorMode);
m_viewportEditorModeTracker.UnregisterMode({ mode }, editorMode);
}
for (auto mode = 0; mode < ViewportEditorModes::NumEditorModes; mode++)
@@ -486,7 +486,7 @@ namespace UnitTest
const auto& expectedEditorModeSet = editorModes.find(editorMode);
EXPECT_NE(expectedEditorModeSet, editorModes.end());
EXPECT_TRUE(expectedEditorModeSet->second.m_onEnter);
EXPECT_TRUE(expectedEditorModeSet->second.m_onLeave);
EXPECT_TRUE(expectedEditorModeSet->second.m_onExit);
}
}
} // namespace UnitTest