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"
36 #include "httpfetch.h"
38 #include "fontengine.h"
39 #include "guiscalingfilter.h"
40 #include "irrlicht_changes/static_text.h"
43 #include "client/tile.h"
48 /******************************************************************************/
49 void TextDestGuiEngine::gotText(const StringMap &fields)
51 m_engine->getScriptIface()->handleMainMenuButtons(fields);
54 /******************************************************************************/
55 void TextDestGuiEngine::gotText(const std::wstring &text)
57 m_engine->getScriptIface()->handleMainMenuEvent(wide_to_utf8(text));
60 /******************************************************************************/
61 MenuTextureSource::~MenuTextureSource()
63 for (const std::string &texture_to_delete : m_to_delete) {
64 const char *tname = texture_to_delete.c_str();
65 video::ITexture *texture = m_driver->getTexture(tname);
66 m_driver->removeTexture(texture);
70 /******************************************************************************/
71 video::ITexture *MenuTextureSource::getTexture(const std::string &name, u32 *id)
77 m_to_delete.insert(name);
80 video::IImage *image = m_driver->createImageFromFile(name.c_str());
82 image = Align2Npot2(image, m_driver);
83 video::ITexture* retval = m_driver->addTexture(name.c_str(), image);
88 return m_driver->getTexture(name.c_str());
91 /******************************************************************************/
92 /** MenuMusicFetcher */
93 /******************************************************************************/
94 void MenuMusicFetcher::fetchSounds(const std::string &name,
95 std::set<std::string> &dst_paths,
96 std::set<std::string> &dst_datas)
98 if(m_fetched.count(name))
100 m_fetched.insert(name);
102 base = porting::path_share + DIR_DELIM + "sounds";
103 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
106 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
107 base = porting::path_user + DIR_DELIM + "sounds";
108 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
110 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
113 /******************************************************************************/
115 /******************************************************************************/
116 GUIEngine::GUIEngine(JoystickController *joystick,
117 gui::IGUIElement *parent,
118 IMenuManager *menumgr,
122 m_menumanager(menumgr),
123 m_smgr(RenderingEngine::get_scene_manager()),
127 //initialize texture pointers
128 for (image_definition &texture : m_textures) {
129 texture.texture = NULL;
131 // is deleted by guiformspec!
132 m_buttonhandler = new TextDestGuiEngine(this);
134 //create texture source
135 m_texture_source = new MenuTextureSource(RenderingEngine::get_video_driver());
137 //create soundmanager
138 MenuMusicFetcher soundfetcher;
140 if (g_settings->getBool("enable_sound"))
141 m_sound_manager = createOpenALSoundManager(g_sound_manager_singleton.get(), &soundfetcher);
144 m_sound_manager = &dummySoundManager;
146 //create topleft header
149 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
150 g_fontengine->getTextHeight());
153 m_irr_toplefttext = gui::StaticText::add(RenderingEngine::get_gui_env(),
154 m_toplefttext, rect, false, true, 0, -1);
156 //create formspecsource
157 m_formspecgui = new FormspecFormSource("");
160 m_menu = new GUIFormSpecMenu(joystick,
170 m_menu->allowClose(false);
171 m_menu->lockSize(true,v2u32(800,600));
173 // Initialize scripting
175 infostream << "GUIEngine: Initializing Lua" << std::endl;
177 m_script = new MainMenuScripting(this);
180 m_script->setMainMenuData(&m_data->script_data);
181 m_data->script_data.errormessage = "";
183 if (!loadMainMenuScript()) {
184 errorstream << "No future without main menu!" << std::endl;
189 } catch (LuaError &e) {
190 errorstream << "Main menu error: " << e.what() << std::endl;
191 m_data->script_data.errormessage = e.what();
199 /******************************************************************************/
200 bool GUIEngine::loadMainMenuScript()
202 // Set main menu path (for core.get_mainmenu_path())
203 m_scriptdir = g_settings->get("main_menu_path");
204 if (m_scriptdir.empty()) {
205 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
208 // Load builtin (which will load the main menu script)
209 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
211 m_script->loadScript(script);
212 // Menu script loaded
214 } catch (const ModError &e) {
215 errorstream << "GUIEngine: execution of menu script failed: "
216 << e.what() << std::endl;
222 /******************************************************************************/
223 void GUIEngine::run()
225 // Always create clouds because they may or may not be
226 // needed based on the game selected
227 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
231 unsigned int text_height = g_fontengine->getTextHeight();
233 irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screen_w"),
234 g_settings->getU16("screen_h"));
236 while (RenderingEngine::run() && (!m_startgame) && (!m_kill)) {
238 const irr::core::dimension2d<u32> ¤t_screen_size =
239 RenderingEngine::get_video_driver()->getScreenSize();
240 // Verify if window size has changed and save it if it's the case
241 // Ensure evaluating settings->getBool after verifying screensize
242 // First condition is cheaper
243 if (previous_screen_size != current_screen_size &&
244 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
245 g_settings->getBool("autosave_screensize")) {
246 g_settings->setU16("screen_w", current_screen_size.Width);
247 g_settings->setU16("screen_h", current_screen_size.Height);
248 previous_screen_size = current_screen_size;
251 //check if we need to update the "upper left corner"-text
252 if (text_height != g_fontengine->getTextHeight()) {
253 updateTopLeftTextSize();
254 text_height = g_fontengine->getTextHeight();
257 driver->beginScene(true, true, video::SColor(255,140,186,250));
259 if (m_clouds_enabled)
265 drawBackground(driver);
270 RenderingEngine::get_gui_env()->drawAll();
274 if (m_clouds_enabled)
282 m_menu->getAndroidUIInput();
287 /******************************************************************************/
288 GUIEngine::~GUIEngine()
290 if (m_sound_manager != &dummySoundManager){
291 delete m_sound_manager;
292 m_sound_manager = NULL;
295 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
298 m_irr_toplefttext->setText(L"");
300 //clean up texture pointers
301 for (image_definition &texture : m_textures) {
303 RenderingEngine::get_video_driver()->removeTexture(texture.texture);
306 delete m_texture_source;
309 m_cloud.clouds->drop();
312 /******************************************************************************/
313 void GUIEngine::cloudInit()
315 m_cloud.clouds = new Clouds(m_smgr, -1, rand());
316 m_cloud.clouds->setHeight(100.0f);
317 m_cloud.clouds->update(v3f(0, 0, 0), video::SColor(255,200,200,255));
319 m_cloud.camera = m_smgr->addCameraSceneNode(0,
320 v3f(0,0,0), v3f(0, 60, 100));
321 m_cloud.camera->setFarValue(10000);
323 m_cloud.lasttime = RenderingEngine::get_timer_time();
326 /******************************************************************************/
327 void GUIEngine::cloudPreProcess()
329 u32 time = RenderingEngine::get_timer_time();
331 if(time > m_cloud.lasttime)
332 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
336 m_cloud.lasttime = time;
338 m_cloud.clouds->step(m_cloud.dtime*3);
339 m_cloud.clouds->render();
343 /******************************************************************************/
344 void GUIEngine::cloudPostProcess()
346 float fps_max = g_settings->getFloat("pause_fps_max");
347 // Time of frame without fps limit
350 // not using getRealTime is necessary for wine
351 u32 time = RenderingEngine::get_timer_time();
352 if(time > m_cloud.lasttime)
353 busytime_u32 = time - m_cloud.lasttime;
358 u32 frametime_min = 1000./fps_max;
360 if (busytime_u32 < frametime_min) {
361 u32 sleeptime = frametime_min - busytime_u32;
362 RenderingEngine::get_raw_device()->sleep(sleeptime);
366 /******************************************************************************/
367 void GUIEngine::drawBackground(video::IVideoDriver *driver)
369 v2u32 screensize = driver->getScreenSize();
371 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
373 /* If no texture, draw background of solid color */
375 video::SColor color(255,80,58,37);
376 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
377 driver->draw2DRectangle(color, rect, NULL);
381 v2u32 sourcesize = texture->getOriginalSize();
383 if (m_textures[TEX_LAYER_BACKGROUND].tile)
386 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
387 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
388 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
390 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
392 draw2DImageFilterScaled(driver, texture,
393 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
394 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
401 /* Draw background texture */
402 draw2DImageFilterScaled(driver, texture,
403 core::rect<s32>(0, 0, screensize.X, screensize.Y),
404 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
408 /******************************************************************************/
409 void GUIEngine::drawOverlay(video::IVideoDriver *driver)
411 v2u32 screensize = driver->getScreenSize();
413 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
415 /* If no texture, draw nothing */
419 /* Draw background texture */
420 v2u32 sourcesize = texture->getOriginalSize();
421 draw2DImageFilterScaled(driver, texture,
422 core::rect<s32>(0, 0, screensize.X, screensize.Y),
423 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
427 /******************************************************************************/
428 void GUIEngine::drawHeader(video::IVideoDriver *driver)
430 core::dimension2d<u32> screensize = driver->getScreenSize();
432 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
434 /* If no texture, draw nothing */
438 f32 mult = (((f32)screensize.Width / 2.0)) /
439 ((f32)texture->getOriginalSize().Width);
441 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
442 ((f32)texture->getOriginalSize().Height) * mult);
444 // Don't draw the header if there isn't enough room
445 s32 free_space = (((s32)screensize.Height)-320)/2;
447 if (free_space > splashsize.Y) {
448 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
449 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
450 ((free_space/2)-splashsize.Y/2)+10);
452 video::SColor bgcolor(255,50,50,50);
454 draw2DImageFilterScaled(driver, texture, splashrect,
455 core::rect<s32>(core::position2d<s32>(0,0),
456 core::dimension2di(texture->getOriginalSize())),
461 /******************************************************************************/
462 void GUIEngine::drawFooter(video::IVideoDriver *driver)
464 core::dimension2d<u32> screensize = driver->getScreenSize();
466 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
468 /* If no texture, draw nothing */
472 f32 mult = (((f32)screensize.Width)) /
473 ((f32)texture->getOriginalSize().Width);
475 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
476 ((f32)texture->getOriginalSize().Height) * mult);
478 // Don't draw the footer if there isn't enough room
479 s32 free_space = (((s32)screensize.Height)-320)/2;
481 if (free_space > footersize.Y) {
482 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
483 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
484 rect -= v2s32(footersize.X/2, 0);
486 draw2DImageFilterScaled(driver, texture, rect,
487 core::rect<s32>(core::position2d<s32>(0,0),
488 core::dimension2di(texture->getOriginalSize())),
493 /******************************************************************************/
494 bool GUIEngine::setTexture(texture_layer layer, std::string texturepath,
495 bool tile_image, unsigned int minsize)
497 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
499 if (m_textures[layer].texture) {
500 driver->removeTexture(m_textures[layer].texture);
501 m_textures[layer].texture = NULL;
504 if (texturepath.empty() || !fs::PathExists(texturepath)) {
508 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
509 m_textures[layer].tile = tile_image;
510 m_textures[layer].minsize = minsize;
512 if (!m_textures[layer].texture) {
519 /******************************************************************************/
520 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
523 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
525 if (!target_file.good()) {
529 HTTPFetchRequest fetch_request;
530 HTTPFetchResult fetch_result;
531 fetch_request.url = url;
532 fetch_request.caller = HTTPFETCH_SYNC;
533 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
534 httpfetch_sync(fetch_request, fetch_result);
536 if (!fetch_result.succeeded) {
539 target_file << fetch_result.data;
547 /******************************************************************************/
548 void GUIEngine::setTopleftText(const std::string &text)
550 m_toplefttext = translate_string(utf8_to_wide(text));
552 updateTopLeftTextSize();
555 /******************************************************************************/
556 void GUIEngine::updateTopLeftTextSize()
558 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
559 g_fontengine->getTextHeight());
562 m_irr_toplefttext->remove();
563 m_irr_toplefttext = gui::StaticText::add(RenderingEngine::get_gui_env(),
564 m_toplefttext, rect, false, true, 0, -1);
567 /******************************************************************************/
568 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
570 s32 handle = m_sound_manager->playSound(spec, looped);
574 /******************************************************************************/
575 void GUIEngine::stopSound(s32 handle)
577 m_sound_manager->stopSound(handle);
580 /******************************************************************************/
581 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
582 const std::string &serialized_params)
584 return m_script->queueAsync(serialized_func, serialized_params);