diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerInterface.h b/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerInterface.h index bcc8afbe6a..9da8d97990 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerInterface.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerInterface.h @@ -22,22 +22,22 @@ namespace AzToolsFramework virtual ~ViewportEditorModeTrackerInterface() = default; - //! Activates the specified editor mode for the specified viewport. + //! Activates the specified editor mode for the specified viewport editor mode tracker. virtual AZ::Outcome ActivateMode( - const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) = 0; + const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo, ViewportEditorMode mode) = 0; - //! Deactivates the specified editor mode for the specified viewport. + //! Deactivates the specified editor mode for the specified viewport editor mode tracker. virtual AZ::Outcome DeactivateMode( - const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) = 0; + const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo, 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; + //! Attempts to retrieve the editor mode state for the specified viewport editor mode tracker, otherwise returns nullptr. + virtual const ViewportEditorModesInterface* GetViewportEditorModes(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo) const = 0; - //! Returns the number of viewports currently being tracked. + //! Returns the number of viewport editor mode trackers. virtual size_t GetTrackedViewportCount() const = 0; - //! Returns true if the specified viewport is being tracked, otherwise false. - virtual bool IsViewportModeTracked(const ViewportEditorModeInfo& viewportEditorModeInfo) const = 0; + //! Returns true if viewport editor modes are being tracked for the specified od, otherwise false. + virtual bool IsViewportModeTracked(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo) const = 0; }; } // namespace AzToolsFramework diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h b/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h index 1f05e869f1..4fcb891e61 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/API/ViewportEditorModeTrackerNotificationBus.h @@ -24,7 +24,7 @@ namespace AzToolsFramework }; //! Viewport editor mode tracker identifier and other relevant data. - struct ViewportEditorModeInfo + struct ViewportEditorModeTrackerInfo { using IdType = AzFramework::EntityContextId; IdType m_id = AzFramework::EntityContextId::CreateNull(); //!< The unique identifier for a given viewport editor mode tracker. @@ -49,7 +49,7 @@ namespace AzToolsFramework // EBusTraits overrides static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Multiple; static const AZ::EBusAddressPolicy AddressPolicy = AZ::EBusAddressPolicy::ById; - using BusIdType = ViewportEditorModeInfo::IdType; + using BusIdType = ViewportEditorModeTrackerInfo::IdType; ////////////////////////////////////////////////////////////////////////// //! Notifies subscribers of the a given viewport to the activation of the specified editor mode. diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.cpp b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.cpp index 05b645f52c..d3cfa47e51 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.cpp +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.cpp @@ -46,14 +46,14 @@ namespace AzToolsFramework } AZ::Outcome ViewportEditorModeTracker::ActivateMode( - const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) + const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo, ViewportEditorMode mode) { - auto& editorModes = m_viewportEditorModesMap[viewportEditorModeInfo.m_id]; + auto& editorModes = m_viewportEditorModesMap[ViewportEditorModeTrackerInfo.m_id]; if (editorModes.IsModeActive(mode)) { return AZ::Failure(AZStd::string::format( "Duplicate call to ActivateMode for mode '%u' on id '%s'", static_cast(mode), - viewportEditorModeInfo.m_id.ToString().c_str())); + ViewportEditorModeTrackerInfo.m_id.ToString().c_str())); } if (const auto result = editorModes.ActivateMode(mode); @@ -63,30 +63,30 @@ namespace AzToolsFramework } ViewportEditorModeNotificationsBus::Event( - viewportEditorModeInfo.m_id, &ViewportEditorModeNotificationsBus::Events::OnEditorModeActivated, editorModes, mode); + ViewportEditorModeTrackerInfo.m_id, &ViewportEditorModeNotificationsBus::Events::OnEditorModeActivated, editorModes, mode); return AZ::Success(); } AZ::Outcome ViewportEditorModeTracker::DeactivateMode( - const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) + const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo, ViewportEditorMode mode) { ViewportEditorModes* editorModes = nullptr; bool modeWasActive = true; - if (m_viewportEditorModesMap.count(viewportEditorModeInfo.m_id)) + if (m_viewportEditorModesMap.count(ViewportEditorModeTrackerInfo.m_id)) { - editorModes = &m_viewportEditorModesMap.at(viewportEditorModeInfo.m_id); + editorModes = &m_viewportEditorModesMap.at(ViewportEditorModeTrackerInfo.m_id); if (!editorModes->IsModeActive(mode)) { return AZ::Failure(AZStd::string::format( "Duplicate call to DeactivateMode for mode '%u' on id '%s'", static_cast(mode), - viewportEditorModeInfo.m_id.ToString().c_str())); + ViewportEditorModeTrackerInfo.m_id.ToString().c_str())); } } else { modeWasActive = false; - editorModes = &m_viewportEditorModesMap[viewportEditorModeInfo.m_id]; + editorModes = &m_viewportEditorModesMap[ViewportEditorModeTrackerInfo.m_id]; } if(const auto result = editorModes->DeactivateMode(mode); @@ -96,7 +96,7 @@ namespace AzToolsFramework } ViewportEditorModeNotificationsBus::Event( - viewportEditorModeInfo.m_id, &ViewportEditorModeNotificationsBus::Events::OnEditorModeDeactivated, *editorModes, mode); + ViewportEditorModeTrackerInfo.m_id, &ViewportEditorModeNotificationsBus::Events::OnEditorModeDeactivated, *editorModes, mode); if (modeWasActive) { @@ -106,13 +106,13 @@ namespace AzToolsFramework { return AZ::Failure(AZStd::string::format( "Call to DeactivateMode for mode '%u' on id '%s' without precursor call to ActivateMode", static_cast(mode), - viewportEditorModeInfo.m_id.ToString().c_str())); + ViewportEditorModeTrackerInfo.m_id.ToString().c_str())); } } - const ViewportEditorModesInterface* ViewportEditorModeTracker::GetViewportEditorModes(const ViewportEditorModeInfo& viewportEditorModeInfo) const + const ViewportEditorModesInterface* ViewportEditorModeTracker::GetViewportEditorModes(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo) const { - if (auto editorModes = m_viewportEditorModesMap.find(viewportEditorModeInfo.m_id); + if (auto editorModes = m_viewportEditorModesMap.find(ViewportEditorModeTrackerInfo.m_id); editorModes != m_viewportEditorModesMap.end()) { return &editorModes->second; @@ -128,8 +128,8 @@ namespace AzToolsFramework return m_viewportEditorModesMap.size(); } - bool ViewportEditorModeTracker::IsViewportModeTracked(const ViewportEditorModeInfo& viewportEditorModeInfo) const + bool ViewportEditorModeTracker::IsViewportModeTracked(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo) const { - return m_viewportEditorModesMap.count(viewportEditorModeInfo.m_id) > 0; + return m_viewportEditorModesMap.count(ViewportEditorModeTrackerInfo.m_id) > 0; } } // namespace AzToolsFramework diff --git a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.h b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.h index 5b382c44e7..2efc0a66f7 100644 --- a/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.h +++ b/Code/Framework/AzToolsFramework/AzToolsFramework/ViewportSelection/ViewportEditorModeTracker.h @@ -42,14 +42,14 @@ namespace AzToolsFramework { public: // ViewportEditorModeTrackerInterface overrides ... - AZ::Outcome ActivateMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) override; - AZ::Outcome DeactivateMode(const ViewportEditorModeInfo& viewportEditorModeInfo, ViewportEditorMode mode) override; - const ViewportEditorModesInterface* GetViewportEditorModes(const ViewportEditorModeInfo& viewportEditorModeInfo) const override; + AZ::Outcome ActivateMode(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo, ViewportEditorMode mode) override; + AZ::Outcome DeactivateMode(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo, ViewportEditorMode mode) override; + const ViewportEditorModesInterface* GetViewportEditorModes(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo) const override; size_t GetTrackedViewportCount() const override; - bool IsViewportModeTracked(const ViewportEditorModeInfo& viewportEditorModeInfo) const override; + bool IsViewportModeTracked(const ViewportEditorModeTrackerInfo& ViewportEditorModeTrackerInfo) const override; private: - using ViewportEditorModesMap = AZStd::unordered_map; - ViewportEditorModesMap m_viewportEditorModesMap; //!< Editor mode state per viewport. + using ViewportEditorModesMap = AZStd::unordered_map; + ViewportEditorModesMap m_viewportEditorModesMap; //!< Editor mode states per tracker. }; } // namespace AzToolsFramework diff --git a/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp b/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp index 393a1e9055..50a1f8f21f 100644 --- a/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp +++ b/Code/Framework/AzToolsFramework/Tests/Viewport/ViewportEditorModeTests.cpp @@ -18,8 +18,8 @@ namespace UnitTest using ViewportEditorMode = AzToolsFramework::ViewportEditorMode; using ViewportEditorModes = AzToolsFramework::ViewportEditorModes; using ViewportEditorModeTracker = AzToolsFramework::ViewportEditorModeTracker; - using ViewportEditorModeInfo = AzToolsFramework::ViewportEditorModeInfo; - using TrackerId = ViewportEditorModeInfo::IdType; + using ViewportEditorModeTrackerInfo = AzToolsFramework::ViewportEditorModeTrackerInfo; + using TrackerId = ViewportEditorModeTrackerInfo::IdType; using ViewportEditorModesInterface = AzToolsFramework::ViewportEditorModesInterface; using ViewportEditorModeTrackerInterface = AzToolsFramework::ViewportEditorModeTrackerInterface;