src/guiChatConsole.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef GUICHATCONSOLE_HEADER
  21 #define GUICHATCONSOLE_HEADER
  22
  23 #include "irrlichttypes_extrabloated.h"
  24 #include "chat.h"
  25 #include "config.h"
  26
  27 class Client;
  28
  29 class GUIChatConsole : public gui::IGUIElement
  30 {
  31 public:
  32         GUIChatConsole(gui::IGUIEnvironment* env,
  33                         gui::IGUIElement* parent,
  34                         s32 id,
  35                         ChatBackend* backend,
  36                         Client* client);
  37         virtual ~GUIChatConsole();
  38
  39         // Open the console (height = desired fraction of screen size)
  40         // This doesn't open immediately but initiates an animation.
  41         // You should call isOpenInhibited() before this.
  42         void openConsole(f32 height);
  43
  44         bool isOpen() const;
  45
  46         // Check if the console should not be opened at the moment
  47         // This is to avoid reopening the console immediately after closing
  48         bool isOpenInhibited() const;
  49         // Close the console, equivalent to openConsole(0).
  50         // This doesn't close immediately but initiates an animation.
  51         void closeConsole();
  52         // Close the console immediately, without animation.
  53         void closeConsoleAtOnce();
  54         // Set whether to close the console after the user presses enter.
  55         void setCloseOnEnter(bool close) { m_close_on_enter = close; }
  56
  57         // Return the desired height (fraction of screen size)
  58         // Zero if the console is closed or getting closed
  59         f32 getDesiredHeight() const;
  60
  61         // Replace actual line when adding the actual to the history (if there is any)
  62         void replaceAndAddToHistory(std::wstring line);
  63
  64         // Change how the cursor looks
  65         void setCursor(
  66                 bool visible,
  67                 bool blinking = false,
  68                 f32 blink_speed = 1.0,
  69                 f32 relative_height = 1.0);
  70
  71         // Irrlicht draw method
  72         virtual void draw();
  73
  74         bool canTakeFocus(gui::IGUIElement* element) { return false; }
  75
  76         virtual bool OnEvent(const SEvent& event);
  77
  78 private:
  79         void reformatConsole();
  80         void recalculateConsolePosition();
  81
  82         // These methods are called by draw
  83         void animate(u32 msec);
  84         void drawBackground();
  85         void drawText();
  86         void drawPrompt();
  87
  88 private:
  89         // pointer to the chat backend
  90         ChatBackend* m_chat_backend;
  91
  92         // pointer to the client
  93         Client* m_client;
  94
  95         // current screen size
  96         v2u32 m_screensize;
  97
  98         // used to compute how much time passed since last animate()
  99         u32 m_animate_time_old;
 100
 101         // should the console be opened or closed?
 102         bool m_open;
 103         // should it close after you press enter?
 104         bool m_close_on_enter;
 105         // current console height [pixels]
 106         s32 m_height;
 107         // desired height [pixels]
 108         f32 m_desired_height;
 109         // desired height [screen height fraction]
 110         f32 m_desired_height_fraction;
 111         // console open/close animation speed [screen height fraction / second]
 112         f32 m_height_speed;
 113         // if nonzero, opening the console is inhibited [milliseconds]
 114         u32 m_open_inhibited;
 115
 116         // cursor blink frame (16-bit value)
 117         // cursor is off during [0,32767] and on during [32768,65535]
 118         u32 m_cursor_blink;
 119         // cursor blink speed [on/off toggles / second]
 120         f32 m_cursor_blink_speed;
 121         // cursor height [line height]
 122         f32 m_cursor_height;
 123
 124         // background texture
 125         video::ITexture* m_background;
 126         // background color (including alpha)
 127         video::SColor m_background_color;
 128
 129         // font
 130         gui::IGUIFont* m_font;
 131         v2u32 m_fontsize;
 132 };
 133
 134
 135 #endif
 136