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 "util/enriched_string.h"
  25 #include "util/pointedthing.h"
  26 #include "game.h"
  27
  28 using namespace irr;
  29 class Client;
  30 struct MapDrawControl;
  31
  32 /*
  33  * This object intend to contain the core UI elements
  34  * It includes:
  35  *   - status texts
  36  *   - debug texts
  37  *   - chat texts
  38  *   - hud flags
  39  */
  40 class GameUI
  41 {
  42         // Temporary between coding time to move things here
  43         friend class Game;
  44
  45         // Permit unittests to access members directly
  46         friend class TestGameUI;
  47
  48 public:
  49         GameUI() = default;
  50         ~GameUI() = default;
  51
  52         // Flags that can, or may, change during main game loop
  53         struct Flags
  54         {
  55                 bool show_chat = true;
  56                 bool show_hud = true;
  57                 bool show_minimap = true;
  58                 bool show_debug = true;
  59                 bool show_profiler_graph = true;
  60         };
  61
  62         void init();
  63         void update(const RunStats &stats, Client *client, MapDrawControl *draw_control,
  64                         const CameraOrientation &cam, const PointedThing &pointed_old,
  65                         float dtime);
  66
  67         void initFlags();
  68         const Flags &getFlags() const { return m_flags; }
  69
  70         void showMinimap(bool show);
  71
  72         inline void setInfoText(const std::wstring &str) { m_infotext = str; }
  73         inline void clearInfoText() { m_infotext.clear(); }
  74
  75         inline void showStatusText(const std::wstring &str)
  76         {
  77                 m_statustext = str;
  78                 m_statustext_time = 0.0f;
  79         }
  80         void showTranslatedStatusText(const char *str);
  81         inline void clearStatusText() { m_statustext.clear(); }
  82
  83         void setChatText(const EnrichedString &chat_text, u32 recent_chat_count);
  84
  85         void updateProfiler();
  86
  87         void toggleChat();
  88         void toggleHud();
  89         void toggleProfiler();
  90
  91 private:
  92         Flags m_flags;
  93
  94         gui::IGUIStaticText *m_guitext = nullptr;  // First line of debug text
  95         gui::IGUIStaticText *m_guitext2 = nullptr; // Second line of debug text
  96
  97         gui::IGUIStaticText *m_guitext_info = nullptr; // At the middle of the screen
  98         std::wstring m_infotext;
  99
 100         gui::IGUIStaticText *m_guitext_status = nullptr;
 101         std::wstring m_statustext;
 102         float m_statustext_time = 0.0f;
 103
 104         gui::IGUIStaticText *m_guitext_chat; // Chat text
 105
 106         gui::IGUIStaticText *m_guitext_profiler; // Profiler text
 107         u8 m_profiler_current_page = 0;
 108         const u8 m_profiler_max_page = 3;
 109 };