src/client/gameui.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2018 nerzhul, Loic Blot <loic.blot@unix-experience.fr>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #pragma once
  22
  23 #include <IGUIEnvironment.h>
  24 #include "gui/guiFormSpecMenu.h"
  25 #include "util/enriched_string.h"
  26 #include "util/pointedthing.h"
  27 #include "game.h"
  28
  29 using namespace irr;
  30 class Client;
  31 class GUIChatConsole;
  32 struct MapDrawControl;
  33
  34 /*
  35  * This object intend to contain the core UI elements
  36  * It includes:
  37  *   - status texts
  38  *   - debug texts
  39  *   - chat texts
  40  *   - hud flags
  41  */
  42 class GameUI
  43 {
  44         // Temporary between coding time to move things here
  45         friend class Game;
  46
  47         // Permit unittests to access members directly
  48         friend class TestGameUI;
  49
  50 public:
  51         GameUI();
  52         ~GameUI() = default;
  53
  54         // Flags that can, or may, change during main game loop
  55         struct Flags
  56         {
  57                 bool show_chat = true;
  58                 bool show_hud = true;
  59                 bool show_minimap = false;
  60                 bool show_debug = true;
  61                 bool show_profiler_graph = false;
  62         };
  63
  64         void init();
  65         void update(const RunStats &stats, Client *client, MapDrawControl *draw_control,
  66                         const CameraOrientation &cam, const PointedThing &pointed_old,
  67                         const GUIChatConsole *chat_console, float dtime);
  68
  69         void initFlags();
  70         const Flags &getFlags() const { return m_flags; }
  71
  72         void showMinimap(bool show);
  73
  74         inline void setInfoText(const std::wstring &str) { m_infotext = str; }
  75         inline void clearInfoText() { m_infotext.clear(); }
  76
  77         inline void showStatusText(const std::wstring &str)
  78         {
  79                 m_statustext = str;
  80                 m_statustext_time = 0.0f;
  81         }
  82         void showTranslatedStatusText(const char *str);
  83         inline void clearStatusText() { m_statustext.clear(); }
  84
  85         const bool isChatVisible()
  86         {
  87                 return m_flags.show_chat && m_recent_chat_count != 0 && m_profiler_current_page == 0;
  88         }
  89         void setChatText(const EnrichedString &chat_text, u32 recent_chat_count);
  90
  91         void updateProfiler();
  92
  93         void toggleChat();
  94         void toggleHud();
  95         void toggleProfiler();
  96
  97         GUIFormSpecMenu *&updateFormspec(const std::string &formname)
  98         {
  99                 m_formname = formname;
 100                 return m_formspec;
 101         }
 102
 103         const std::string &getFormspecName() { return m_formname; }
 104         GUIFormSpecMenu *&getFormspecGUI() { return m_formspec; }
 105         void deleteFormspec();
 106
 107 private:
 108         Flags m_flags;
 109
 110         gui::IGUIStaticText *m_guitext = nullptr;  // First line of debug text
 111         gui::IGUIStaticText *m_guitext2 = nullptr; // Second line of debug text
 112
 113         gui::IGUIStaticText *m_guitext_info = nullptr; // At the middle of the screen
 114         std::wstring m_infotext;
 115
 116         gui::IGUIStaticText *m_guitext_status = nullptr;
 117         std::wstring m_statustext;
 118         float m_statustext_time = 0.0f;
 119         video::SColor m_statustext_initial_color;
 120
 121         gui::IGUIStaticText *m_guitext_chat = nullptr; // Chat text
 122         u32 m_recent_chat_count = 0;
 123
 124         gui::IGUIStaticText *m_guitext_profiler = nullptr; // Profiler text
 125         u8 m_profiler_current_page = 0;
 126         const u8 m_profiler_max_page = 3;
 127
 128         // Default: "". If other than "": Empty show_formspec packets will only
 129         // close the formspec when the formname matches
 130         std::string m_formname;
 131         GUIFormSpecMenu *m_formspec = nullptr;
 132 };