Use better SDL mouse binding routines - now smoothly slides along edges instead of spazzing

Change UInputMan::ForceMouseWithinBox to be relative to the current mouse bounds

Author: MaximDude

Managers/UInputMan.cpp

@@ -38,6 +38,7 @@ namespace RTE {
 		m_MouseSensitivity = 0.6F;
 		m_MouseWheelChange = 0;
 		m_TrapMousePos = false;
+		m_PlayerScreenMouseBounds = { 0, 0, 0, 0 };
 		m_MouseTrapRadius = 350;
 		m_LastDeviceWhichControlledGUICursor = InputDevice::DEVICE_KEYB_ONLY;
 		m_DisableKeyboard = false;
@@ -120,6 +121,14 @@ namespace RTE {
 				m_NumJoysticks++;
 			}
 		}
+
+		m_PlayerScreenMouseBounds = {
+			0,
+			0,
+			g_FrameMan.GetPlayerFrameBufferWidth(Players::NoPlayer) * g_WindowMan.GetResMultiplier(),
+			g_FrameMan.GetPlayerFrameBufferHeight(Players::NoPlayer) * g_WindowMan.GetResMultiplier()
+		};
+
 		return 0;
 	}
 
@@ -372,50 +381,64 @@ namespace RTE {
 
 	void UInputMan::ForceMouseWithinBox(int x, int y, int width, int height, int whichPlayer) const {
 		// Only mess with the mouse if the original mouse position is not above the screen and may be grabbing the title bar of the game window.
-		if (g_WindowMan.AnyWindowHasFocus() && !m_DisableMouseMoving && !m_TrapMousePos && (whichPlayer == Players::NoPlayer || m_ControlScheme.at(whichPlayer).GetDevice() == InputDevice::DEVICE_MOUSE_KEYB)) {
-			int mousePosX = m_AbsoluteMousePos.GetFloorIntX();
-			int mousePosY = m_AbsoluteMousePos.GetFloorIntY();
-
-			// -1 because the max mouse position inside the window is -1 its dimensions.
-			int rightMostPos = x + width - 1;
-			int bottomMostPos = y + height - 1;
-
-			if (mousePosX <= x || mousePosX >= rightMostPos || mousePosY <= y || mousePosY >= bottomMostPos) {
-				int limitX = std::clamp(mousePosX, x, rightMostPos);
-				int limitY = std::clamp(mousePosY, y, bottomMostPos);
-				SDL_WarpMouseInWindow(g_WindowMan.GetWindow(), limitX, limitY);
+		if (g_WindowMan.AnyWindowHasFocus() && !m_DisableMouseMoving && !m_TrapMousePos && (whichPlayer == Players::NoPlayer || m_ControlScheme[whichPlayer].GetDevice() == InputDevice::DEVICE_MOUSE_KEYB)) {
+			int rightMostPos = m_PlayerScreenMouseBounds.x + m_PlayerScreenMouseBounds.w;
+			int bottomMostPos = m_PlayerScreenMouseBounds.y + m_PlayerScreenMouseBounds.h;
+
+			SDL_Rect newMouseBounds = {
+				std::clamp(m_PlayerScreenMouseBounds.x + x, m_PlayerScreenMouseBounds.x, rightMostPos),
+				std::clamp(m_PlayerScreenMouseBounds.y + y, m_PlayerScreenMouseBounds.y, bottomMostPos),
+				std::clamp(width, 0, rightMostPos - x),
+				std::clamp(height, 0, bottomMostPos - y)
+			};
+
+			if (newMouseBounds.x >= rightMostPos || newMouseBounds.y >= bottomMostPos) {
+				g_ConsoleMan.PrintString("ERROR: Trying to force mouse wihin a box that is outside the player screen bounds!");
+				newMouseBounds = m_PlayerScreenMouseBounds;
 			}
+			SDL_SetWindowMouseRect(g_WindowMan.GetWindow(), &newMouseBounds);
 		}
 	}
 
 /////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
 
-	void UInputMan::ForceMouseWithinPlayerScreen(int whichPlayer) const {
-		if (whichPlayer >= Players::PlayerOne && whichPlayer < Players::MaxPlayerCount) {
-			int screenWidth = g_FrameMan.GetPlayerFrameBufferWidth(whichPlayer) * g_WindowMan.GetResMultiplier();
-			int screenHeight = g_FrameMan.GetPlayerFrameBufferHeight(whichPlayer) * g_WindowMan.GetResMultiplier();
+	void UInputMan::ForceMouseWithinPlayerScreen(bool force, int whichPlayer) {
+		int resMultiplier = g_WindowMan.GetResMultiplier();
+
+		if (force && (whichPlayer >= Players::PlayerOne && whichPlayer < Players::MaxPlayerCount)) {
+			int screenWidth = g_FrameMan.GetPlayerFrameBufferWidth(whichPlayer) * resMultiplier;
+			int screenHeight = g_FrameMan.GetPlayerFrameBufferHeight(whichPlayer) * resMultiplier;
 
 			switch (g_ActivityMan.GetActivity()->ScreenOfPlayer(whichPlayer)) {
 				case 0:
-					ForceMouseWithinBox(0, 0, screenWidth, screenHeight, whichPlayer);
+					m_PlayerScreenMouseBounds = { 0, 0, screenWidth, screenHeight };
 					break;
 				case 1:
 					if (g_FrameMan.GetVSplit()) {
-						ForceMouseWithinBox(screenWidth, 0, screenWidth, screenHeight, whichPlayer);
+						m_PlayerScreenMouseBounds = { screenWidth, 0, screenWidth, screenHeight };
 					} else {
-						ForceMouseWithinBox(0, screenHeight, screenWidth, screenHeight, whichPlayer);
+						m_PlayerScreenMouseBounds = { 0, screenHeight, screenWidth, screenHeight };
 					}
 					break;
 				case 2:
-					ForceMouseWithinBox(0, screenHeight, screenWidth, screenHeight, whichPlayer);
+					m_PlayerScreenMouseBounds = { 0, screenHeight, screenWidth, screenHeight };
 					break;
 				case 3:
-					ForceMouseWithinBox(screenWidth, screenHeight, screenWidth, screenHeight, whichPlayer);
+					m_PlayerScreenMouseBounds = { screenWidth, screenHeight, screenWidth, screenHeight };
 					break;
 				default:
-					// ScreenOfPlayer will return -1 for inactive player so do nothing.
-					break;
+					force = false;
 			}
+		} else {
+			force = false;
+		}
+
+		if (force) {
+			SDL_SetWindowMouseRect(g_WindowMan.GetWindow(), &m_PlayerScreenMouseBounds);
+		} else {
+			// Set the mouse bounds to the whole window so ForceMouseWithinBox is not stuck being relative to some player screen, because it can still bind the mouse even if this doesn't.
+			m_PlayerScreenMouseBounds = { 0, 0, g_WindowMan.GetResX() * resMultiplier, g_WindowMan.GetResY() * resMultiplier };
+			SDL_SetWindowMouseRect(g_WindowMan.GetWindow(), nullptr);
 		}
 	}
 
@@ -982,14 +1005,9 @@ namespace RTE {
 			m_AnalogMouseData.CapMagnitude(m_MouseTrapRadius);
 
 			// Only mess with the mouse pos if the original mouse position is not above the screen and may be grabbing the title bar of the game window
-			if (!m_DisableMouseMoving && !IsInMultiplayerMode()) {
-				if (m_TrapMousePos && g_WindowMan.AnyWindowHasFocus()) {
-					// Trap the (invisible) mouse cursor in the middle of the screen, so it doesn't fly out in windowed mode and some other window gets clicked
-					// SDL_WarpMouseInWindow(g_FrameMan.GetWindow(), g_WindowMan.GetResX() / 2, g_WindowMan.GetResY() / 2);
-				} else if (g_ActivityMan.IsInActivity()) {
-					// The mouse cursor is visible and can move about the screen/window, but it should still be contained within the mouse player's part of the window
-					ForceMouseWithinPlayerScreen(mousePlayer);
-				}
+			if (g_WindowMan.AnyWindowHasFocus() && !IsInMultiplayerMode() && !m_DisableMouseMoving && !m_TrapMousePos) {
+				// The mouse cursor is visible and can move about the screen/window, but it should still be contained within the mouse player's part of the window
+				ForceMouseWithinPlayerScreen(g_ActivityMan.IsInActivity(), mousePlayer);
 			}
 
 			// Enable the mouse cursor positioning again after having been disabled. Only do this when the mouse is within the drawing area so it

Managers/UInputMan.h

@@ -10,6 +10,10 @@
 
 #define g_UInputMan UInputMan::Instance()
 
+extern "C" {
+	struct SDL_Rect;
+}
+
 namespace RTE {
 
 	class Icon;
@@ -411,20 +415,12 @@ namespace RTE {
 		/// <summary>
 		/// Forces the mouse within a box on the screen.
 		/// </summary>
-		/// <param name="x">X value of the top left corner of the screen box to keep the mouse within, in screen coordinates.</param>
-		/// <param name="y">Y value of the top left corner of the screen box to keep the mouse within, in screen coordinates.</param>
+		/// <param name="x">X value of the top left corner of the screen box to keep the mouse within, relative to the top left corner of the player's screen.</param>
+		/// <param name="y">Y value of the top left corner of the screen box to keep the mouse within, relative to the top left corner of the player's screen.</param>
 		/// <param name="width">The width of the box.</param>
 		/// <param name="height">The height of the box.</param>
 		/// <param name="whichPlayer">Which player is trying to control the mouse. Only the player with actual control over the mouse will be affected. -1 means do it regardless of player.</param>
-		void ForceMouseWithinBox(int x, int y, int width, int height, int whichPlayer = -1) const;
-
-		/// <summary>
-		/// Forces the mouse within a specific player's screen area.
-		/// Player 1 will always be in the upper-left corner, Player 3 will always be in the lower-left corner, Player 4 will always be in the lower-right quadrant.
-		/// Player 2 will either be in the lower-left corner or the upper-right corner depending on vertical/horizontal splitting.
-		/// </summary>
-		/// <param name="whichPlayer">Which player's screen to constrain the mouse to. Only the player with actual control over the mouse will be affected.</param>
-		void ForceMouseWithinPlayerScreen(int whichPlayer) const;
+		void ForceMouseWithinBox(int x, int y, int width, int height, int whichPlayer = Players::NoPlayer) const;
 #pragma endregion
 
 #pragma region Joystick Handling
@@ -689,6 +685,7 @@ namespace RTE {
 
 		bool m_TrapMousePos; //!< Whether the mouse is trapped in the middle of the screen each update or not.
 		float m_MouseTrapRadius; //!< The radius (in pixels) of the circle trapping the mouse for analog mouse data.
+		SDL_Rect m_PlayerScreenMouseBounds; //!< Rect with the position and dimensions of the player screen that the mouse is bound to, when bounding is enabled.
 
 		InputDevice m_LastDeviceWhichControlledGUICursor; //!< Indicates which device controlled the cursor last time.
 
@@ -715,6 +712,16 @@ namespace RTE {
 		static constexpr int c_AxisDigitalPressedThreshold = 8192; //!< Digital Axis threshold value as defined by allegro.
 		static constexpr int c_AxisDigitalReleasedThreshold = c_AxisDigitalPressedThreshold - 100; //!< Digital Axis release threshold, to debounce values.
 
+#pragma region Mouse Handling
+		/// <summary>
+		/// Forces the mouse within a specific player's screen area.
+		/// Player 1 will always be in the upper-left corner, Player 3 will always be in the lower-left corner, Player 4 will always be in the lower-right quadrant.
+		/// Player 2 will either be in the lower-left corner or the upper-right corner depending on vertical/horizontal splitting.
+		/// </summary>
+		/// <param name="whichPlayer">Which player's screen to constrain the mouse to. Only the player with actual control over the mouse will be affected.</param>
+		void ForceMouseWithinPlayerScreen(bool force, int whichPlayer);
+#pragma endregion
+
 #pragma region Input State Handling
 		/// <summary>
 		/// Gets whether an input element is in the specified state.