3 Copyright (C) 2013 sapier
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.
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.
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.
20 #include "guiEngine.h"
22 #include <IGUIStaticText.h>
23 #include <ICameraSceneNode.h>
24 #include "client/renderingengine.h"
25 #include "scripting_mainmenu.h"
26 #include "util/numeric.h"
32 #include "guiMainMenu.h"
34 #include "client/sound_openal.h"
35 #include "client/clouds.h"
36 #include "httpfetch.h"
38 #include "client/fontengine.h"
39 #include "client/guiscalingfilter.h"
40 #include "irrlicht_changes/static_text.h"
43 #include "client/tile.h"
47 /******************************************************************************/
48 void TextDestGuiEngine::gotText(const StringMap &fields)
50 m_engine->getScriptIface()->handleMainMenuButtons(fields);
53 /******************************************************************************/
54 void TextDestGuiEngine::gotText(const std::wstring &text)
56 m_engine->getScriptIface()->handleMainMenuEvent(wide_to_utf8(text));
59 /******************************************************************************/
60 MenuTextureSource::~MenuTextureSource()
62 for (const std::string &texture_to_delete : m_to_delete) {
63 const char *tname = texture_to_delete.c_str();
64 video::ITexture *texture = m_driver->getTexture(tname);
65 m_driver->removeTexture(texture);
69 /******************************************************************************/
70 video::ITexture *MenuTextureSource::getTexture(const std::string &name, u32 *id)
79 video::ITexture *retval = m_driver->findTexture(name.c_str());
83 video::IImage *image = m_driver->createImageFromFile(name.c_str());
87 image = Align2Npot2(image, m_driver);
88 retval = m_driver->addTexture(name.c_str(), image);
89 m_to_delete.insert(name);
93 return m_driver->getTexture(name.c_str());
97 /******************************************************************************/
98 /** MenuMusicFetcher */
99 /******************************************************************************/
100 void MenuMusicFetcher::fetchSounds(const std::string &name,
101 std::set<std::string> &dst_paths,
102 std::set<std::string> &dst_datas)
104 if(m_fetched.count(name))
106 m_fetched.insert(name);
107 std::vector<fs::DirListNode> list;
108 // Reusable local function
109 auto add_paths = [&dst_paths](const std::string name, const std::string base = "") {
110 dst_paths.insert(base + name + ".ogg");
111 for (int i = 0; i < 10; i++)
112 dst_paths.insert(base + name + "." + itos(i) + ".ogg");
115 if (name.find(DIR_DELIM_CHAR) != std::string::npos) {
118 std::string share_prefix = porting::path_share + DIR_DELIM;
119 add_paths(name, share_prefix + "sounds" + DIR_DELIM);
120 std::string user_prefix = porting::path_user + DIR_DELIM;
121 add_paths(name, user_prefix + "sounds" + DIR_DELIM);
125 /******************************************************************************/
127 /******************************************************************************/
128 GUIEngine::GUIEngine(JoystickController *joystick,
129 gui::IGUIElement *parent,
130 RenderingEngine *rendering_engine,
131 IMenuManager *menumgr,
134 m_rendering_engine(rendering_engine),
136 m_menumanager(menumgr),
137 m_smgr(rendering_engine->get_scene_manager()),
141 //initialize texture pointers
142 for (image_definition &texture : m_textures) {
143 texture.texture = NULL;
145 // is deleted by guiformspec!
146 m_buttonhandler = new TextDestGuiEngine(this);
148 //create texture source
149 m_texture_source = new MenuTextureSource(rendering_engine->get_video_driver());
151 //create soundmanager
152 MenuMusicFetcher soundfetcher;
154 if (g_settings->getBool("enable_sound") && g_sound_manager_singleton.get())
155 m_sound_manager = createOpenALSoundManager(g_sound_manager_singleton.get(), &soundfetcher);
157 if (!m_sound_manager)
158 m_sound_manager = &dummySoundManager;
160 //create topleft header
163 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
164 g_fontengine->getTextHeight());
167 m_irr_toplefttext = gui::StaticText::add(rendering_engine->get_gui_env(),
168 m_toplefttext, rect, false, true, 0, -1);
170 //create formspecsource
171 m_formspecgui = new FormspecFormSource("");
174 m_menu = new GUIFormSpecMenu(joystick,
179 m_rendering_engine->get_gui_env(),
187 m_menu->allowClose(false);
188 m_menu->lockSize(true,v2u32(800,600));
190 // Initialize scripting
192 infostream << "GUIEngine: Initializing Lua" << std::endl;
194 m_script = new MainMenuScripting(this);
197 m_script->setMainMenuData(&m_data->script_data);
198 m_data->script_data.errormessage.clear();
200 if (!loadMainMenuScript()) {
201 errorstream << "No future without main menu!" << std::endl;
206 } catch (LuaError &e) {
207 errorstream << "Main menu error: " << e.what() << std::endl;
208 m_data->script_data.errormessage = e.what();
216 /******************************************************************************/
217 bool GUIEngine::loadMainMenuScript()
219 // Set main menu path (for core.get_mainmenu_path())
220 m_scriptdir = g_settings->get("main_menu_path");
221 if (m_scriptdir.empty()) {
222 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
225 // Load builtin (which will load the main menu script)
226 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
228 m_script->loadScript(script);
229 m_script->checkSetByBuiltin();
230 // Menu script loaded
232 } catch (const ModError &e) {
233 errorstream << "GUIEngine: execution of menu script failed: "
234 << e.what() << std::endl;
240 /******************************************************************************/
241 void GUIEngine::run()
243 // Always create clouds because they may or may not be
244 // needed based on the game selected
245 video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
249 unsigned int text_height = g_fontengine->getTextHeight();
251 irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screen_w"),
252 g_settings->getU16("screen_h"));
254 static const video::SColor sky_color(255, 140, 186, 250);
258 video::SColor fog_color;
259 video::E_FOG_TYPE fog_type = video::EFT_FOG_LINEAR;
263 bool fog_pixelfog = false;
264 bool fog_rangefog = false;
265 driver->getFog(fog_color, fog_type, fog_start, fog_end, fog_density,
266 fog_pixelfog, fog_rangefog);
268 driver->setFog(sky_color, fog_type, fog_start, fog_end, fog_density,
269 fog_pixelfog, fog_rangefog);
272 while (m_rendering_engine->run() && (!m_startgame) && (!m_kill)) {
274 const irr::core::dimension2d<u32> ¤t_screen_size =
275 m_rendering_engine->get_video_driver()->getScreenSize();
276 // Verify if window size has changed and save it if it's the case
277 // Ensure evaluating settings->getBool after verifying screensize
278 // First condition is cheaper
279 if (previous_screen_size != current_screen_size &&
280 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
281 g_settings->getBool("autosave_screensize")) {
282 g_settings->setU16("screen_w", current_screen_size.Width);
283 g_settings->setU16("screen_h", current_screen_size.Height);
284 previous_screen_size = current_screen_size;
287 //check if we need to update the "upper left corner"-text
288 if (text_height != g_fontengine->getTextHeight()) {
289 updateTopLeftTextSize();
290 text_height = g_fontengine->getTextHeight();
293 driver->beginScene(true, true, sky_color);
295 if (m_clouds_enabled)
301 drawBackground(driver);
306 m_rendering_engine->get_gui_env()->drawAll();
310 IrrlichtDevice *device = m_rendering_engine->get_raw_device();
311 u32 frametime_min = 1000 / (device->isWindowFocused()
312 ? g_settings->getFloat("fps_max")
313 : g_settings->getFloat("fps_max_unfocused"));
314 if (m_clouds_enabled)
315 cloudPostProcess(frametime_min, device);
317 sleep_ms(frametime_min);
322 m_menu->getAndroidUIInput();
327 /******************************************************************************/
328 GUIEngine::~GUIEngine()
330 if (m_sound_manager != &dummySoundManager){
331 delete m_sound_manager;
332 m_sound_manager = NULL;
335 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
338 m_irr_toplefttext->setText(L"");
340 //clean up texture pointers
341 for (image_definition &texture : m_textures) {
343 m_rendering_engine->get_video_driver()->removeTexture(texture.texture);
346 delete m_texture_source;
349 m_cloud.clouds->drop();
352 /******************************************************************************/
353 void GUIEngine::cloudInit()
355 m_cloud.clouds = new Clouds(m_smgr, -1, rand());
356 m_cloud.clouds->setHeight(100.0f);
357 m_cloud.clouds->update(v3f(0, 0, 0), video::SColor(255,240,240,255));
359 m_cloud.camera = m_smgr->addCameraSceneNode(0,
360 v3f(0,0,0), v3f(0, 60, 100));
361 m_cloud.camera->setFarValue(10000);
363 m_cloud.lasttime = m_rendering_engine->get_timer_time();
366 /******************************************************************************/
367 void GUIEngine::cloudPreProcess()
369 u32 time = m_rendering_engine->get_timer_time();
371 if(time > m_cloud.lasttime)
372 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
376 m_cloud.lasttime = time;
378 m_cloud.clouds->step(m_cloud.dtime*3);
379 m_cloud.clouds->render();
383 /******************************************************************************/
384 void GUIEngine::cloudPostProcess(u32 frametime_min, IrrlichtDevice *device)
386 // Time of frame without fps limit
389 // not using getRealTime is necessary for wine
390 u32 time = m_rendering_engine->get_timer_time();
391 if(time > m_cloud.lasttime)
392 busytime_u32 = time - m_cloud.lasttime;
397 if (busytime_u32 < frametime_min) {
398 u32 sleeptime = frametime_min - busytime_u32;
399 device->sleep(sleeptime);
403 /******************************************************************************/
404 void GUIEngine::setFormspecPrepend(const std::string &fs)
407 m_menu->setFormspecPrepend(fs);
412 /******************************************************************************/
413 void GUIEngine::drawBackground(video::IVideoDriver *driver)
415 v2u32 screensize = driver->getScreenSize();
417 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
419 /* If no texture, draw background of solid color */
421 video::SColor color(255,80,58,37);
422 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
423 driver->draw2DRectangle(color, rect, NULL);
427 v2u32 sourcesize = texture->getOriginalSize();
429 if (m_textures[TEX_LAYER_BACKGROUND].tile)
432 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
433 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
434 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
436 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
438 draw2DImageFilterScaled(driver, texture,
439 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
440 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
447 // Chop background image to the smaller screen dimension
448 v2u32 bg_size = screensize;
450 (f32) bg_size.X / sourcesize.X,
451 (f32) bg_size.Y / sourcesize.Y);
452 if (scale.X < scale.Y)
453 bg_size.X = (int) (scale.Y * sourcesize.X);
455 bg_size.Y = (int) (scale.X * sourcesize.Y);
456 v2s32 offset = v2s32(
457 (s32) screensize.X - (s32) bg_size.X,
458 (s32) screensize.Y - (s32) bg_size.Y
460 /* Draw background texture */
461 draw2DImageFilterScaled(driver, texture,
462 core::rect<s32>(offset.X, offset.Y, bg_size.X + offset.X, bg_size.Y + offset.Y),
463 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
467 /******************************************************************************/
468 void GUIEngine::drawOverlay(video::IVideoDriver *driver)
470 v2u32 screensize = driver->getScreenSize();
472 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
474 /* If no texture, draw nothing */
478 /* Draw background texture */
479 v2u32 sourcesize = texture->getOriginalSize();
480 draw2DImageFilterScaled(driver, texture,
481 core::rect<s32>(0, 0, screensize.X, screensize.Y),
482 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
486 /******************************************************************************/
487 void GUIEngine::drawHeader(video::IVideoDriver *driver)
489 core::dimension2d<u32> screensize = driver->getScreenSize();
491 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
493 /* If no texture, draw nothing */
497 f32 mult = (((f32)screensize.Width / 2.0)) /
498 ((f32)texture->getOriginalSize().Width);
500 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
501 ((f32)texture->getOriginalSize().Height) * mult);
503 // Don't draw the header if there isn't enough room
504 s32 free_space = (((s32)screensize.Height)-320)/2;
506 if (free_space > splashsize.Y) {
507 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
508 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
509 ((free_space/2)-splashsize.Y/2)+10);
511 draw2DImageFilterScaled(driver, texture, splashrect,
512 core::rect<s32>(core::position2d<s32>(0,0),
513 core::dimension2di(texture->getOriginalSize())),
518 /******************************************************************************/
519 void GUIEngine::drawFooter(video::IVideoDriver *driver)
521 core::dimension2d<u32> screensize = driver->getScreenSize();
523 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
525 /* If no texture, draw nothing */
529 f32 mult = (((f32)screensize.Width)) /
530 ((f32)texture->getOriginalSize().Width);
532 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
533 ((f32)texture->getOriginalSize().Height) * mult);
535 // Don't draw the footer if there isn't enough room
536 s32 free_space = (((s32)screensize.Height)-320)/2;
538 if (free_space > footersize.Y) {
539 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
540 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
541 rect -= v2s32(footersize.X/2, 0);
543 draw2DImageFilterScaled(driver, texture, rect,
544 core::rect<s32>(core::position2d<s32>(0,0),
545 core::dimension2di(texture->getOriginalSize())),
550 /******************************************************************************/
551 bool GUIEngine::setTexture(texture_layer layer, const std::string &texturepath,
552 bool tile_image, unsigned int minsize)
554 video::IVideoDriver *driver = m_rendering_engine->get_video_driver();
556 if (m_textures[layer].texture) {
557 driver->removeTexture(m_textures[layer].texture);
558 m_textures[layer].texture = NULL;
561 if (texturepath.empty() || !fs::PathExists(texturepath)) {
565 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
566 m_textures[layer].tile = tile_image;
567 m_textures[layer].minsize = minsize;
569 if (!m_textures[layer].texture) {
576 /******************************************************************************/
577 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
580 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
581 if (!target_file.good()) {
585 HTTPFetchRequest fetch_request;
586 HTTPFetchResult fetch_result;
587 fetch_request.url = url;
588 fetch_request.caller = HTTPFETCH_SYNC;
589 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
590 httpfetch_sync(fetch_request, fetch_result);
592 if (!fetch_result.succeeded) {
594 fs::DeleteSingleFileOrEmptyDirectory(target);
597 target_file << fetch_result.data;
605 /******************************************************************************/
606 void GUIEngine::setTopleftText(const std::string &text)
608 m_toplefttext = translate_string(utf8_to_wide(text));
610 updateTopLeftTextSize();
613 /******************************************************************************/
614 void GUIEngine::updateTopLeftTextSize()
616 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
617 g_fontengine->getTextHeight());
620 m_irr_toplefttext->remove();
621 m_irr_toplefttext = gui::StaticText::add(m_rendering_engine->get_gui_env(),
622 m_toplefttext, rect, false, true, 0, -1);
625 /******************************************************************************/
626 s32 GUIEngine::playSound(const SimpleSoundSpec &spec)
628 s32 handle = m_sound_manager->playSound(spec);
632 /******************************************************************************/
633 void GUIEngine::stopSound(s32 handle)
635 m_sound_manager->stopSound(handle);