Merge pull request #2030 from Semphriss/mobile_control_improvements

Improved management of mobile controls + made them available on all platforms

Author: Semphriss

CMakeLists.txt

@@ -152,10 +152,13 @@ endif(WIN32)
 option(UBUNTU_TOUCH "Compile the project for an Ubuntu Touch target" OFF)
 
 # Mobile builds
+option(ENABLE_TOUCHSCREEN_SUPPORT "Enable on-screen controls and event detection for touchscreen devices" ON)
 if (UBUNTU_TOUCH)
-  option(ENABLE_TOUCHSCREEN_SUPPORT "Enable on-screen controls and event detection for touchscreen devices" ON)
+  option(SHOW_TOUCHSCREEN_CONTROLS "Show mobile controls by default" ON)
+  option(HIDE_NONMOBILE_OPTIONS "Hide options that are impractical on mobile devices (e. g. changing screen resolution)" ON)
 else()
-  option(ENABLE_TOUCHSCREEN_SUPPORT "Enable on-screen controls and event detection for touchscreen devices" OFF)
+  option(SHOW_TOUCHSCREEN_CONTROLS "Show mobile controls by default" OFF)
+  option(HIDE_NONMOBILE_OPTIONS "Hide options that are impractical on mobile devices (e. g. changing screen resolution)" OFF)
 endif()
 
 ## Add lots of dependencies to compiler switches

config.h.cmake

@@ -37,6 +37,8 @@
 
 #cmakedefine UBUNTU_TOUCH
 #cmakedefine ENABLE_TOUCHSCREEN_SUPPORT
+#cmakedefine SHOW_TOUCHSCREEN_CONTROLS
+#cmakedefine HIDE_NONMOBILE_OPTIONS
 
 #cmakedefine REMOVE_QUIT_BUTTON
 

data/images/engine/mobile/cheats.png

@@ -50,18 +50,23 @@ MobileController::MobileController() :
   m_right(false),
   m_jump(false),
   m_action(false),
+  m_cheats(false),
+  m_debug(false),
   m_escape(false),
-  m_bak_escape(false),
   m_old_up(false),
   m_old_down(false),
   m_old_left(false),
   m_old_right(false),
   m_old_jump(false),
   m_old_action(false),
+  m_old_cheats(false),
+  m_old_debug(false),
   m_old_escape(false),
   m_rect_directions(16.f, -144.f, 144.f, -16.f),
   m_rect_jump(-160.f, -80.f, -96.f, -16.f),
   m_rect_action(-80.f, -80.f, -16.f, -16.f),
+  m_rect_cheats(-160.f, 16.f, -96.f, 80.f),
+  m_rect_debug(-80.f, 16.f, -16.f, 80.f),
   m_rect_escape(16.f, 16.f, 64.f, 64.f),
   m_tex_dirs(Surface::from_file("/images/engine/mobile/direction.png")),
   m_tex_btn(Surface::from_file("/images/engine/mobile/button.png")),
@@ -73,6 +78,8 @@ MobileController::MobileController() :
   m_tex_rgt(Surface::from_file("/images/engine/mobile/direction_hightlight_right.png")),
   m_tex_jump(Surface::from_file("/images/engine/mobile/jump.png")),
   m_tex_action(Surface::from_file("/images/engine/mobile/action.png")),
+  m_tex_cheats(Surface::from_file("/images/engine/mobile/cheats.png")),
+  m_tex_debug(Surface::from_file("/images/engine/mobile/debug.png")),
   m_screen_width(),
   m_screen_height()
 {
@@ -87,25 +94,34 @@ MobileController::draw(DrawingContext& context)
   m_screen_width = context.get_width();
   m_screen_height = context.get_height();
 
-  context.color().draw_surface_scaled(m_tex_dirs, apply_corner(m_rect_directions, m_screen_width, m_screen_height), 1650);
+  context.color().draw_surface_scaled(m_tex_dirs, apply_corner(m_rect_directions, m_screen_width, m_screen_height), LAYER_GUI + 99);
 
   if (m_up)
-    context.color().draw_surface_scaled(m_tex_up, apply_corner(m_rect_directions, m_screen_width, m_screen_height), 1651);
+    context.color().draw_surface_scaled(m_tex_up, apply_corner(m_rect_directions, m_screen_width, m_screen_height), LAYER_GUI + 99);
   if (m_down)
-    context.color().draw_surface_scaled(m_tex_dwn, apply_corner(m_rect_directions, m_screen_width, m_screen_height), 1651);
+    context.color().draw_surface_scaled(m_tex_dwn, apply_corner(m_rect_directions, m_screen_width, m_screen_height), LAYER_GUI + 99);
   if (m_left)
-    context.color().draw_surface_scaled(m_tex_lft, apply_corner(m_rect_directions, m_screen_width, m_screen_height), 1651);
+    context.color().draw_surface_scaled(m_tex_lft, apply_corner(m_rect_directions, m_screen_width, m_screen_height), LAYER_GUI + 99);
   if (m_right)
-    context.color().draw_surface_scaled(m_tex_rgt, apply_corner(m_rect_directions, m_screen_width, m_screen_height), 1651);
+    context.color().draw_surface_scaled(m_tex_rgt, apply_corner(m_rect_directions, m_screen_width, m_screen_height), LAYER_GUI + 99);
 
-  context.color().draw_surface_scaled(m_action ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_action, m_screen_width, m_screen_height), 1650);
-  context.color().draw_surface_scaled(m_tex_action, apply_corner(m_rect_action, m_screen_width, m_screen_height), 1651);
+  context.color().draw_surface_scaled(m_action ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_action, m_screen_width, m_screen_height), LAYER_GUI + 99);
+  context.color().draw_surface_scaled(m_tex_action, apply_corner(m_rect_action, m_screen_width, m_screen_height), LAYER_GUI + 99);
 
-  context.color().draw_surface_scaled(m_jump ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_jump, m_screen_width, m_screen_height), 1650);
-  context.color().draw_surface_scaled(m_tex_jump, apply_corner(m_rect_jump, m_screen_width, m_screen_height), 1651);
+  context.color().draw_surface_scaled(m_jump ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_jump, m_screen_width, m_screen_height), LAYER_GUI + 99);
+  context.color().draw_surface_scaled(m_tex_jump, apply_corner(m_rect_jump, m_screen_width, m_screen_height), LAYER_GUI + 99);
 
-  context.color().draw_surface_scaled(m_bak_escape ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_escape, m_screen_width, m_screen_height), 1650);
-  context.color().draw_surface_scaled(m_tex_pause, apply_corner(m_rect_escape, m_screen_width, m_screen_height).grown(-8.f), 1650);
+  context.color().draw_surface_scaled(m_escape ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_escape, m_screen_width, m_screen_height), LAYER_GUI + 99);
+  context.color().draw_surface_scaled(m_tex_pause, apply_corner(m_rect_escape, m_screen_width, m_screen_height).grown(-8.f), LAYER_GUI + 99);
+
+  if (g_config->developer_mode)
+  {
+    context.color().draw_surface_scaled(m_cheats ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_cheats, m_screen_width, m_screen_height), LAYER_GUI + 99);
+    context.color().draw_surface_scaled(m_tex_cheats, apply_corner(m_rect_cheats, m_screen_width, m_screen_height), LAYER_GUI + 99);
+
+    context.color().draw_surface_scaled(m_debug ? m_tex_btn_press : m_tex_btn, apply_corner(m_rect_debug, m_screen_width, m_screen_height), LAYER_GUI + 99);
+    context.color().draw_surface_scaled(m_tex_debug, apply_corner(m_rect_debug, m_screen_width, m_screen_height), LAYER_GUI + 99);
+  }
 }
 
 void
@@ -120,9 +136,19 @@ MobileController::update()
   m_old_right = m_right;
   m_old_jump = m_jump;
   m_old_action = m_action;
+  m_old_cheats = m_cheats;
+  m_old_debug = m_debug;
   m_old_escape = m_escape;
 
-  m_up = m_down = m_left = m_right = m_jump = m_action = m_escape = false;
+  m_up = m_down = m_left = m_right = m_jump = m_action = m_cheats = m_debug = m_escape = false;
+
+  // Allow using on-screen controls with the mouse
+  int x, y;
+  auto buttons = SDL_GetMouseState(&x, &y);
+  if ((buttons & SDL_BUTTON_LMASK) != 0)
+  {
+    activate_widget_at_pos(static_cast<float>(x), static_cast<float>(y));
+  }
 
   // FIXME: This assumes that 1) there is only one touchscreen and 2) SuperTux
   // fills the whole screen
@@ -136,12 +162,6 @@ MobileController::update()
 
   int num_touches = SDL_GetNumTouchFingers(device);
 
-  // FIXME: There's some weird problem with the escape button specifically, which
-  // I had to patch a weird way. If someone in the future finds a fix to handle
-  // escaping on mobile properly, don't forget to remove those lines.
-  if (num_touches == 0)
-    m_bak_escape = false;
-
   for (int i = 0; i < num_touches; i++)
   {
     SDL_Finger* finger = SDL_GetTouchFinger(device, i);
@@ -159,13 +179,24 @@ MobileController::apply(Controller& controller) const
   if (!g_config->mobile_controls)
     return;
 
-  controller.set_control(Control::UP,     m_up     || (!m_old_up     && controller.hold(Control::UP)));
-  controller.set_control(Control::DOWN,   m_down   || (!m_old_down   && controller.hold(Control::DOWN)));
-  controller.set_control(Control::LEFT,   m_left   || (!m_old_left   && controller.hold(Control::LEFT)));
-  controller.set_control(Control::RIGHT,  m_right  || (!m_old_right  && controller.hold(Control::RIGHT)));
-  controller.set_control(Control::JUMP,   m_jump   || (!m_old_jump   && controller.hold(Control::JUMP)));
-  controller.set_control(Control::ACTION, m_action || (!m_old_action && controller.hold(Control::ACTION)));
-  controller.set_control(Control::ESCAPE, m_escape || (!m_old_escape && controller.hold(Control::ESCAPE)));
+  if (m_up != m_old_up)
+    controller.set_control(Control::UP, m_up);
+  if (m_down != m_old_down)
+    controller.set_control(Control::DOWN, m_down);
+  if (m_left != m_old_left)
+    controller.set_control(Control::LEFT, m_left);
+  if (m_right != m_old_right)
+    controller.set_control(Control::RIGHT, m_right);
+  if (m_jump != m_old_jump)
+    controller.set_control(Control::JUMP, m_jump);
+  if (m_action != m_old_action)
+    controller.set_control(Control::ACTION, m_action);
+  if (m_cheats != m_old_cheats)
+    controller.set_control(Control::CHEAT_MENU, m_cheats);
+  if (m_debug != m_old_debug)
+    controller.set_control(Control::DEBUG_MENU, m_debug);
+  if (m_escape != m_old_escape)
+    controller.set_control(Control::ESCAPE, m_escape);
 }
 
 void
@@ -182,20 +213,18 @@ MobileController::activate_widget_at_pos(float x, float y)
   if (apply_corner(m_rect_action, m_screen_width, m_screen_height).contains(pos))
     m_action = true;
 
-  // FIXME: Why do I need an extra variable (m_bak_escape) just for this one?
-  // Without it, pressing escape will toggle pressed() (not hold(), pressed())
-  // every single frame, apparently
-  if (apply_corner(m_rect_escape, m_screen_width, m_screen_height).contains(pos))
-  {
-    if (!m_bak_escape)
-      m_escape = true;
-    m_bak_escape = true;
-  }
-  else
+  if (g_config->developer_mode)
   {
-    m_bak_escape = false;
+    if (apply_corner(m_rect_cheats, m_screen_width, m_screen_height).contains(pos))
+      m_cheats = true;
+
+    if (apply_corner(m_rect_debug, m_screen_width, m_screen_height).contains(pos))
+      m_debug = true;
   }
 
+  if (apply_corner(m_rect_escape, m_screen_width, m_screen_height).contains(pos))
+    m_escape = true;
+
   Rectf applied = apply_corner(m_rect_directions, m_screen_width, m_screen_height);
   Rectf up = applied;
   up.set_bottom(up.get_bottom() - up.get_height() * 2.f / 3.f);

data/images/engine/mobile/debug.png

@@ -39,13 +39,14 @@ class MobileController final
   void activate_widget_at_pos(float x, float y);
 
 private:
-  bool m_up, m_down, m_left, m_right, m_jump, m_action, m_escape, m_bak_escape;
-  bool m_old_up, m_old_down, m_old_left, m_old_right, m_old_jump, m_old_action, m_old_escape;
+  bool m_up, m_down, m_left, m_right, m_jump, m_action, m_cheats, m_debug, m_escape;
+  bool m_old_up, m_old_down, m_old_left, m_old_right, m_old_jump, m_old_action, m_old_cheats, m_old_debug, m_old_escape;
 
-  const Rectf m_rect_directions, m_rect_jump, m_rect_action, m_rect_escape;
+  const Rectf m_rect_directions, m_rect_jump, m_rect_action, m_rect_cheats,
+              m_rect_debug, m_rect_escape;
   const SurfacePtr m_tex_dirs, m_tex_btn, m_tex_btn_press, m_tex_pause,
                    m_tex_up, m_tex_dwn, m_tex_lft, m_tex_rgt,
-                   m_tex_jump, m_tex_action;
+                   m_tex_jump, m_tex_action, m_tex_cheats, m_tex_debug;
 
   int m_screen_width, m_screen_height;
 

src/control/mobile_controller.cpp

@@ -255,7 +255,11 @@ Config::load()
     }
 
 #ifdef ENABLE_TOUCHSCREEN_SUPPORT
-    config_video_mapping->get("mobile_controls", mobile_controls);
+#ifdef SHOW_TOUCHSCREEN_CONTROLS
+    config_control_mapping->get("mobile_controls", mobile_controls, true);
+#else
+    config_control_mapping->get("mobile_controls", mobile_controls, false);
+#endif
 #endif
   }
 

src/control/mobile_controller.hpp

@@ -567,13 +567,6 @@ Main::launch_game(const CommandLineArguments& args)
     }
   }
 
-#ifdef UBUNTU_TOUCH
-  Dialog::show_message(_("The UBports version is under heavy development!\n"
-                         "If you encounter issues, PLEASE contact the maintainter\n"
-                         "at https://github.com/supertux/supertux/issues or on the\n"
-                         "Open Store's Telegram at https://open-store.io/telegram"));
-#endif
-
   m_screen_manager->run();
 }
 

src/supertux/gameconfig.cpp

@@ -102,7 +102,7 @@ OptionsMenu::OptionsMenu(bool complete) :
   // These values go from screen:640/projection:1600 to
   // screen:1600/projection:640 (i.e. 640, 800, 1024, 1280, 1600)
   magnifications.push_back(_("auto"));
-#ifndef ENABLE_TOUCHSCREEN_SUPPORT
+#ifndef HIDE_NONMOBILE_OPTIONS
   magnifications.push_back("40%");
   magnifications.push_back("50%");
   magnifications.push_back("62.5%");
@@ -354,7 +354,7 @@ OptionsMenu::OptionsMenu(bool complete) :
       .set_help(_("Select a profile to play with"));
   }
 
-#if !defined(ENABLE_TOUCHSCREEN_SUPPORT) && !defined(__EMSCRIPTEN__)
+#if !defined(HIDE_NONMOBILE_OPTIONS) && !defined(__EMSCRIPTEN__)
   add_toggle(MNID_FULLSCREEN,_("Window Resizable"), &g_config->window_resizable)
     .set_help(_("Allow window resizing, might require a restart to take effect"));
 
@@ -381,7 +381,7 @@ OptionsMenu::OptionsMenu(bool complete) :
   MenuItem& vsync = add_string_select(MNID_VSYNC, _("VSync"), &next_vsync, vsyncs);
   vsync.set_help(_("Set the VSync mode"));
 
-#if !defined(ENABLE_TOUCHSCREEN_SUPPORT) && !defined(__EMSCRIPTEN__)
+#if !defined(HIDE_NONMOBILE_OPTIONS) && !defined(__EMSCRIPTEN__)
   MenuItem& aspect = add_string_select(MNID_ASPECTRATIO, _("Aspect Ratio"), &next_aspect_ratio, aspect_ratios);
   aspect.set_help(_("Adjust the aspect ratio"));
 #endif
@@ -420,10 +420,14 @@ OptionsMenu::OptionsMenu(bool complete) :
   MenuItem& enable_transitions = add_toggle(MNID_TRANSITIONS, _("Enable transitions"), &g_config->transitions_enabled);
   enable_transitions.set_help(_("Enable screen transitions and smooth menu animation"));
 
+#ifndef HIDE_NONMOBILE_OPTIONS
   if (g_config->developer_mode)
   {
     add_toggle(MNID_DEVELOPER_MODE, _("Developer Mode"), &g_config->developer_mode);
   }
+#else
+  add_toggle(MNID_DEVELOPER_MODE, _("Developer Mode"), &g_config->developer_mode);
+#endif
 
   if (g_config->is_christmas() || g_config->christmas_mode)
   {

src/supertux/main.cpp

@@ -338,11 +338,13 @@ ScreenManager::process_events()
     {
       case SDL_FINGERDOWN:
       {
+        SDL_Event old_event = event;
+
         SDL_Event event2;
         event2.type = SDL_MOUSEBUTTONDOWN;
         event2.button.button = SDL_BUTTON_LEFT;
-        event2.button.x = Sint32(event.tfinger.x * float(m_video_system.get_window_size().width));
-        event2.button.y = Sint32(event.tfinger.y * float(m_video_system.get_window_size().height));
+        event2.button.x = Sint32(old_event.tfinger.x * float(m_video_system.get_window_size().width));
+        event2.button.y = Sint32(old_event.tfinger.y * float(m_video_system.get_window_size().height));
         SDL_PushEvent(&event2);
 
         event.type = SDL_MOUSEMOTION;
@@ -354,11 +356,13 @@ ScreenManager::process_events()
 
       case SDL_FINGERUP:
       {
+        SDL_Event old_event = event;
+
         SDL_Event event2;
         event2.type = SDL_MOUSEBUTTONUP;
         event2.button.button = SDL_BUTTON_LEFT;
-        event2.button.x = Sint32(event.tfinger.x * float(m_video_system.get_window_size().width));
-        event2.button.y = Sint32(event.tfinger.y * float(m_video_system.get_window_size().height));
+        event2.button.x = Sint32(old_event.tfinger.x * float(m_video_system.get_window_size().width));
+        event2.button.y = Sint32(old_event.tfinger.y * float(m_video_system.get_window_size().height));
         SDL_PushEvent(&event2);
 
         event.type = SDL_MOUSEMOTION;
@@ -369,11 +373,13 @@ ScreenManager::process_events()
       }
 
       case SDL_FINGERMOTION:
+        SDL_Event old_event = event;
+
         event.type = SDL_MOUSEMOTION;
-        event.motion.x = Sint32(event.tfinger.x * float(m_video_system.get_window_size().width));
-        event.motion.y = Sint32(event.tfinger.y * float(m_video_system.get_window_size().height));
-        event.motion.xrel = Sint32(event.tfinger.dx * float(m_video_system.get_window_size().width));
-        event.motion.yrel = Sint32(event.tfinger.dy * float(m_video_system.get_window_size().height));
+        event.motion.x = Sint32(old_event.tfinger.x * float(m_video_system.get_window_size().width));
+        event.motion.y = Sint32(old_event.tfinger.y * float(m_video_system.get_window_size().height));
+        event.motion.xrel = Sint32(old_event.tfinger.dx * float(m_video_system.get_window_size().width));
+        event.motion.yrel = Sint32(old_event.tfinger.dy * float(m_video_system.get_window_size().height));
         MouseCursor::current()->set_pos(event.motion.x, event.motion.y);
         break;
     }