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);
108 base = porting::path_share + DIR_DELIM + "sounds";
109 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
112 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
113 base = porting::path_user + DIR_DELIM + "sounds";
114 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
116 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
119 /******************************************************************************/
121 /******************************************************************************/
122 GUIEngine::GUIEngine(JoystickController *joystick,
123 gui::IGUIElement *parent,
124 IMenuManager *menumgr,
128 m_menumanager(menumgr),
129 m_smgr(RenderingEngine::get_scene_manager()),
133 //initialize texture pointers
134 for (image_definition &texture : m_textures) {
135 texture.texture = NULL;
137 // is deleted by guiformspec!
138 m_buttonhandler = new TextDestGuiEngine(this);
140 //create texture source
141 m_texture_source = new MenuTextureSource(RenderingEngine::get_video_driver());
143 //create soundmanager
144 MenuMusicFetcher soundfetcher;
146 if (g_settings->getBool("enable_sound") && g_sound_manager_singleton.get())
147 m_sound_manager = createOpenALSoundManager(g_sound_manager_singleton.get(), &soundfetcher);
149 if (!m_sound_manager)
150 m_sound_manager = &dummySoundManager;
152 //create topleft header
155 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
156 g_fontengine->getTextHeight());
159 m_irr_toplefttext = gui::StaticText::add(RenderingEngine::get_gui_env(),
160 m_toplefttext, rect, false, true, 0, -1);
162 //create formspecsource
163 m_formspecgui = new FormspecFormSource("");
166 m_menu = new GUIFormSpecMenu(joystick,
178 m_menu->allowClose(false);
179 m_menu->lockSize(true,v2u32(800,600));
181 // Initialize scripting
183 infostream << "GUIEngine: Initializing Lua" << std::endl;
185 m_script = new MainMenuScripting(this);
188 m_script->setMainMenuData(&m_data->script_data);
189 m_data->script_data.errormessage = "";
191 if (!loadMainMenuScript()) {
192 errorstream << "No future without main menu!" << std::endl;
197 } catch (LuaError &e) {
198 errorstream << "Main menu error: " << e.what() << std::endl;
199 m_data->script_data.errormessage = e.what();
207 /******************************************************************************/
208 bool GUIEngine::loadMainMenuScript()
210 // Set main menu path (for core.get_mainmenu_path())
211 m_scriptdir = g_settings->get("main_menu_path");
212 if (m_scriptdir.empty()) {
213 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
216 // Load builtin (which will load the main menu script)
217 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
219 m_script->loadScript(script);
220 // Menu script loaded
222 } catch (const ModError &e) {
223 errorstream << "GUIEngine: execution of menu script failed: "
224 << e.what() << std::endl;
230 /******************************************************************************/
231 void GUIEngine::run()
233 // Always create clouds because they may or may not be
234 // needed based on the game selected
235 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
239 unsigned int text_height = g_fontengine->getTextHeight();
241 irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screen_w"),
242 g_settings->getU16("screen_h"));
244 static const video::SColor sky_color(255, 140, 186, 250);
248 video::SColor fog_color;
249 video::E_FOG_TYPE fog_type = video::EFT_FOG_LINEAR;
253 bool fog_pixelfog = false;
254 bool fog_rangefog = false;
255 driver->getFog(fog_color, fog_type, fog_start, fog_end, fog_density,
256 fog_pixelfog, fog_rangefog);
258 driver->setFog(sky_color, fog_type, fog_start, fog_end, fog_density,
259 fog_pixelfog, fog_rangefog);
262 while (RenderingEngine::run() && (!m_startgame) && (!m_kill)) {
264 const irr::core::dimension2d<u32> ¤t_screen_size =
265 RenderingEngine::get_video_driver()->getScreenSize();
266 // Verify if window size has changed and save it if it's the case
267 // Ensure evaluating settings->getBool after verifying screensize
268 // First condition is cheaper
269 if (previous_screen_size != current_screen_size &&
270 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
271 g_settings->getBool("autosave_screensize")) {
272 g_settings->setU16("screen_w", current_screen_size.Width);
273 g_settings->setU16("screen_h", current_screen_size.Height);
274 previous_screen_size = current_screen_size;
277 //check if we need to update the "upper left corner"-text
278 if (text_height != g_fontengine->getTextHeight()) {
279 updateTopLeftTextSize();
280 text_height = g_fontengine->getTextHeight();
283 driver->beginScene(true, true, sky_color);
285 if (m_clouds_enabled)
291 drawBackground(driver);
296 RenderingEngine::get_gui_env()->drawAll();
300 IrrlichtDevice *device = RenderingEngine::get_raw_device();
301 u32 frametime_min = 1000 / (device->isWindowFocused()
302 ? g_settings->getFloat("fps_max")
303 : g_settings->getFloat("fps_max_unfocused"));
304 if (m_clouds_enabled)
305 cloudPostProcess(frametime_min, device);
307 sleep_ms(frametime_min);
312 m_menu->getAndroidUIInput();
317 /******************************************************************************/
318 GUIEngine::~GUIEngine()
320 if (m_sound_manager != &dummySoundManager){
321 delete m_sound_manager;
322 m_sound_manager = NULL;
325 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
328 m_irr_toplefttext->setText(L"");
330 //clean up texture pointers
331 for (image_definition &texture : m_textures) {
333 RenderingEngine::get_video_driver()->removeTexture(texture.texture);
336 delete m_texture_source;
339 m_cloud.clouds->drop();
342 /******************************************************************************/
343 void GUIEngine::cloudInit()
345 m_cloud.clouds = new Clouds(m_smgr, -1, rand());
346 m_cloud.clouds->setHeight(100.0f);
347 m_cloud.clouds->update(v3f(0, 0, 0), video::SColor(255,240,240,255));
349 m_cloud.camera = m_smgr->addCameraSceneNode(0,
350 v3f(0,0,0), v3f(0, 60, 100));
351 m_cloud.camera->setFarValue(10000);
353 m_cloud.lasttime = RenderingEngine::get_timer_time();
356 /******************************************************************************/
357 void GUIEngine::cloudPreProcess()
359 u32 time = RenderingEngine::get_timer_time();
361 if(time > m_cloud.lasttime)
362 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
366 m_cloud.lasttime = time;
368 m_cloud.clouds->step(m_cloud.dtime*3);
369 m_cloud.clouds->render();
373 /******************************************************************************/
374 void GUIEngine::cloudPostProcess(u32 frametime_min, IrrlichtDevice *device)
376 // Time of frame without fps limit
379 // not using getRealTime is necessary for wine
380 u32 time = RenderingEngine::get_timer_time();
381 if(time > m_cloud.lasttime)
382 busytime_u32 = time - m_cloud.lasttime;
387 if (busytime_u32 < frametime_min) {
388 u32 sleeptime = frametime_min - busytime_u32;
389 device->sleep(sleeptime);
393 /******************************************************************************/
394 void GUIEngine::setFormspecPrepend(const std::string &fs)
397 m_menu->setFormspecPrepend(fs);
402 /******************************************************************************/
403 void GUIEngine::drawBackground(video::IVideoDriver *driver)
405 v2u32 screensize = driver->getScreenSize();
407 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
409 /* If no texture, draw background of solid color */
411 video::SColor color(255,80,58,37);
412 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
413 driver->draw2DRectangle(color, rect, NULL);
417 v2u32 sourcesize = texture->getOriginalSize();
419 if (m_textures[TEX_LAYER_BACKGROUND].tile)
422 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
423 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
424 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
426 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
428 draw2DImageFilterScaled(driver, texture,
429 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
430 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
437 /* Draw background texture */
438 draw2DImageFilterScaled(driver, texture,
439 core::rect<s32>(0, 0, screensize.X, screensize.Y),
440 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
444 /******************************************************************************/
445 void GUIEngine::drawOverlay(video::IVideoDriver *driver)
447 v2u32 screensize = driver->getScreenSize();
449 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
451 /* If no texture, draw nothing */
455 /* Draw background texture */
456 v2u32 sourcesize = texture->getOriginalSize();
457 draw2DImageFilterScaled(driver, texture,
458 core::rect<s32>(0, 0, screensize.X, screensize.Y),
459 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
463 /******************************************************************************/
464 void GUIEngine::drawHeader(video::IVideoDriver *driver)
466 core::dimension2d<u32> screensize = driver->getScreenSize();
468 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
470 /* If no texture, draw nothing */
474 f32 mult = (((f32)screensize.Width / 2.0)) /
475 ((f32)texture->getOriginalSize().Width);
477 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
478 ((f32)texture->getOriginalSize().Height) * mult);
480 // Don't draw the header if there isn't enough room
481 s32 free_space = (((s32)screensize.Height)-320)/2;
483 if (free_space > splashsize.Y) {
484 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
485 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
486 ((free_space/2)-splashsize.Y/2)+10);
488 draw2DImageFilterScaled(driver, texture, splashrect,
489 core::rect<s32>(core::position2d<s32>(0,0),
490 core::dimension2di(texture->getOriginalSize())),
495 /******************************************************************************/
496 void GUIEngine::drawFooter(video::IVideoDriver *driver)
498 core::dimension2d<u32> screensize = driver->getScreenSize();
500 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
502 /* If no texture, draw nothing */
506 f32 mult = (((f32)screensize.Width)) /
507 ((f32)texture->getOriginalSize().Width);
509 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
510 ((f32)texture->getOriginalSize().Height) * mult);
512 // Don't draw the footer if there isn't enough room
513 s32 free_space = (((s32)screensize.Height)-320)/2;
515 if (free_space > footersize.Y) {
516 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
517 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
518 rect -= v2s32(footersize.X/2, 0);
520 draw2DImageFilterScaled(driver, texture, rect,
521 core::rect<s32>(core::position2d<s32>(0,0),
522 core::dimension2di(texture->getOriginalSize())),
527 /******************************************************************************/
528 bool GUIEngine::setTexture(texture_layer layer, const std::string &texturepath,
529 bool tile_image, unsigned int minsize)
531 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
533 if (m_textures[layer].texture) {
534 driver->removeTexture(m_textures[layer].texture);
535 m_textures[layer].texture = NULL;
538 if (texturepath.empty() || !fs::PathExists(texturepath)) {
542 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
543 m_textures[layer].tile = tile_image;
544 m_textures[layer].minsize = minsize;
546 if (!m_textures[layer].texture) {
553 /******************************************************************************/
554 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
557 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
558 if (!target_file.good()) {
562 HTTPFetchRequest fetch_request;
563 HTTPFetchResult fetch_result;
564 fetch_request.url = url;
565 fetch_request.caller = HTTPFETCH_SYNC;
566 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
567 httpfetch_sync(fetch_request, fetch_result);
569 if (!fetch_result.succeeded) {
571 fs::DeleteSingleFileOrEmptyDirectory(target);
574 target_file << fetch_result.data;
582 /******************************************************************************/
583 void GUIEngine::setTopleftText(const std::string &text)
585 m_toplefttext = translate_string(utf8_to_wide(text));
587 updateTopLeftTextSize();
590 /******************************************************************************/
591 void GUIEngine::updateTopLeftTextSize()
593 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
594 g_fontengine->getTextHeight());
597 m_irr_toplefttext->remove();
598 m_irr_toplefttext = gui::StaticText::add(RenderingEngine::get_gui_env(),
599 m_toplefttext, rect, false, true, 0, -1);
602 /******************************************************************************/
603 s32 GUIEngine::playSound(const SimpleSoundSpec &spec, bool looped)
605 s32 handle = m_sound_manager->playSound(spec, looped);
609 /******************************************************************************/
610 void GUIEngine::stopSound(s32 handle)
612 m_sound_manager->stopSound(handle);
615 /******************************************************************************/
616 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
617 const std::string &serialized_params)
619 return m_script->queueAsync(serialized_func, serialized_params);