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 #include "gameui.h"
22 #include <irrlicht_changes/static_text.h>
23 #include <gettext.h>
24 #include "gui/mainmenumanager.h"
25 #include "gui/guiChatConsole.h"
26 #include "util/pointedthing.h"
27 #include "client.h"
28 #include "clientmap.h"
29 #include "fontengine.h"
30 #include "nodedef.h"
31 #include "profiler.h"
32 #include "renderingengine.h"
33 #include "version.h"
34 
yawToDirectionString(int yaw)35 inline static const char *yawToDirectionString(int yaw)
36 {
37 	static const char *direction[4] =
38 		{"North +Z", "West -X", "South -Z", "East +X"};
39 
40 	yaw = wrapDegrees_0_360(yaw);
41 	yaw = (yaw + 45) % 360 / 90;
42 
43 	return direction[yaw];
44 }
45 
GameUI()46 GameUI::GameUI()
47 {
48 	if (guienv && guienv->getSkin())
49 		m_statustext_initial_color = guienv->getSkin()->getColor(gui::EGDC_BUTTON_TEXT);
50 	else
51 		m_statustext_initial_color = video::SColor(255, 0, 0, 0);
52 
53 }
init()54 void GameUI::init()
55 {
56 	// First line of debug text
57 	m_guitext = gui::StaticText::add(guienv, utf8_to_wide(PROJECT_NAME_C).c_str(),
58 		core::rect<s32>(0, 0, 0, 0), false, false, guiroot);
59 
60 	// Second line of debug text
61 	m_guitext2 = gui::StaticText::add(guienv, L"", core::rect<s32>(0, 0, 0, 0), false,
62 		false, guiroot);
63 
64 	// Chat text
65 	m_guitext_chat = gui::StaticText::add(guienv, L"", core::rect<s32>(0, 0, 0, 0),
66 		//false, false); // Disable word wrap as of now
67 		false, true, guiroot);
68 	u16 chat_font_size = g_settings->getU16("chat_font_size");
69 	if (chat_font_size != 0) {
70 		m_guitext_chat->setOverrideFont(g_fontengine->getFont(
71 			chat_font_size, FM_Unspecified));
72 	}
73 
74 	// At the middle of the screen
75 	// Object infos are shown in this
76 	u32 chat_font_height = m_guitext_chat->getActiveFont()->getDimension(L"Ay").Height;
77 	m_guitext_info = gui::StaticText::add(guienv, L"",
78 		core::rect<s32>(0, 0, 400, g_fontengine->getTextHeight() * 5 + 5) +
79 			v2s32(100, chat_font_height *
80 			(g_settings->getU16("recent_chat_messages") + 3)),
81 			false, true, guiroot);
82 
83 	// Status text (displays info when showing and hiding GUI stuff, etc.)
84 	m_guitext_status = gui::StaticText::add(guienv, L"<Status>",
85 		core::rect<s32>(0, 0, 0, 0), false, false, guiroot);
86 	m_guitext_status->setVisible(false);
87 
88 	// Profiler text (size is updated when text is updated)
89 	m_guitext_profiler = gui::StaticText::add(guienv, L"<Profiler>",
90 		core::rect<s32>(0, 0, 0, 0), false, false, guiroot);
91 	m_guitext_profiler->setOverrideFont(g_fontengine->getFont(
92 		g_fontengine->getDefaultFontSize() * 0.9f, FM_Mono));
93 	m_guitext_profiler->setVisible(false);
94 }
95 
update(const RunStats & stats,Client * client,MapDrawControl * draw_control,const CameraOrientation & cam,const PointedThing & pointed_old,const GUIChatConsole * chat_console,float dtime)96 void GameUI::update(const RunStats &stats, Client *client, MapDrawControl *draw_control,
97 	const CameraOrientation &cam, const PointedThing &pointed_old,
98 	const GUIChatConsole *chat_console, float dtime)
99 {
100 	v2u32 screensize = RenderingEngine::get_instance()->getWindowSize();
101 
102 	if (m_flags.show_debug) {
103 		static float drawtime_avg = 0;
104 		drawtime_avg = drawtime_avg * 0.95 + stats.drawtime * 0.05;
105 		u16 fps = 1.0 / stats.dtime_jitter.avg;
106 
107 		std::ostringstream os(std::ios_base::binary);
108 		os << std::fixed
109 			<< PROJECT_NAME_C " " << g_version_hash
110 			<< " | FPS: " << fps
111 			<< std::setprecision(0)
112 			<< " | drawtime: " << drawtime_avg << "ms"
113 			<< std::setprecision(1)
114 			<< " | dtime jitter: "
115 			<< (stats.dtime_jitter.max_fraction * 100.0) << "%"
116 			<< std::setprecision(1)
117 			<< " | view range: "
118 			<< (draw_control->range_all ? "All" : itos(draw_control->wanted_range))
119 			<< std::setprecision(2)
120 			<< " | RTT: " << (client->getRTT() * 1000.0f) << "ms";
121 		setStaticText(m_guitext, utf8_to_wide(os.str()).c_str());
122 
123 		m_guitext->setRelativePosition(core::rect<s32>(5, 5, screensize.X,
124 			5 + g_fontengine->getTextHeight()));
125 	}
126 
127 	// Finally set the guitext visible depending on the flag
128 	m_guitext->setVisible(m_flags.show_debug);
129 
130 	if (m_flags.show_debug) {
131 		LocalPlayer *player = client->getEnv().getLocalPlayer();
132 		v3f player_position = player->getPosition();
133 
134 		std::ostringstream os(std::ios_base::binary);
135 		os << std::setprecision(1) << std::fixed
136 			<< "pos: (" << (player_position.X / BS)
137 			<< ", " << (player_position.Y / BS)
138 			<< ", " << (player_position.Z / BS)
139 			<< ") | yaw: " << (wrapDegrees_0_360(cam.camera_yaw)) << "° "
140 			<< yawToDirectionString(cam.camera_yaw)
141 			<< " | pitch: " << (-wrapDegrees_180(cam.camera_pitch)) << "°"
142 			<< " | seed: " << ((u64)client->getMapSeed());
143 
144 		if (pointed_old.type == POINTEDTHING_NODE) {
145 			ClientMap &map = client->getEnv().getClientMap();
146 			const NodeDefManager *nodedef = client->getNodeDefManager();
147 			MapNode n = map.getNode(pointed_old.node_undersurface);
148 
149 			if (n.getContent() != CONTENT_IGNORE && nodedef->get(n).name != "unknown") {
150 				os << ", pointed: " << nodedef->get(n).name
151 					<< ", param2: " << (u64) n.getParam2();
152 			}
153 		}
154 
155 		setStaticText(m_guitext2, utf8_to_wide(os.str()).c_str());
156 
157 		m_guitext2->setRelativePosition(core::rect<s32>(5,
158 			5 + g_fontengine->getTextHeight(), screensize.X,
159 			5 + g_fontengine->getTextHeight() * 2
160 		));
161 	}
162 
163 	m_guitext2->setVisible(m_flags.show_debug);
164 
165 	setStaticText(m_guitext_info, m_infotext.c_str());
166 	m_guitext_info->setVisible(m_flags.show_hud && g_menumgr.menuCount() == 0);
167 
168 	static const float statustext_time_max = 1.5f;
169 
170 	if (!m_statustext.empty()) {
171 		m_statustext_time += dtime;
172 
173 		if (m_statustext_time >= statustext_time_max) {
174 			clearStatusText();
175 			m_statustext_time = 0.0f;
176 		}
177 	}
178 
179 	setStaticText(m_guitext_status, m_statustext.c_str());
180 	m_guitext_status->setVisible(!m_statustext.empty());
181 
182 	if (!m_statustext.empty()) {
183 		s32 status_width  = m_guitext_status->getTextWidth();
184 		s32 status_height = m_guitext_status->getTextHeight();
185 		s32 status_y = screensize.Y - 150;
186 		s32 status_x = (screensize.X - status_width) / 2;
187 
188 		m_guitext_status->setRelativePosition(core::rect<s32>(status_x ,
189 			status_y - status_height, status_x + status_width, status_y));
190 
191 		// Fade out
192 		video::SColor final_color = m_statustext_initial_color;
193 		final_color.setAlpha(0);
194 		video::SColor fade_color = m_statustext_initial_color.getInterpolated_quadratic(
195 			m_statustext_initial_color, final_color, m_statustext_time / statustext_time_max);
196 		m_guitext_status->setOverrideColor(fade_color);
197 		m_guitext_status->enableOverrideColor(true);
198 	}
199 
200 	// Hide chat when console is visible
201 	m_guitext_chat->setVisible(isChatVisible() && !chat_console->isVisible());
202 }
203 
initFlags()204 void GameUI::initFlags()
205 {
206 	m_flags = GameUI::Flags();
207 	m_flags.show_debug = g_settings->getBool("show_debug");
208 }
209 
showMinimap(bool show)210 void GameUI::showMinimap(bool show)
211 {
212 	m_flags.show_minimap = show;
213 }
214 
showTranslatedStatusText(const char * str)215 void GameUI::showTranslatedStatusText(const char *str)
216 {
217 	const wchar_t *wmsg = wgettext(str);
218 	showStatusText(wmsg);
219 	delete[] wmsg;
220 }
221 
setChatText(const EnrichedString & chat_text,u32 recent_chat_count)222 void GameUI::setChatText(const EnrichedString &chat_text, u32 recent_chat_count)
223 {
224 
225 	// Update gui element size and position
226 	s32 chat_y = 5;
227 
228 	if (m_flags.show_debug)
229 		chat_y += 2 * g_fontengine->getLineHeight();
230 
231 	const v2u32 &window_size = RenderingEngine::get_instance()->getWindowSize();
232 
233 	core::rect<s32> chat_size(10, chat_y,
234 		window_size.X - 20, 0);
235 	chat_size.LowerRightCorner.Y = std::min((s32)window_size.Y,
236 		m_guitext_chat->getTextHeight() + chat_y);
237 
238 	m_guitext_chat->setRelativePosition(chat_size);
239 	setStaticText(m_guitext_chat, chat_text);
240 
241 	m_recent_chat_count = recent_chat_count;
242 }
243 
updateProfiler()244 void GameUI::updateProfiler()
245 {
246 	if (m_profiler_current_page != 0) {
247 		std::ostringstream os(std::ios_base::binary);
248 		os << "   Profiler page " << (int)m_profiler_current_page <<
249 				", elapsed: " << g_profiler->getElapsedMs() << " ms)" << std::endl;
250 
251 		int lines = g_profiler->print(os, m_profiler_current_page, m_profiler_max_page);
252 		++lines;
253 
254 		EnrichedString str(utf8_to_wide(os.str()));
255 		str.setBackground(video::SColor(120, 0, 0, 0));
256 		setStaticText(m_guitext_profiler, str);
257 
258 		core::dimension2d<u32> size = m_guitext_profiler->getOverrideFont()->
259 				getDimension(str.c_str());
260 		core::position2di upper_left(6, 50);
261 		core::position2di lower_right = upper_left;
262 		lower_right.X += size.Width + 10;
263 		lower_right.Y += size.Height;
264 
265 		m_guitext_profiler->setRelativePosition(core::rect<s32>(upper_left, lower_right));
266 	}
267 
268 	m_guitext_profiler->setVisible(m_profiler_current_page != 0);
269 }
270 
toggleChat()271 void GameUI::toggleChat()
272 {
273 	m_flags.show_chat = !m_flags.show_chat;
274 	if (m_flags.show_chat)
275 		showTranslatedStatusText("Chat shown");
276 	else
277 		showTranslatedStatusText("Chat hidden");
278 }
279 
toggleHud()280 void GameUI::toggleHud()
281 {
282 	m_flags.show_hud = !m_flags.show_hud;
283 	if (m_flags.show_hud)
284 		showTranslatedStatusText("HUD shown");
285 	else
286 		showTranslatedStatusText("HUD hidden");
287 }
288 
toggleProfiler()289 void GameUI::toggleProfiler()
290 {
291 	m_profiler_current_page = (m_profiler_current_page + 1) % (m_profiler_max_page + 1);
292 
293 	// FIXME: This updates the profiler with incomplete values
294 	updateProfiler();
295 
296 	if (m_profiler_current_page != 0) {
297 		wchar_t buf[255];
298 		const wchar_t* str = wgettext("Profiler shown (page %d of %d)");
299 		swprintf(buf, sizeof(buf) / sizeof(wchar_t), str,
300 			m_profiler_current_page, m_profiler_max_page);
301 		delete[] str;
302 		showStatusText(buf);
303 	} else {
304 		showTranslatedStatusText("Profiler hidden");
305 	}
306 }
307 
308 
deleteFormspec()309 void GameUI::deleteFormspec()
310 {
311 	if (m_formspec) {
312 		m_formspec->drop();
313 		m_formspec = nullptr;
314 	}
315 
316 	m_formname.clear();
317 }
318