Add images item (#2223)

mrkubax10 · web-flow · commit 62256b8bab69 · 2022-06-29T12:01:07.000-07:00
* Add images item

* Add EOF

* Fix compilation

* Fix compilation... again

* Reposition arrow indicators
diff --git a/src/gui/item_images.cpp b/src/gui/item_images.cpp
@@ -0,0 +1,102 @@
+//  SuperTux
+//  Copyright (C) 2022 mrkubax10 <mrkubax10@onet.pl>
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+#include "gui/item_images.hpp"
+
+#include "supertux/resources.hpp"
+#include "video/surface.hpp"
+#include "video/drawing_context.hpp"
+
+ItemImages::ItemImages(const std::string& image_path, int max_image_width, int max_image_height, int id):
+  MenuItem("", id),
+  m_images(),
+  m_gallery_mode(false),
+  m_selected_image(0),
+  m_max_image_width(max_image_width),
+  m_max_image_height(max_image_height),
+  m_item_width(0),
+  m_item_height(0)
+{
+  m_images.push_back(Surface::from_file(image_path));
+  m_item_width = (m_images[0]->get_width() > max_image_width && max_image_width > 0 ? max_image_width : m_images[0]->get_width()) + 4;
+  m_item_height = (m_images[0]->get_height() > max_image_height && max_image_height > 0 ? max_image_height : m_images[0]->get_height()) + 4;
+}
+
+ItemImages::ItemImages(const std::vector<std::string>& image_paths, int max_image_width, int max_image_height, int id):
+  MenuItem("", id),
+  m_images(),
+  m_gallery_mode(image_paths.size() > 1),
+  m_selected_image(0),
+  m_max_image_width(max_image_width),
+  m_max_image_height(max_image_height),
+  m_item_width(0),
+  m_item_height(0)
+{
+  int max_width = 0;
+  int max_height = 0;
+  for (unsigned i = 0; i < image_paths.size(); i++)
+  {
+    m_images.push_back(Surface::from_file(image_paths[i]));
+    if(m_images[i]->get_width() > max_width)
+      max_width = (m_images[i]->get_width() > max_image_width && max_image_width > 0 ? max_image_width : m_images[i]->get_width());
+    if(m_images[i]->get_height() > max_height)
+      max_height = (m_images[i]->get_height() > max_image_height && max_image_height > 0 ? max_image_height : m_images[i]->get_height());
+  }
+  m_item_width = max_width + 4;
+  m_item_height = max_height + 4;
+}
+
+void
+ItemImages::draw(DrawingContext& drawing_context, const Vector& pos, int menu_width, bool active)
+{
+  if (m_images.empty())
+    return;
+  SurfacePtr surface = m_images[m_selected_image];
+  if (m_max_image_width > 0 && m_max_image_height > 0 && (surface->get_width() > m_max_image_width || surface->get_height() > m_max_image_height))
+    drawing_context.color().draw_surface_scaled(surface, Rectf(pos + Vector((menu_width - m_max_image_width)/2 - 2, -m_max_image_height/2),
+                                                               Sizef(static_cast<float>(m_max_image_width), static_cast<float>(m_max_image_height))), LAYER_GUI);
+  else
+    drawing_context.color().draw_surface(surface, pos + Vector((menu_width - surface->get_width())/2 - 2, -surface->get_height()/2), LAYER_GUI);
+  if (m_gallery_mode)
+  {
+    float left_arrow_width = Resources::big_font->get_text_width("<");
+    float right_arrow_width  = Resources::big_font->get_text_width(">");
+    float arrow_height = Resources::big_font->get_text_height("<");
+    drawing_context.color().draw_text(Resources::big_font, "<", pos + Vector(left_arrow_width/2 + 2, -arrow_height/2), FontAlignment::ALIGN_LEFT, LAYER_GUI);
+    drawing_context.color().draw_text(Resources::big_font, ">", pos + Vector(static_cast<float>(menu_width) - right_arrow_width*1.5f, -arrow_height/2), FontAlignment::ALIGN_LEFT, LAYER_GUI);
+  }
+}
+
+void
+ItemImages::process_action(const MenuAction& action)
+{
+  if (!m_gallery_mode)
+    return;
+  switch (action)
+  {
+  case MenuAction::LEFT:
+    m_selected_image--;
+    m_selected_image = (m_selected_image < 0 ? static_cast<int>(m_images.size()) - 1 : m_selected_image);
+    break;
+  case MenuAction::RIGHT:
+    m_selected_image++;
+    m_selected_image = (m_selected_image >= static_cast<int>(m_images.size()) ? 0 : m_selected_image);
+    break;
+  default:
+    break;
+  }
+}
+/* EOF */
diff --git a/src/gui/item_images.hpp b/src/gui/item_images.hpp
@@ -0,0 +1,49 @@
+//  SuperTux
+//  Copyright (C) 2022 mrkubax10 <mrkubax10@onet.pl>
+//
+//  This program is free software: you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License as published by
+//  the Free Software Foundation, either version 3 of the License, or
+//  (at your option) any later version.
+//
+//  This program is distributed in the hope that it will be useful,
+//  but WITHOUT ANY WARRANTY; without even the implied warranty of
+//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+//  GNU General Public License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+#ifndef HEADER_SUPERTUX_GUI_ITEM_IMAGES_HPP
+#define HEADER_SUPERTUX_GUI_ITEM_IMAGES_HPP
+
+#include "gui/menu_item.hpp"
+#include "video/surface_ptr.hpp"
+
+class ItemImages final : public MenuItem
+{
+public:
+  ItemImages(const std::string& image_path, int max_image_width = 0, int max_image_height = 0, int id = -1);
+  ItemImages(const std::vector<std::string>& image_paths, int max_image_width = 0, int max_image_height = 0, int id = -1);
+
+  virtual void draw(DrawingContext& drawing_context, const Vector& pos, int menu_width, bool active) override;
+  virtual int get_width() const override { return m_item_width; }
+  virtual int get_height() const override { return m_item_height; }
+  virtual void process_action(const MenuAction& action) override;
+
+private:
+  std::vector<SurfacePtr> m_images;
+  bool m_gallery_mode;
+  int m_selected_image;
+  int m_max_image_width;
+  int m_max_image_height;
+  int m_item_width;
+  int m_item_height;
+
+private:
+  ItemImages(const ItemImages&) = delete;
+  ItemImages& operator=(const ItemImages&) = delete;
+};
+
+#endif
+/* EOF */
diff --git a/src/gui/menu.cpp b/src/gui/menu.cpp
@@ -38,6 +38,7 @@
 #include "gui/item_textfield.hpp"
 #include "gui/item_toggle.hpp"
 #include "gui/item_string_array.hpp"
+#include "gui/item_images.hpp"
 #include "gui/menu_item.hpp"
 #include "gui/menu_manager.hpp"
 #include "gui/mousecursor.hpp"
@@ -62,6 +63,7 @@ Menu::Menu() :
   m_mn_input_char('\0'),
   m_menu_repeat_time(),
   m_menu_width(),
+  m_menu_height(),
   m_items(),
   m_arrange_left(0),
   m_active_item(-1)
@@ -97,6 +99,7 @@ Menu::add_item(std::unique_ptr<MenuItem> new_item)
   }
 
   calculate_width();
+  calculate_height();
 
   return item;
 }
@@ -116,6 +119,7 @@ Menu::add_item(std::unique_ptr<MenuItem> new_item, int pos_)
   }
 
   calculate_width();
+  calculate_height();
 
   return item;
 }
@@ -353,6 +357,24 @@ Menu::add_string_array(const std::string& text, std::vector<std::string>& items,
   return *item_ptr;
 }
 
+ItemImages&
+Menu::add_images(const std::string& image_path, int max_image_width, int max_image_height, int id)
+{
+  auto item = std::make_unique<ItemImages>(image_path, max_image_width, max_image_height, id);
+  auto item_ptr = item.get();
+  add_item(std::move(item));
+  return *item_ptr;
+}
+
+ItemImages&
+Menu::add_images(const std::vector<std::string>& image_paths, int max_image_width, int max_image_height, int id)
+{
+  auto item = std::make_unique<ItemImages>(image_paths, max_image_width, max_image_height, id);
+  auto item_ptr = item.get();
+  add_item(std::move(item));
+  return *item_ptr;
+}
+
 void
 Menu::clear()
 {
@@ -547,28 +569,26 @@ Menu::process_action(const MenuAction& menuaction)
 }
 
 void
-Menu::draw_item(DrawingContext& context, int index)
+Menu::draw_item(DrawingContext& context, int index, float y_pos)
 {
-  const float menu_height = get_height();
   const float menu_width = get_width();
 
   MenuItem* pitem = m_items[index].get();
 
   const float x_pos = m_pos.x - menu_width / 2.0f;
-  const float y_pos = m_pos.y + 24.0f * static_cast<float>(index) - menu_height / 2.0f + 12.0f;
 
   pitem->draw(context, Vector(x_pos, y_pos), static_cast<int>(menu_width), m_active_item == index);
 
   if (m_active_item == index)
   {
     float blink = (sinf(g_real_time * math::PI * 1.0f)/2.0f + 0.5f) * 0.5f + 0.25f;
-    context.color().draw_filled_rect(Rectf(Vector(m_pos.x - menu_width/2 + 10 - 2, y_pos - 12 - 2),
-                                           Vector(m_pos.x + menu_width/2 - 10 + 2, y_pos + 12 + 2)),
+    context.color().draw_filled_rect(Rectf(Vector(m_pos.x - menu_width/2 + 10 - 2, y_pos - static_cast<float>(pitem->get_height())/2 - 2),
+                                           Vector(m_pos.x + menu_width/2 - 10 + 2, y_pos + static_cast<float>(pitem->get_height())/2 + 2)),
                                      Color(1.0f, 1.0f, 1.0f, blink),
                                      std::max(0.f, g_config->menuroundness - 2.f),
                                      LAYER_GUI-10);
-    context.color().draw_filled_rect(Rectf(Vector(m_pos.x - menu_width/2 + 10, y_pos - 12),
-                                           Vector(m_pos.x + menu_width/2 - 10, y_pos + 12)),
+    context.color().draw_filled_rect(Rectf(Vector(m_pos.x - menu_width/2 + 10, y_pos - static_cast<float>(pitem->get_height())/2),
+                                           Vector(m_pos.x + menu_width/2 - 10, y_pos + static_cast<float>(pitem->get_height())/2)),
                                      Color(1.0f, 1.0f, 1.0f, 0.5f),
                                      std::max(0.f, g_config->menuroundness - 4.f),
                                      LAYER_GUI-10);
@@ -590,6 +610,17 @@ Menu::calculate_width()
   m_menu_width = max_width;
 }
 
+void
+Menu::calculate_height()
+{
+  float height = 0;
+  for (unsigned i = 0; i < m_items.size(); i++)
+  {
+    height += static_cast<float>(m_items[i]->get_height());
+  }
+  m_menu_height = height;
+}
+
 float
 Menu::get_width() const
 {
@@ -599,7 +630,7 @@ Menu::get_width() const
 float
 Menu::get_height() const
 {
-  return static_cast<float>(m_items.size() * 24);
+  return m_menu_height;
 }
 
 void
@@ -612,9 +643,12 @@ Menu::on_window_resize()
 void
 Menu::draw(DrawingContext& context)
 {
+  const float menu_height = get_height();
+  float y_pos = m_pos.y - menu_height / 2.0f;
   for (unsigned int i = 0; i < m_items.size(); ++i)
   {
-    draw_item(context, i);
+    draw_item(context, i, y_pos + static_cast<float>(m_items[i]->get_height())/2);
+    y_pos += static_cast<float>(m_items[i]->get_height());
   }
 
   if (!m_items[m_active_item]->get_help().empty())
@@ -719,8 +753,19 @@ Menu::event(const SDL_Event& ev)
          y > m_pos.y - get_height()/2 &&
          y < m_pos.y + get_height()/2)
       {
-        int new_active_item
-          = static_cast<int> ((y - (m_pos.y - get_height()/2)) / 24);
+        int new_active_item = 0;
+        // This is probably not the most efficient way of finding active item
+        // but I can't think of something better right now ~ mrkubax10
+        float item_y = m_pos.y - get_height()/2;
+        for (unsigned i = 0; i < m_items.size(); i++)
+        {
+          if (y >= item_y && y <= item_y + static_cast<float>(m_items[i]->get_height()))
+          {
+            new_active_item = i;
+            break;
+          }
+          item_y += static_cast<float>(m_items[i]->get_height());
+        }
 
         /* only change the mouse focus to a selectable item */
         if (!m_items[new_active_item]->skippable() &&
diff --git a/src/gui/menu.hpp b/src/gui/menu.hpp
@@ -49,6 +49,7 @@ class ItemStringSelect;
 class ItemTextField;
 class ItemToggle;
 class ItemStringArray;
+class ItemImages;
 class MenuItem;
 class PathObject;
 
@@ -98,6 +99,8 @@ class Menu
   ItemColorChannelOKLab& add_color_channel_oklab(Color* color, int channel);
   ItemPaths& add_path_settings(const std::string& text, PathObject& target, const std::string& path_ref);
   ItemStringArray& add_string_array(const std::string& text, std::vector<std::string>& items, int id = -1);
+  ItemImages& add_images(const std::string& image_path, int max_image_width = 0, int max_image_height = 0, int id = -1);
+  ItemImages& add_images(const std::vector<std::string>& image_paths, int max_image_width = 0, int max_image_height = 0, int id = -1);
 
   void process_input(const Controller& controller);
 
@@ -132,9 +135,11 @@ class Menu
 private:
   void process_action(const MenuAction& menuaction);
   void check_controlfield_change_event(const SDL_Event& event);
-  void draw_item(DrawingContext& context, int index);
+  void draw_item(DrawingContext& context, int index, float y_pos);
   /** Recalculates the width for this menu */
   void calculate_width();
+  /** Recalculates the height for this menu */
+  void calculate_height();
 
 private:
   /** position of the menu (ie. center of the menu, not top/left) */
@@ -145,6 +150,7 @@ class Menu
   char m_mn_input_char;
   float m_menu_repeat_time;
   float m_menu_width;
+  float m_menu_height;
 
 public:
   std::vector<std::unique_ptr<MenuItem> > m_items;
diff --git a/src/gui/menu_item.hpp b/src/gui/menu_item.hpp
@@ -46,6 +46,9 @@ class MenuItem
   /** Returns the minimum width of the menu item. */
   virtual int get_width() const;
 
+  /** Returns height of menu item. */
+  virtual int get_height() const { return 24; }
+
   /** Processes the menu action. */
   virtual void process_action(const MenuAction& action) { }
 
