Merge pull request #184 from aws-lumberyard-dev/nvsickle/CherryPickMoreViewportFixes

Cherry-pick viewport fixes to main

Code/Framework/AzFramework/AzFramework/Viewport/MultiViewportController.h

@@ -37,6 +37,7 @@ namespace AzFramework
 
         // ViewportControllerInterface ...
         bool HandleInputChannelEvent(const ViewportControllerInputEvent& event) override;
+        void ResetInputChannels() override;
         void UpdateViewport(const ViewportControllerUpdateEvent& event) override;
         void RegisterViewportContext(ViewportId viewport) override;
         void UnregisterViewportContext(ViewportId viewport) override;
@@ -58,6 +59,7 @@ namespace AzFramework
         ViewportId GetViewportId() const { return m_viewportId; }
 
         virtual bool HandleInputChannelEvent([[maybe_unused]]const ViewportControllerInputEvent& event) { return false; }
+        virtual void ResetInputChannels() {}
         virtual void UpdateViewport([[maybe_unused]]const ViewportControllerUpdateEvent& event) {}
 
     private:

Code/Framework/AzFramework/AzFramework/Viewport/MultiViewportController.inl

@@ -30,6 +30,15 @@ namespace AzFramework
         return instanceIt->second->HandleInputChannelEvent(event);
     }
 
+    template <class TViewportControllerInstance, ViewportControllerPriority Priority>
+    void MultiViewportController<TViewportControllerInstance, Priority>::ResetInputChannels()
+    {
+        for (auto instanceIt = m_instances.begin(); instanceIt != m_instances.end(); ++instanceIt)
+        {
+            instanceIt->second->ResetInputChannels();
+        }
+    }
+
     template <class TViewportControllerInstance, ViewportControllerPriority Priority>
     void MultiViewportController<TViewportControllerInstance, Priority>::UpdateViewport(const ViewportControllerUpdateEvent& event)
     {

Code/Framework/AzFramework/AzFramework/Viewport/ViewportControllerList.cpp

@@ -49,6 +49,11 @@ namespace AzFramework
 
     bool ViewportControllerList::HandleInputChannelEvent(const AzFramework::ViewportControllerInputEvent& event)
     {
+        if (!IsEnabled())
+        {
+            return false;
+        }
+
         // If our event priority is "custom", we should dispatch at all priority levels in order
         using AzFramework::ViewportControllerPriority;
         if (event.m_priority == AzFramework::ViewportControllerPriority::DispatchToAllPriorities)
@@ -76,6 +81,23 @@ namespace AzFramework
         }
     }
 
+    void ViewportControllerList::ResetInputChannels()
+    {
+        // We don't need to send this while we're disabled, we're guaranteed to call ResetInputChannels after being re-enabled.
+        if (!IsEnabled())
+        {
+            return;
+        }
+
+        for (const auto& controllerList : m_controllers)
+        {
+            for (const auto& controller : controllerList.second)
+            {
+                controller->ResetInputChannels();
+            }
+        }
+    }
+
     bool ViewportControllerList::DispatchInputChannelEvent(const AzFramework::ViewportControllerInputEvent& event)
     {
         if (auto priorityListIt = m_controllers.find(event.m_priority); priorityListIt != m_controllers.end())
@@ -106,6 +128,11 @@ namespace AzFramework
 
     void ViewportControllerList::UpdateViewport(const AzFramework::ViewportControllerUpdateEvent& event)
     {
+        if (!IsEnabled())
+        {
+            return;
+        }
+
         // If our event priority is "custom", we should dispatch at all priority levels in reverse order
         // Reverse order lets high priority controllers get the last say in viewport update operations
         using AzFramework::ViewportControllerPriority;
@@ -174,4 +201,22 @@ namespace AzFramework
             }
         }
     }
+
+    bool ViewportControllerList::IsEnabled() const
+    {
+        return m_enabled;
+    }
+
+    void ViewportControllerList::SetEnabled(bool enabled)
+    {
+        if (m_enabled != enabled)
+        {
+            m_enabled = enabled;
+            // If we've been re-enabled, reset our input channels as they may have missed state changes.
+            if (m_enabled)
+            {
+                ResetInputChannels();
+            }
+        }
+    }
 } //namespace AzFramework

Code/Framework/AzFramework/AzFramework/Viewport/ViewportControllerList.h

@@ -37,6 +37,9 @@ namespace AzFramework
         //! either a controller returns true to consume the event in OnInputChannelEvent or the controller list is exhausted.
         //! InputChannelEvents are sent to controllers in priority order (from the lowest priority value to the highest).
         bool HandleInputChannelEvent(const AzFramework::ViewportControllerInputEvent& event) override;
+        //! Dispatches a ResetInputChannels call to all controllers registered to this list.
+        //! Calls to controllers are made in an undefined order.
+        void ResetInputChannels() override;
         //! Dispatches an update tick to all controllers registered to this list.
         //! This occurs in *reverse* priority order (i.e. from the highest priority value to the lowest) so that
         //! controllers with the highest registration priority may override the transforms of the controllers with the
@@ -50,6 +53,12 @@ namespace AzFramework
         //! All ViewportControllerLists have a priority of Custom to ensure
         //! that they receive events at all priorities from any parent controllers.
         AzFramework::ViewportControllerPriority GetPriority() const { return ViewportControllerPriority::DispatchToAllPriorities; }
+        //! Returns true if this controller list is enabled, i.e.
+        //! it is accepting and forwarding input and update events to its children.
+        bool IsEnabled() const;
+        //! Set this controller list's enabled state.
+        //! If a controller list is disabled, it will ignore all input and update events rather than dispatching them to its children.
+        void SetEnabled(bool enabled);
 
     private:
         void SortControllers();
@@ -58,5 +67,6 @@ namespace AzFramework
 
         AZStd::unordered_map<AzFramework::ViewportControllerPriority, AZStd::vector<ViewportControllerPtr>> m_controllers;
         AZStd::unordered_set<ViewportId> m_viewports;
+        bool m_enabled = true;
     };
 } //namespace AzFramework