Add support for camera reference frames to support camera yaw in certain situations (#4088)

* proof of concept change for fixing camera yaw rotation being ignored Signed-off-by: hultonha <hultonha@amazon.co.uk> * updates to fully support camera roll Signed-off-by: hultonha <hultonha@amazon.co.uk> * small fixes for PR Signed-off-by: hultonha <hultonha@amazon.co.uk> * undo changes in EditorCameraComponent Signed-off-by: hultonha <hultonha@amazon.co.uk> * add test to verify interaction between editor viewport view entity change and modular camera controller Signed-off-by: hultonha <hultonha@amazon.co.uk> * add additional tests for updated camera behaviors Signed-off-by: hultonha <hultonha@amazon.co.uk> * revert change to Camera Gem Output Name Signed-off-by: hultonha <hultonha@amazon.co.uk> * move location of new files Signed-off-by: hultonha <hultonha@amazon.co.uk> * fix tab/spaces issue Signed-off-by: hultonha <hultonha@amazon.co.uk> * remove static from potentially unused functions Signed-off-by: hultonha <hultonha@amazon.co.uk> * set camera lib name in CMakeLists.txt file Signed-off-by: hultonha <hultonha@amazon.co.uk> * cosmetic CMakeLists.txt change Signed-off-by: hultonha <hultonha@amazon.co.uk>
2021-09-22 09:08:24 +01:00
parent 2c55ad5379
commit b865d2aec1
12 changed files with 418 additions and 36 deletions
@@ -30,6 +30,18 @@ namespace AtomToolsFramework
        "");
    AZ_CVAR(float, ed_cameraSystemOrbitPointSize, 0.1f, nullptr, AZ::ConsoleFunctorFlags::Null, "");

+    AZ::Transform TransformFromMatrix4x4(const AZ::Matrix4x4& matrix)
+    {
+        const auto rotation = AZ::Matrix3x3::CreateFromMatrix4x4(matrix);
+        const auto translation = matrix.GetTranslation();
+        return AZ::Transform::CreateFromMatrix3x3AndTranslation(rotation, translation);
+    }
+
+    AZ::Matrix4x4 Matrix4x4FromTransform(const AZ::Transform& transform)
+    {
+        return AZ::Matrix4x4::CreateFromQuaternionAndTranslation(transform.GetRotation(), transform.GetTranslation());
+    }
+
    // debug
    void DrawPreviewAxis(AzFramework::DebugDisplayRequests& display, const AZ::Transform& transform, const float axisLength)
    {
@@ -167,11 +179,19 @@ namespace AtomToolsFramework
        controller->SetupCameraControllerPriority(m_priorityFn);
        controller->SetupCameraControllerViewportContext(m_modularCameraViewportContext);

-        auto handleCameraChange = [this](const AZ::Matrix4x4&)
+        auto handleCameraChange = [this]([[maybe_unused]] const AZ::Matrix4x4& cameraView)
        {
            // ignore these updates if the camera is being updated internally
            if (!m_updatingTransformInternally)
            {
+                if (m_storedCamera.has_value())
+                {
+                    // if an external change occurs ensure we update the stored reference frame if one is set
+                    RefreshReferenceFrame();
+                    return;
+                }
+
+                m_previousCamera = m_targetCamera;
                UpdateCameraFromTransform(m_targetCamera, m_modularCameraViewportContext->GetCameraTransform());
                m_camera = m_targetCamera;
            }
@@ -231,7 +251,7 @@ namespace AtomToolsFramework
                }
            }

-            m_modularCameraViewportContext->SetCameraTransform(m_camera.Transform());
+            m_modularCameraViewportContext->SetCameraTransform(m_referenceFrameOverride * m_camera.Transform());
        }
        else if (m_cameraMode == CameraMode::Animation)
        {
@@ -240,6 +260,8 @@ namespace AtomToolsFramework
                return t * t * t * (t * (t * 6.0f - 15.0f) + 10.0f);
            };

+            m_cameraAnimation.m_time = AZ::GetClamp(m_cameraAnimation.m_time + event.m_deltaTime.count(), 0.0f, 1.0f);
+
            const auto& [transformStart, transformEnd, animationTime] = m_cameraAnimation;

            const float transitionTime = smootherStepFn(animationTime);
@@ -253,14 +275,13 @@ namespace AtomToolsFramework
            m_camera.m_lookAt = current.GetTranslation();
            m_targetCamera = m_camera;

+            m_modularCameraViewportContext->SetCameraTransform(current);
+
            if (animationTime >= 1.0f)
            {
                m_cameraMode = CameraMode::Control;
+                RefreshReferenceFrame();
            }
-
-            m_cameraAnimation.m_time = AZ::GetClamp(animationTime + event.m_deltaTime.count(), 0.0f, 1.0f);
-
-            m_modularCameraViewportContext->SetCameraTransform(current);
        }

        m_updatingTransformInternally = false;
@@ -280,7 +301,7 @@ namespace AtomToolsFramework
    void ModularViewportCameraControllerInstance::InterpolateToTransform(const AZ::Transform& worldFromLocal, const float lookAtDistance)
    {
        m_cameraMode = CameraMode::Animation;
-        m_cameraAnimation = CameraAnimation{ m_camera.Transform(), worldFromLocal, 0.0f };
+        m_cameraAnimation = CameraAnimation{ m_referenceFrameOverride * m_camera.Transform(), worldFromLocal, 0.0f };
        m_lookAtAfterInterpolation = worldFromLocal.GetTranslation() + worldFromLocal.GetBasisY() * lookAtDistance;
    }

@@ -288,4 +309,59 @@ namespace AtomToolsFramework
    {
        return m_lookAtAfterInterpolation;
    }
+
+    AZ::Transform ModularViewportCameraControllerInstance::GetReferenceFrame() const
+    {
+        return m_referenceFrameOverride;
+    }
+
+    void ModularViewportCameraControllerInstance::SetReferenceFrame(const AZ::Transform& worldFromLocal)
+    {
+        if (!m_storedCamera.has_value())
+        {
+            m_storedCamera = m_previousCamera;
+        }
+
+        m_referenceFrameOverride = worldFromLocal;
+        m_targetCamera.m_pitch = 0.0f;
+        m_targetCamera.m_yaw = 0.0f;
+        m_targetCamera.m_lookAt = AZ::Vector3::CreateZero();
+        m_targetCamera.m_lookDist = 0.0f;
+        m_camera = m_targetCamera;
+    }
+
+    void ModularViewportCameraControllerInstance::ClearReferenceFrame()
+    {
+        m_referenceFrameOverride = AZ::Transform::CreateIdentity();
+
+        if (m_storedCamera.has_value())
+        {
+            m_targetCamera = m_storedCamera.value();
+            m_camera = m_targetCamera;
+        }
+
+        m_storedCamera.reset();
+    }
+
+    void ModularViewportCameraControllerInstance::RefreshReferenceFrame()
+    {
+        m_referenceFrameOverride = m_modularCameraViewportContext->GetCameraTransform() * m_camera.Transform().GetInverse();
+    }
+
+    AZ::Transform PlaceholderModularCameraViewportContextImpl::GetCameraTransform() const
+    {
+        return m_cameraTransform;
+    }
+
+    void PlaceholderModularCameraViewportContextImpl::SetCameraTransform(const AZ::Transform& transform)
+    {
+        m_cameraTransform = transform;
+        m_viewMatrixChangedEvent.Signal(AzFramework::CameraViewFromCameraTransform(Matrix4x4FromTransform(transform)));
+    }
+
+    void PlaceholderModularCameraViewportContextImpl::ConnectViewMatrixChangedHandler(
+        AZ::RPI::ViewportContext::MatrixChangedEvent::Handler& handler)
+    {
+        handler.Connect(m_viewMatrixChangedEvent);
+    }
 } // namespace AtomToolsFramework