Add support for help texts for editor buttons

Author: tobbi

src/editor/button_widget.cpp

@@ -18,6 +18,8 @@
 
 #include "supertux/gameconfig.hpp"
 #include "supertux/globals.hpp"
+#include "supertux/resources.hpp"
+#include "util/log.hpp"
 #include "video/viewport.hpp"
 #include "video/video_system.hpp"
 
@@ -28,7 +30,9 @@ ButtonWidget::ButtonWidget(SpritePtr sprite, const Vector& pos,
                     static_cast<float>(m_sprite->get_height()))),
   m_grab(false),
   m_hover(false),
-  m_sig_click(std::move(sig_click))
+  m_sig_click(std::move(sig_click)),
+  m_mouse_pos(),
+  m_help_text()
 {
 }
 
@@ -49,6 +53,16 @@ ButtonWidget::draw(DrawingContext& context)
     context.color().draw_filled_rect(m_rect, g_config->editorhovercolor, 4.0f,
                                      LAYER_GUI-5);
   }
+
+  if (m_hover && !m_help_text.empty())
+  {
+    const auto& font = Resources::console_font;
+    const auto text_height = font->get_text_height(m_help_text);
+    const auto text_width = font->get_text_width(m_help_text);
+    const auto text_rect = Rectf(m_mouse_pos + Vector(32, 32), m_mouse_pos + Vector(32, 32) + Vector(text_width, text_height));
+    context.color().draw_filled_rect(text_rect, Color::BLACK, LAYER_GUI - 5);
+    context.color().draw_text(font, m_help_text, m_mouse_pos + Vector(32, 32), FontAlignment::ALIGN_LEFT, LAYER_GUI - 5);
+  }
 }
 
 void
@@ -71,10 +85,10 @@ ButtonWidget::on_mouse_button_up(const SDL_MouseButtonEvent& button)
 {
   if (button.button != SDL_BUTTON_LEFT) return false;
 
-  Vector mouse_pos = VideoSystem::current()->get_viewport().to_logical(button.x, button.y);
+  m_mouse_pos = VideoSystem::current()->get_viewport().to_logical(button.x, button.y);
 
   if (m_grab) {
-    if (m_rect.contains(mouse_pos)) {
+    if (m_rect.contains(m_mouse_pos)) {
       if (m_sig_click) {
         m_sig_click();
       }
@@ -92,9 +106,9 @@ ButtonWidget::on_mouse_button_down(const SDL_MouseButtonEvent& button)
 {
   if (button.button != SDL_BUTTON_LEFT) return false;
 
-  Vector mouse_pos = VideoSystem::current()->get_viewport().to_logical(button.x, button.y);
+  m_mouse_pos = VideoSystem::current()->get_viewport().to_logical(button.x, button.y);
 
-  if (m_rect.contains(mouse_pos)) {
+  if (m_rect.contains(m_mouse_pos)) {
     m_hover = true;
     m_grab = true;
     return true;
@@ -107,12 +121,12 @@ ButtonWidget::on_mouse_button_down(const SDL_MouseButtonEvent& button)
 bool
 ButtonWidget::on_mouse_motion(const SDL_MouseMotionEvent& motion)
 {
-  Vector mouse_pos = VideoSystem::current()->get_viewport().to_logical(motion.x, motion.y);
+  m_mouse_pos = VideoSystem::current()->get_viewport().to_logical(motion.x, motion.y);
 
   if (m_grab) {
-    m_hover = m_rect.contains(mouse_pos);
+    m_hover = m_rect.contains(m_mouse_pos);
     return true;
-  } else if (m_rect.contains(mouse_pos)) {
+  } else if (m_rect.contains(m_mouse_pos)) {
     m_hover = true;
     return false;
   } else {
@@ -134,4 +148,10 @@ ButtonWidget::set_sprite(const std::string& path)
   set_sprite(SpriteManager::current()->create(path));
 }
 
+void
+ButtonWidget::set_help_text(const std::string& help_text)
+{
+  m_help_text = help_text;
+}
+
 /* EOF */

src/editor/button_widget.hpp

@@ -48,12 +48,16 @@ class ButtonWidget : public Widget
   void set_sprite(const std::string& path);
   void set_sprite(SpritePtr sprite);
 
+  void set_help_text(const std::string& help_text);
+
 private:
   SpritePtr m_sprite;
   Rectf m_rect;
   bool m_grab;
   bool m_hover;
   std::function<void()> m_sig_click;
+  Vector m_mouse_pos;
+  std::string m_help_text;
 
 private:
   ButtonWidget(const ButtonWidget&) = delete;

src/editor/editor.cpp

@@ -163,20 +163,23 @@ Editor::Editor() :
       else
         snap_grid_size--;
     });
-
+  
+  grid_size_widget->set_help_text(_("Change / Toggle grid size"));
   m_grid_size_widget = grid_size_widget.get();
 
   m_widgets.insert(m_widgets.begin() + 2, std::move(grid_size_widget));
 
   auto play_button = std::make_unique<ButtonWidget>("images/engine/editor/play_button.png",
     Vector(96, 0), [this] { m_test_request = true; });
+  play_button->set_help_text(_("Test level"));
 
   m_play_widget = play_button.get();
 
   m_widgets.insert(m_widgets.begin() + 3, std::move(play_button));
 
   auto save_button = std::make_unique<ButtonWidget>("images/engine/editor/save.png",
     Vector(128, 0), [this] { save_level(); });
+  save_button->set_help_text(_("Save level"));
 
   m_save_widget = save_button.get();
 
@@ -191,6 +194,7 @@ Editor::Editor() :
       else
         select_objectgroup(0);
   });
+  mode_button->set_help_text(_("Toggle between object and tile mode"));
 
   m_widgets.insert(m_widgets.begin() + 5, std::move(mode_button));
 }
@@ -1114,8 +1118,10 @@ Editor::retoggle_undo_tracking()
     // Add undo/redo button widgets.
     auto undo_button_widget = std::make_unique<ButtonWidget>("images/engine/editor/undo.png",
         Vector(0, 0), [this]{ undo(); });
+    undo_button_widget->set_help_text(_("Undo"));
     auto redo_button_widget = std::make_unique<ButtonWidget>("images/engine/editor/redo.png",
         Vector(32, 0), [this]{ redo(); });
+    redo_button_widget->set_help_text(_("Redo"));
 
     m_undo_widget = undo_button_widget.get();
     m_redo_widget = redo_button_widget.get();