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"
23 #include <IGUIStaticText.h>
24 #include <ICameraSceneNode.h>
25 #include "scripting_mainmenu.h"
26 #include "util/numeric.h"
32 #include "guiMainMenu.h"
34 #include "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 /** TextDestGuiEngine */
50 /******************************************************************************/
51 TextDestGuiEngine::TextDestGuiEngine(GUIEngine* engine)
56 /******************************************************************************/
57 void TextDestGuiEngine::gotText(const StringMap &fields)
59 m_engine->getScriptIface()->handleMainMenuButtons(fields);
62 /******************************************************************************/
63 void TextDestGuiEngine::gotText(const std::wstring &text)
65 m_engine->getScriptIface()->handleMainMenuEvent(wide_to_utf8(text));
68 /******************************************************************************/
69 /** MenuTextureSource */
70 /******************************************************************************/
71 MenuTextureSource::MenuTextureSource(video::IVideoDriver *driver)
76 /******************************************************************************/
77 MenuTextureSource::~MenuTextureSource()
79 for (std::set<std::string>::iterator it = m_to_delete.begin();
80 it != m_to_delete.end(); ++it) {
81 const char *tname = (*it).c_str();
82 video::ITexture *texture = m_driver->getTexture(tname);
83 m_driver->removeTexture(texture);
87 /******************************************************************************/
88 video::ITexture* MenuTextureSource::getTexture(const std::string &name, u32 *id)
94 m_to_delete.insert(name);
97 video::IImage *image = m_driver->createImageFromFile(name.c_str());
99 image = Align2Npot2(image, m_driver);
100 video::ITexture* retval = m_driver->addTexture(name.c_str(), image);
105 return m_driver->getTexture(name.c_str());
108 /******************************************************************************/
109 /** MenuMusicFetcher */
110 /******************************************************************************/
111 void MenuMusicFetcher::fetchSounds(const std::string &name,
112 std::set<std::string> &dst_paths,
113 std::set<std::string> &dst_datas)
115 if(m_fetched.count(name))
117 m_fetched.insert(name);
119 base = porting::path_share + DIR_DELIM + "sounds";
120 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
123 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
124 base = porting::path_user + DIR_DELIM + "sounds";
125 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
127 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
130 /******************************************************************************/
132 /******************************************************************************/
133 GUIEngine::GUIEngine( irr::IrrlichtDevice* dev,
134 JoystickController *joystick,
135 gui::IGUIElement* parent,
136 IMenuManager *menumgr,
137 scene::ISceneManager* smgr,
142 m_menumanager(menumgr),
145 m_texture_source(NULL),
146 m_sound_manager(NULL),
154 m_irr_toplefttext(0),
155 m_clouds_enabled(true),
158 //initialize texture pointers
159 for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
160 m_textures[i].texture = NULL;
162 // is deleted by guiformspec!
163 m_buttonhandler = new TextDestGuiEngine(this);
165 //create texture source
166 m_texture_source = new MenuTextureSource(m_device->getVideoDriver());
168 //create soundmanager
169 MenuMusicFetcher soundfetcher;
171 m_sound_manager = createOpenALSoundManager(&soundfetcher);
174 m_sound_manager = &dummySoundManager;
176 //create topleft header
179 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
180 g_fontengine->getTextHeight());
184 addStaticText(m_device->getGUIEnvironment(), m_toplefttext,
185 rect, false, true, 0, -1);
187 //create formspecsource
188 m_formspecgui = new FormspecFormSource("");
191 m_menu = new GUIFormSpecMenu(m_device,
202 m_menu->allowClose(false);
203 m_menu->lockSize(true,v2u32(800,600));
205 // Initialize scripting
207 infostream << "GUIEngine: Initializing Lua" << std::endl;
209 m_script = new MainMenuScripting(this);
212 m_script->setMainMenuData(&m_data->script_data);
213 m_data->script_data.errormessage = "";
215 if (!loadMainMenuScript()) {
216 errorstream << "No future without main menu!" << std::endl;
221 } catch (LuaError &e) {
222 errorstream << "Main menu error: " << e.what() << std::endl;
223 m_data->script_data.errormessage = e.what();
231 /******************************************************************************/
232 bool GUIEngine::loadMainMenuScript()
234 // Set main menu path (for core.get_mainmenu_path())
235 m_scriptdir = g_settings->get("main_menu_path");
236 if (m_scriptdir.empty()) {
237 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
240 // Load builtin (which will load the main menu script)
241 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
243 m_script->loadScript(script);
244 // Menu script loaded
246 } catch (const ModError &e) {
247 errorstream << "GUIEngine: execution of menu script failed: "
248 << e.what() << std::endl;
254 /******************************************************************************/
255 void GUIEngine::run()
257 // Always create clouds because they may or may not be
258 // needed based on the game selected
259 video::IVideoDriver* driver = m_device->getVideoDriver();
263 unsigned int text_height = g_fontengine->getTextHeight();
265 while(m_device->run() && (!m_startgame) && (!m_kill))
267 //check if we need to update the "upper left corner"-text
268 if (text_height != g_fontengine->getTextHeight()) {
269 updateTopLeftTextSize();
270 text_height = g_fontengine->getTextHeight();
273 driver->beginScene(true, true, video::SColor(255,140,186,250));
275 if (m_clouds_enabled)
281 drawBackground(driver);
286 m_device->getGUIEnvironment()->drawAll();
290 if (m_clouds_enabled)
298 m_menu->getAndroidUIInput();
303 /******************************************************************************/
304 GUIEngine::~GUIEngine()
306 video::IVideoDriver* driver = m_device->getVideoDriver();
307 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
309 if(m_sound_manager != &dummySoundManager){
310 delete m_sound_manager;
311 m_sound_manager = NULL;
314 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
317 m_irr_toplefttext->setText(L"");
319 //clean up texture pointers
320 for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
321 if (m_textures[i].texture != NULL)
322 driver->removeTexture(m_textures[i].texture);
325 delete m_texture_source;
328 m_cloud.clouds->drop();
331 /******************************************************************************/
332 void GUIEngine::cloudInit()
334 m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
335 m_smgr, -1, rand(), 100);
336 m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
338 m_cloud.camera = m_smgr->addCameraSceneNode(0,
339 v3f(0,0,0), v3f(0, 60, 100));
340 m_cloud.camera->setFarValue(10000);
342 m_cloud.lasttime = m_device->getTimer()->getTime();
345 /******************************************************************************/
346 void GUIEngine::cloudPreProcess()
348 u32 time = m_device->getTimer()->getTime();
350 if(time > m_cloud.lasttime)
351 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
355 m_cloud.lasttime = time;
357 m_cloud.clouds->step(m_cloud.dtime*3);
358 m_cloud.clouds->render();
362 /******************************************************************************/
363 void GUIEngine::cloudPostProcess()
365 float fps_max = g_settings->getFloat("pause_fps_max");
366 // Time of frame without fps limit
369 // not using getRealTime is necessary for wine
370 u32 time = m_device->getTimer()->getTime();
371 if(time > m_cloud.lasttime)
372 busytime_u32 = time - m_cloud.lasttime;
377 u32 frametime_min = 1000./fps_max;
379 if(busytime_u32 < frametime_min) {
380 u32 sleeptime = frametime_min - busytime_u32;
381 m_device->sleep(sleeptime);
385 /******************************************************************************/
386 void GUIEngine::drawBackground(video::IVideoDriver* driver)
388 v2u32 screensize = driver->getScreenSize();
390 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
392 /* If no texture, draw background of solid color */
394 video::SColor color(255,80,58,37);
395 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
396 driver->draw2DRectangle(color, rect, NULL);
400 v2u32 sourcesize = texture->getOriginalSize();
402 if (m_textures[TEX_LAYER_BACKGROUND].tile)
405 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
406 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
407 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
409 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
411 draw2DImageFilterScaled(driver, texture,
412 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
413 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
420 /* Draw background texture */
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::drawOverlay(video::IVideoDriver* driver)
430 v2u32 screensize = driver->getScreenSize();
432 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
434 /* If no texture, draw nothing */
438 /* Draw background texture */
439 v2u32 sourcesize = texture->getOriginalSize();
440 draw2DImageFilterScaled(driver, texture,
441 core::rect<s32>(0, 0, screensize.X, screensize.Y),
442 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
446 /******************************************************************************/
447 void GUIEngine::drawHeader(video::IVideoDriver* driver)
449 core::dimension2d<u32> screensize = driver->getScreenSize();
451 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
453 /* If no texture, draw nothing */
457 f32 mult = (((f32)screensize.Width / 2.0)) /
458 ((f32)texture->getOriginalSize().Width);
460 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
461 ((f32)texture->getOriginalSize().Height) * mult);
463 // Don't draw the header if there isn't enough room
464 s32 free_space = (((s32)screensize.Height)-320)/2;
466 if (free_space > splashsize.Y) {
467 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
468 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
469 ((free_space/2)-splashsize.Y/2)+10);
471 video::SColor bgcolor(255,50,50,50);
473 draw2DImageFilterScaled(driver, texture, splashrect,
474 core::rect<s32>(core::position2d<s32>(0,0),
475 core::dimension2di(texture->getOriginalSize())),
480 /******************************************************************************/
481 void GUIEngine::drawFooter(video::IVideoDriver* driver)
483 core::dimension2d<u32> screensize = driver->getScreenSize();
485 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
487 /* If no texture, draw nothing */
491 f32 mult = (((f32)screensize.Width)) /
492 ((f32)texture->getOriginalSize().Width);
494 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
495 ((f32)texture->getOriginalSize().Height) * mult);
497 // Don't draw the footer if there isn't enough room
498 s32 free_space = (((s32)screensize.Height)-320)/2;
500 if (free_space > footersize.Y) {
501 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
502 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
503 rect -= v2s32(footersize.X/2, 0);
505 draw2DImageFilterScaled(driver, texture, rect,
506 core::rect<s32>(core::position2d<s32>(0,0),
507 core::dimension2di(texture->getOriginalSize())),
512 /******************************************************************************/
513 bool GUIEngine::setTexture(texture_layer layer, std::string texturepath,
514 bool tile_image, unsigned int minsize)
516 video::IVideoDriver* driver = m_device->getVideoDriver();
517 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
519 if (m_textures[layer].texture != NULL)
521 driver->removeTexture(m_textures[layer].texture);
522 m_textures[layer].texture = NULL;
525 if ((texturepath == "") || !fs::PathExists(texturepath))
530 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
531 m_textures[layer].tile = tile_image;
532 m_textures[layer].minsize = minsize;
534 if (m_textures[layer].texture == NULL)
542 /******************************************************************************/
543 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
546 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
548 if (!target_file.good()) {
552 HTTPFetchRequest fetch_request;
553 HTTPFetchResult fetch_result;
554 fetch_request.url = url;
555 fetch_request.caller = HTTPFETCH_SYNC;
556 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
557 httpfetch_sync(fetch_request, fetch_result);
559 if (!fetch_result.succeeded) {
562 target_file << fetch_result.data;
570 /******************************************************************************/
571 void GUIEngine::setTopleftText(const std::string &text)
573 m_toplefttext = utf8_to_wide(text);
575 updateTopLeftTextSize();
578 /******************************************************************************/
579 void GUIEngine::updateTopLeftTextSize()
581 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
582 g_fontengine->getTextHeight());
585 m_irr_toplefttext->remove();
587 addStaticText(m_device->getGUIEnvironment(), m_toplefttext,
588 rect, false, true, 0, -1);
591 /******************************************************************************/
592 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
594 s32 handle = m_sound_manager->playSound(spec, looped);
598 /******************************************************************************/
599 void GUIEngine::stopSound(s32 handle)
601 m_sound_manager->stopSound(handle);
604 /******************************************************************************/
605 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
606 const std::string &serialized_params)
608 return m_script->queueAsync(serialized_func, serialized_params);