Give MultiViewportControllerInstances a pointer to their parent controller, to allow state management

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

@@ -48,21 +48,28 @@ namespace AzFramework
     };
 
     //! The interface used by MultiViewportController to manage individual instances.
+    template <class TController>
     class MultiViewportControllerInstanceInterface
     {
     public:
-        explicit MultiViewportControllerInstanceInterface(ViewportId viewport)
+        using ControllerType = TController;
+
+        explicit MultiViewportControllerInstanceInterface(ViewportId viewport, TController* controller)
             : m_viewportId(viewport)
+            , m_controller(controller)
         {
         }
 
         ViewportId GetViewportId() const { return m_viewportId; }
+        TController* GetController() { return m_controller; }
+        const TController* GetController() const { return m_controller; }
 
         virtual bool HandleInputChannelEvent([[maybe_unused]]const ViewportControllerInputEvent& event) { return false; }
         virtual void ResetInputChannels() {}
         virtual void UpdateViewport([[maybe_unused]]const ViewportControllerUpdateEvent& event) {}
 
     private:
+        TController* m_controller;
         ViewportId m_viewportId;
     };
 } //namespace AzFramework

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

@@ -17,8 +17,8 @@ namespace AzFramework
     MultiViewportController<TViewportControllerInstance, Priority>::~MultiViewportController()
     {
         static_assert(
-            AZStd::is_constructible<TViewportControllerInstance, ViewportId>::value,
-            "TViewportControllerInstance must implement a TViewportControllerInstance(ViewportId) constructor"
+            AZStd::is_same<TViewportControllerInstance, decltype(TViewportControllerInstance(0, nullptr))>::value,
+            "TViewportControllerInstance must implement a TViewportControllerInstance(ViewportId, ViewportController) constructor"
         );
     }
 
@@ -50,7 +50,7 @@ namespace AzFramework
     template <class TViewportControllerInstance, ViewportControllerPriority Priority>
     void MultiViewportController<TViewportControllerInstance, Priority>::RegisterViewportContext(ViewportId viewport)
     {
-        m_instances[viewport] = AZStd::make_unique<TViewportControllerInstance>(viewport);
+        m_instances[viewport] = AZStd::make_unique<TViewportControllerInstance>(viewport, static_cast<TViewportControllerInstance::ControllerType*>(this));
     }
 
     template <class TViewportControllerInstance, ViewportControllerPriority Priority>

Code/Sandbox/Editor/LegacyViewportCameraController.cpp

@@ -28,8 +28,8 @@
 namespace SandboxEditor
 {
 
-LegacyViewportCameraControllerInstance::LegacyViewportCameraControllerInstance(AzFramework::ViewportId viewportId)
-    : AzFramework::MultiViewportControllerInstanceInterface(viewportId)
+LegacyViewportCameraControllerInstance::LegacyViewportCameraControllerInstance(AzFramework::ViewportId viewportId, LegacyViewportCameraController* controller)
+    : AzFramework::MultiViewportControllerInstanceInterface<LegacyViewportCameraController>(viewportId, controller)
 {
 }
 

Code/Sandbox/Editor/LegacyViewportCameraController.h

@@ -28,11 +28,14 @@ namespace AzFramework
 
 namespace SandboxEditor
 {
+    class LegacyViewportCameraControllerInstance;
+    using LegacyViewportCameraController = AzFramework::MultiViewportController<LegacyViewportCameraControllerInstance>;
+
     class LegacyViewportCameraControllerInstance final
-        : public AzFramework::MultiViewportControllerInstanceInterface
+        : public AzFramework::MultiViewportControllerInstanceInterface<LegacyViewportCameraController>
     {
     public:
-        explicit LegacyViewportCameraControllerInstance(AzFramework::ViewportId viewport);
+        LegacyViewportCameraControllerInstance(AzFramework::ViewportId viewport, LegacyViewportCameraController* controller);
 
         bool HandleInputChannelEvent(const AzFramework::ViewportControllerInputEvent& event) override;
         void ResetInputChannels() override;
@@ -69,5 +72,4 @@ namespace SandboxEditor
         bool m_capturingCursor = false;
     };
 
-    using LegacyViewportCameraController = AzFramework::MultiViewportController<LegacyViewportCameraControllerInstance>;
 } //namespace SandboxEditor

Code/Sandbox/Editor/ModernViewportCameraController.cpp

@@ -37,10 +37,9 @@ namespace SandboxEditor
         return viewportContext;
     }
 
-    ModernViewportCameraControllerInstance::ModernViewportCameraControllerInstance(const AzFramework::ViewportId viewportId)
-        : MultiViewportControllerInstanceInterface(viewportId)
+    AzFramework::Cameras ModernViewportCameraController::GetCameras() const
     {
-        // LYN-2315 TODO - move setup out of constructor, pass cameras in
+        AzFramework::Cameras cameras;
         auto firstPersonRotateCamera = AZStd::make_shared<AzFramework::RotateCameraInput>(AzFramework::InputDeviceMouse::Button::Right);
         auto firstPersonPanCamera = AZStd::make_shared<AzFramework::PanCameraInput>(AzFramework::LookPan);
         auto firstPersonTranslateCamera = AZStd::make_shared<AzFramework::TranslateCameraInput>(AzFramework::LookTranslation);
@@ -58,11 +57,19 @@ namespace SandboxEditor
         orbitCamera->m_orbitCameras.AddCamera(orbitDollyMoveCamera);
         orbitCamera->m_orbitCameras.AddCamera(orbitPanCamera);
 
-        m_cameraSystem.m_cameras.AddCamera(firstPersonRotateCamera);
-        m_cameraSystem.m_cameras.AddCamera(firstPersonPanCamera);
-        m_cameraSystem.m_cameras.AddCamera(firstPersonTranslateCamera);
-        m_cameraSystem.m_cameras.AddCamera(firstPersonWheelCamera);
-        m_cameraSystem.m_cameras.AddCamera(orbitCamera);
+        cameras.AddCamera(firstPersonRotateCamera);
+        cameras.AddCamera(firstPersonPanCamera);
+        cameras.AddCamera(firstPersonTranslateCamera);
+        cameras.AddCamera(firstPersonWheelCamera);
+        cameras.AddCamera(orbitCamera);
+        return AZStd::move(cameras);
+    }
+
+    ModernViewportCameraControllerInstance::ModernViewportCameraControllerInstance(const AzFramework::ViewportId viewportId, ModernViewportCameraController* controller)
+        : MultiViewportControllerInstanceInterface<ModernViewportCameraController>(viewportId, controller)
+    {
+        // LYN-2315 TODO - move setup out of constructor, pass cameras in
+        m_cameraSystem.m_cameras = controller->GetCameras();
 
         if (const auto viewportContext = RetrieveViewportContext(viewportId))
         {

Code/Sandbox/Editor/ModernViewportCameraController.h

@@ -17,10 +17,17 @@
 
 namespace SandboxEditor
 {
-    class ModernViewportCameraControllerInstance final : public AzFramework::MultiViewportControllerInstanceInterface
+    class ModernViewportCameraControllerInstance;
+    class ModernViewportCameraController : public AzFramework::MultiViewportController<ModernViewportCameraControllerInstance>
     {
     public:
-        explicit ModernViewportCameraControllerInstance(AzFramework::ViewportId viewportId);
+        AzFramework::Cameras GetCameras() const;
+    };
+
+    class ModernViewportCameraControllerInstance final : public AzFramework::MultiViewportControllerInstanceInterface<ModernViewportCameraController>
+    {
+    public:
+        explicit ModernViewportCameraControllerInstance(AzFramework::ViewportId viewportId, ModernViewportCameraController* controller);
 
         // MultiViewportControllerInstanceInterface overrides ...
         bool HandleInputChannelEvent(const AzFramework::ViewportControllerInputEvent& event) override;
@@ -32,6 +39,4 @@ namespace SandboxEditor
         AzFramework::SmoothProps m_smoothProps;
         AzFramework::CameraSystem m_cameraSystem;
     };
-
-    using ModernViewportCameraController = AzFramework::MultiViewportController<ModernViewportCameraControllerInstance>;
 } // namespace SandboxEditor

Code/Sandbox/Editor/ViewportManipulatorController.cpp

@@ -27,8 +27,8 @@ static const auto InteractionPriority = AzFramework::ViewportControllerPriority:
 namespace SandboxEditor
 {
 
-ViewportManipulatorControllerInstance::ViewportManipulatorControllerInstance(AzFramework::ViewportId viewport)
-    : AzFramework::MultiViewportControllerInstanceInterface(viewport)
+ViewportManipulatorControllerInstance::ViewportManipulatorControllerInstance(AzFramework::ViewportId viewport, ViewportManipulatorController* controller)
+    : AzFramework::MultiViewportControllerInstanceInterface<ViewportManipulatorController>(viewport, controller)
 {
 }
 

Code/Sandbox/Editor/ViewportManipulatorController.h

@@ -19,11 +19,14 @@
 
 namespace SandboxEditor
 {
+    class ViewportManipulatorControllerInstance;
+    using ViewportManipulatorController = AzFramework::MultiViewportController<ViewportManipulatorControllerInstance, AzFramework::ViewportControllerPriority::DispatchToAllPriorities>;
+
     class ViewportManipulatorControllerInstance final
-        : public AzFramework::MultiViewportControllerInstanceInterface
+        : public AzFramework::MultiViewportControllerInstanceInterface<ViewportManipulatorController>
     {
     public:
-        explicit ViewportManipulatorControllerInstance(AzFramework::ViewportId viewport);
+        explicit ViewportManipulatorControllerInstance(AzFramework::ViewportId viewport, ViewportManipulatorController* controller);
 
         bool HandleInputChannelEvent(const AzFramework::ViewportControllerInputEvent& event) override;
         void ResetInputChannels() override;
@@ -40,6 +43,4 @@ namespace SandboxEditor
         AZStd::unordered_map<AzToolsFramework::ViewportInteraction::MouseButton, AZ::ScriptTimePoint> m_pendingDoubleClicks;
         AZ::ScriptTimePoint m_curTime;
     };
-
-    using ViewportManipulatorController = AzFramework::MultiViewportController<ViewportManipulatorControllerInstance, AzFramework::ViewportControllerPriority::DispatchToAllPriorities>;
 } //namespace SandboxEditor