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 "irrlichttypes.h"
  24 #include <IGUIEnvironment.h>
  25 #include "gui/guiFormSpecMenu.h"
  26 #include "util/enriched_string.h"
  27 #include "util/pointedthing.h"
  28 #include "game.h"
  29
  30 using namespace irr;
  31 class Client;
  32 class GUIChatConsole;
  33 struct MapDrawControl;
  34
  35 /*
  36  * This object intend to contain the core UI elements
  37  * It includes:
  38  *   - status texts
  39  *   - debug texts
  40  *   - chat texts
  41  *   - hud flags
  42  */
  43 class GameUI
  44 {
  45         // Temporary between coding time to move things here
  46         friend class Game;
  47
  48         // Permit unittests to access members directly
  49         friend class TestGameUI;
  50
  51 public:
  52         GameUI();
  53         ~GameUI() = default;
  54
  55         // Flags that can, or may, change during main game loop
  56         struct Flags
  57         {
  58                 bool show_chat = true;
  59                 bool show_hud = true;
  60                 bool show_minimap = false;
  61                 bool show_minimal_debug = false;
  62                 bool show_basic_debug = false;
  63                 bool show_profiler_graph = false;
  64         };
  65
  66         void init();
  67         void update(const RunStats &stats, Client *client, MapDrawControl *draw_control,
  68                         const CameraOrientation &cam, const PointedThing &pointed_old,
  69                         const GUIChatConsole *chat_console, float dtime);
  70
  71         void initFlags();
  72         const Flags &getFlags() const { return m_flags; }
  73
  74         void showMinimap(bool show);
  75
  76         inline void setInfoText(const std::wstring &str) { m_infotext = str; }
  77         inline void clearInfoText() { m_infotext.clear(); }
  78
  79         inline void showStatusText(const std::wstring &str)
  80         {
  81                 m_statustext = str;
  82                 m_statustext_time = 0.0f;
  83         }
  84         void showTranslatedStatusText(const char *str);
  85         inline void clearStatusText() { m_statustext.clear(); }
  86
  87         bool isChatVisible()
  88         {
  89                 return m_flags.show_chat && m_recent_chat_count != 0 && m_profiler_current_page == 0;
  90         }
  91         void setChatText(const EnrichedString &chat_text, u32 recent_chat_count);
  92         void updateChatSize();
  93
  94         void updateProfiler();
  95
  96         void toggleChat(Client *client);
  97         void toggleHud();
  98         void toggleProfiler();
  99
 100         GUIFormSpecMenu *&updateFormspec(const std::string &formname)
 101         {
 102                 m_formname = formname;
 103                 return m_formspec;
 104         }
 105
 106         const std::string &getFormspecName() { return m_formname; }
 107         GUIFormSpecMenu *&getFormspecGUI() { return m_formspec; }
 108         void deleteFormspec();
 109
 110 private:
 111         Flags m_flags;
 112
 113         float m_drawtime_avg = 0;
 114
 115         gui::IGUIStaticText *m_guitext = nullptr;  // First line of debug text
 116         gui::IGUIStaticText *m_guitext2 = nullptr; // Second line of debug text
 117
 118         gui::IGUIStaticText *m_guitext_info = nullptr; // At the middle of the screen
 119         std::wstring m_infotext;
 120
 121         gui::IGUIStaticText *m_guitext_status = nullptr;
 122         std::wstring m_statustext;
 123         float m_statustext_time = 0.0f;
 124         video::SColor m_statustext_initial_color;
 125
 126         gui::IGUIStaticText *m_guitext_chat = nullptr; // Chat text
 127         u32 m_recent_chat_count = 0;
 128         core::rect<s32> m_current_chat_size{0, 0, 0, 0};
 129
 130         gui::IGUIStaticText *m_guitext_profiler = nullptr; // Profiler text
 131         u8 m_profiler_current_page = 0;
 132         const u8 m_profiler_max_page = 3;
 133
 134         // Default: "". If other than "": Empty show_formspec packets will only
 135         // close the formspec when the formname matches
 136         std::string m_formname;
 137         GUIFormSpecMenu *m_formspec = nullptr;
 138 };