mirror of
https://github.com/minetest/minetest.git
synced 2024-11-23 16:13:46 +01:00
14ef2b445a
Add documentation, move files to a proper place and avoid memory leaks. Make it work with most kind of texts, and allow backgrounds too.
139 lines
3.8 KiB
C++
139 lines
3.8 KiB
C++
/*
|
|
Minetest
|
|
Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU Lesser General Public License as published by
|
|
the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public License along
|
|
with this program; if not, write to the Free Software Foundation, Inc.,
|
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*/
|
|
|
|
#ifndef GUICHATCONSOLE_HEADER
|
|
#define GUICHATCONSOLE_HEADER
|
|
|
|
#include "irrlichttypes_extrabloated.h"
|
|
#include "modalMenu.h"
|
|
#include "chat.h"
|
|
#include "config.h"
|
|
|
|
class Client;
|
|
|
|
class GUIChatConsole : public gui::IGUIElement
|
|
{
|
|
public:
|
|
GUIChatConsole(gui::IGUIEnvironment* env,
|
|
gui::IGUIElement* parent,
|
|
s32 id,
|
|
ChatBackend* backend,
|
|
Client* client,
|
|
IMenuManager* menumgr);
|
|
virtual ~GUIChatConsole();
|
|
|
|
// Open the console (height = desired fraction of screen size)
|
|
// This doesn't open immediately but initiates an animation.
|
|
// You should call isOpenInhibited() before this.
|
|
void openConsole(f32 height);
|
|
|
|
bool isOpen() const;
|
|
|
|
// Check if the console should not be opened at the moment
|
|
// This is to avoid reopening the console immediately after closing
|
|
bool isOpenInhibited() const;
|
|
// Close the console, equivalent to openConsole(0).
|
|
// This doesn't close immediately but initiates an animation.
|
|
void closeConsole();
|
|
// Close the console immediately, without animation.
|
|
void closeConsoleAtOnce();
|
|
// Set whether to close the console after the user presses enter.
|
|
void setCloseOnEnter(bool close) { m_close_on_enter = close; }
|
|
|
|
// Return the desired height (fraction of screen size)
|
|
// Zero if the console is closed or getting closed
|
|
f32 getDesiredHeight() const;
|
|
|
|
// Replace actual line when adding the actual to the history (if there is any)
|
|
void replaceAndAddToHistory(std::wstring line);
|
|
|
|
// Change how the cursor looks
|
|
void setCursor(
|
|
bool visible,
|
|
bool blinking = false,
|
|
f32 blink_speed = 1.0,
|
|
f32 relative_height = 1.0);
|
|
|
|
// Irrlicht draw method
|
|
virtual void draw();
|
|
|
|
bool canTakeFocus(gui::IGUIElement* element) { return false; }
|
|
|
|
virtual bool OnEvent(const SEvent& event);
|
|
|
|
virtual void setVisible(bool visible);
|
|
|
|
private:
|
|
void reformatConsole();
|
|
void recalculateConsolePosition();
|
|
|
|
// These methods are called by draw
|
|
void animate(u32 msec);
|
|
void drawBackground();
|
|
void drawText();
|
|
void drawPrompt();
|
|
|
|
private:
|
|
ChatBackend* m_chat_backend;
|
|
Client* m_client;
|
|
IMenuManager* m_menumgr;
|
|
|
|
// current screen size
|
|
v2u32 m_screensize;
|
|
|
|
// used to compute how much time passed since last animate()
|
|
u32 m_animate_time_old;
|
|
|
|
// should the console be opened or closed?
|
|
bool m_open;
|
|
// should it close after you press enter?
|
|
bool m_close_on_enter;
|
|
// current console height [pixels]
|
|
s32 m_height;
|
|
// desired height [pixels]
|
|
f32 m_desired_height;
|
|
// desired height [screen height fraction]
|
|
f32 m_desired_height_fraction;
|
|
// console open/close animation speed [screen height fraction / second]
|
|
f32 m_height_speed;
|
|
// if nonzero, opening the console is inhibited [milliseconds]
|
|
u32 m_open_inhibited;
|
|
|
|
// cursor blink frame (16-bit value)
|
|
// cursor is off during [0,32767] and on during [32768,65535]
|
|
u32 m_cursor_blink;
|
|
// cursor blink speed [on/off toggles / second]
|
|
f32 m_cursor_blink_speed;
|
|
// cursor height [line height]
|
|
f32 m_cursor_height;
|
|
|
|
// background texture
|
|
video::ITexture* m_background;
|
|
// background color (including alpha)
|
|
video::SColor m_background_color;
|
|
|
|
// font
|
|
gui::IGUIFont* m_font;
|
|
v2u32 m_fontsize;
|
|
};
|
|
|
|
|
|
#endif
|
|
|