Added setreg option to enable/disable centering mouse cursor in RobotecSpectatorCamera (#106)

* Added setreg option to enable/disable centering mouse cursor in RobotecSpectatorCamera

Signed-off-by: Patryk Antosz <[email protected]>

* Update Gems/RobotecSpectatorCamera/Code/Source/SpectatorCamera/SpectatorCameraComponent.cpp

Co-authored-by: Michał Pełka <[email protected]>

---------

Signed-off-by: Patryk Antosz <[email protected]>
Co-authored-by: Michał Pełka <[email protected]>

Author: patrykantosz

Gems/RobotecSpectatorCamera/Code/Source/SpectatorCamera/SpectatorCameraComponent.cpp

@@ -1,4 +1,7 @@
 #include "SpectatorCameraComponent.h"
+
+#include "AzCore/Settings/SettingsRegistry.h"
+
 #include <AzCore/Component/TransformBus.h>
 #include <AzCore/Math/MathUtils.h>
 #include <AzCore/Serialization/EditContext.h>
@@ -7,6 +10,8 @@
 
 namespace RobotecSpectatorCamera
 {
+    constexpr AZStd::string_view CenterTheCursorConfigurationKey = "/O3DE/SpectatorCamera/MoveCursorToTheCenter";
+
     SpectatorCameraComponent::SpectatorCameraComponent(
         const RobotecSpectatorCamera::SpectatorCameraConfiguration& spectatorCameraConfiguration)
         : m_configuration(spectatorCameraConfiguration)
@@ -31,6 +36,13 @@ namespace RobotecSpectatorCamera
         AzFramework::InputChannelEventListener::Connect();
 
         AZ::TransformBus::EventResult(m_currentTransform, GetEntityId(), &AZ::TransformBus::Events::GetWorldTM);
+
+        auto* registry = AZ::SettingsRegistry::Get();
+        AZ_Assert(registry, "No Registry available");
+        if (registry)
+        {
+            registry->Get(m_centerTheCursor, CenterTheCursorConfigurationKey);
+        }
     }
 
     void SpectatorCameraComponent::Deactivate()
@@ -106,7 +118,7 @@ namespace RobotecSpectatorCamera
                 SpectatorCameraConfiguration::OrbitRadiusMax);
         }
 
-        if (channelId == AzFramework::InputDeviceMouse::Button::Right || m_configuration.m_cameraMode == CameraMode::FreeFlying)
+        if (channelId == AzFramework::InputDeviceMouse::Button::Right && m_configuration.m_cameraMode == CameraMode::ThirdPerson)
         {
             AzFramework::SystemCursorState currentCursorState;
             AzFramework::InputSystemCursorRequestBus::EventResult(
@@ -131,14 +143,17 @@ namespace RobotecSpectatorCamera
             {
                 m_isRightMouseButtonPressed = false;
 
-                // Restore the cursor's original position
-                AzFramework::InputSystemCursorRequestBus::Event(
-                    AzFramework::InputDeviceMouse::Id,
-                    &AzFramework::InputSystemCursorRequests::SetSystemCursorPositionNormalized,
-                    m_initialMousePosition);
-
-                // Update m_lastMousePosition to the restored position to prevent the jump on the next rotation start
-                m_lastMousePosition = m_initialMousePosition;
+                if (m_centerTheCursor)
+                {
+                    // Restore the cursor's original position
+                    AzFramework::InputSystemCursorRequestBus::Event(
+                        AzFramework::InputDeviceMouse::Id,
+                        &AzFramework::InputSystemCursorRequests::SetSystemCursorPositionNormalized,
+                        m_initialMousePosition);
+
+                    // Update m_lastMousePosition to the restored position to prevent the jump on the next rotation start
+                    m_lastMousePosition = m_initialMousePosition;
+                }
                 AzFramework::InputSystemCursorRequestBus::Event(
                     AzFramework::InputDeviceMouse::Id,
                     &AzFramework::InputSystemCursorRequests::SetSystemCursorState,
@@ -160,16 +175,23 @@ namespace RobotecSpectatorCamera
             AZ::Vector2 currentMousePosition = GetCurrentMousePosition();
             AZ::Vector2 mouseDelta = currentMousePosition - m_lastMousePosition;
 
-            RotateCameraOnMouse(mouseDelta);
+            if (m_centerTheCursor)
+            {
+                const auto center = AZ::Vector2(0.5f, 0.5f);
 
-            const auto center = AZ::Vector2(0.5f, 0.5f);
+                // Recenter the cursor to avoid edge constraints
+                AzFramework::InputSystemCursorRequestBus::Event(
+                    AzFramework::InputDeviceMouse::Id, &AzFramework::InputSystemCursorRequests::SetSystemCursorPositionNormalized, center);
 
-            // Recenter the cursor to avoid edge constraints
-            AzFramework::InputSystemCursorRequestBus::Event(
-                AzFramework::InputDeviceMouse::Id, &AzFramework::InputSystemCursorRequests::SetSystemCursorPositionNormalized, center);
+                // Then update m_lastMousePosition accordingly
+                m_lastMousePosition = center;
+            }
+            else
+            {
+                m_lastMousePosition = currentMousePosition;
+            }
 
-            // Then update m_lastMousePosition accordingly
-            m_lastMousePosition = center;
+            RotateCameraOnMouse(mouseDelta);
         }
     }
 
@@ -275,6 +297,9 @@ namespace RobotecSpectatorCamera
 
     void SpectatorCameraComponent::ToggleCameraMode()
     {
+        // RMB should be handled only in the ThirdPerson mode. This line fixes problem with such combination:
+        // RMB pressed -> Key C pressed -> FreeFlying -> RMB released -> Key C pressed -> ThirdPerson -> Camera rotates without pressing RMB
+        m_isRightMouseButtonPressed = false;
         if (m_configuration.m_cameraMode == CameraMode::ThirdPerson)
         {
             m_configuration.m_cameraMode = CameraMode::FreeFlying;

Gems/RobotecSpectatorCamera/Code/Source/SpectatorCamera/SpectatorCameraComponent.h

@@ -62,7 +62,8 @@ namespace RobotecSpectatorCamera
         float m_yaw{ 0.0f };
         bool m_isRightMouseButtonPressed{ false };
         bool m_ignoreNextMovement{ false };
-        AZ::Vector2 m_initialMousePosition;
+        bool m_centerTheCursor{ false };
+        AZ::Vector2 m_initialMousePosition{ AZ::Vector2::CreateZero() };
         AZ::Vector2 m_lastMousePosition{ AZ::Vector2::CreateZero() };
         AZ::Vector3 m_movement{ AZ::Vector3::CreateZero() };
         AZ::Vector2 m_rotation{ AZ::Vector2::CreateZero() };