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 irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screenW"),
266 g_settings->getU16("screenH"));
268 while (m_device->run() && (!m_startgame) && (!m_kill)) {
270 const irr::core::dimension2d<u32> ¤t_screen_size =
271 m_device->getVideoDriver()->getScreenSize();
272 // Verify if window size has changed and save it if it's the case
273 // Ensure evaluating settings->getBool after verifying screensize
274 // First condition is cheaper
275 if (previous_screen_size != current_screen_size &&
276 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
277 g_settings->getBool("autosave_screensize")) {
278 g_settings->setU16("screenW", current_screen_size.Width);
279 g_settings->setU16("screenH", current_screen_size.Height);
280 previous_screen_size = current_screen_size;
283 //check if we need to update the "upper left corner"-text
284 if (text_height != g_fontengine->getTextHeight()) {
285 updateTopLeftTextSize();
286 text_height = g_fontengine->getTextHeight();
289 driver->beginScene(true, true, video::SColor(255,140,186,250));
291 if (m_clouds_enabled)
297 drawBackground(driver);
302 m_device->getGUIEnvironment()->drawAll();
306 if (m_clouds_enabled)
314 m_menu->getAndroidUIInput();
319 /******************************************************************************/
320 GUIEngine::~GUIEngine()
322 video::IVideoDriver* driver = m_device->getVideoDriver();
323 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
325 if(m_sound_manager != &dummySoundManager){
326 delete m_sound_manager;
327 m_sound_manager = NULL;
330 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
333 m_irr_toplefttext->setText(L"");
335 //clean up texture pointers
336 for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
337 if (m_textures[i].texture != NULL)
338 driver->removeTexture(m_textures[i].texture);
341 delete m_texture_source;
344 m_cloud.clouds->drop();
347 /******************************************************************************/
348 void GUIEngine::cloudInit()
350 m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
351 m_smgr, -1, rand(), 100);
352 m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
354 m_cloud.camera = m_smgr->addCameraSceneNode(0,
355 v3f(0,0,0), v3f(0, 60, 100));
356 m_cloud.camera->setFarValue(10000);
358 m_cloud.lasttime = m_device->getTimer()->getTime();
361 /******************************************************************************/
362 void GUIEngine::cloudPreProcess()
364 u32 time = m_device->getTimer()->getTime();
366 if(time > m_cloud.lasttime)
367 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
371 m_cloud.lasttime = time;
373 m_cloud.clouds->step(m_cloud.dtime*3);
374 m_cloud.clouds->render();
378 /******************************************************************************/
379 void GUIEngine::cloudPostProcess()
381 float fps_max = g_settings->getFloat("pause_fps_max");
382 // Time of frame without fps limit
385 // not using getRealTime is necessary for wine
386 u32 time = m_device->getTimer()->getTime();
387 if(time > m_cloud.lasttime)
388 busytime_u32 = time - m_cloud.lasttime;
393 u32 frametime_min = 1000./fps_max;
395 if(busytime_u32 < frametime_min) {
396 u32 sleeptime = frametime_min - busytime_u32;
397 m_device->sleep(sleeptime);
401 /******************************************************************************/
402 void GUIEngine::drawBackground(video::IVideoDriver* driver)
404 v2u32 screensize = driver->getScreenSize();
406 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
408 /* If no texture, draw background of solid color */
410 video::SColor color(255,80,58,37);
411 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
412 driver->draw2DRectangle(color, rect, NULL);
416 v2u32 sourcesize = texture->getOriginalSize();
418 if (m_textures[TEX_LAYER_BACKGROUND].tile)
421 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
422 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
423 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
425 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
427 draw2DImageFilterScaled(driver, texture,
428 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
429 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
436 /* Draw background texture */
437 draw2DImageFilterScaled(driver, texture,
438 core::rect<s32>(0, 0, screensize.X, screensize.Y),
439 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
443 /******************************************************************************/
444 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
446 v2u32 screensize = driver->getScreenSize();
448 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
450 /* If no texture, draw nothing */
454 /* Draw background texture */
455 v2u32 sourcesize = texture->getOriginalSize();
456 draw2DImageFilterScaled(driver, texture,
457 core::rect<s32>(0, 0, screensize.X, screensize.Y),
458 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
462 /******************************************************************************/
463 void GUIEngine::drawHeader(video::IVideoDriver* driver)
465 core::dimension2d<u32> screensize = driver->getScreenSize();
467 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
469 /* If no texture, draw nothing */
473 f32 mult = (((f32)screensize.Width / 2.0)) /
474 ((f32)texture->getOriginalSize().Width);
476 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
477 ((f32)texture->getOriginalSize().Height) * mult);
479 // Don't draw the header if there isn't enough room
480 s32 free_space = (((s32)screensize.Height)-320)/2;
482 if (free_space > splashsize.Y) {
483 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
484 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
485 ((free_space/2)-splashsize.Y/2)+10);
487 video::SColor bgcolor(255,50,50,50);
489 draw2DImageFilterScaled(driver, texture, splashrect,
490 core::rect<s32>(core::position2d<s32>(0,0),
491 core::dimension2di(texture->getOriginalSize())),
496 /******************************************************************************/
497 void GUIEngine::drawFooter(video::IVideoDriver* driver)
499 core::dimension2d<u32> screensize = driver->getScreenSize();
501 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
503 /* If no texture, draw nothing */
507 f32 mult = (((f32)screensize.Width)) /
508 ((f32)texture->getOriginalSize().Width);
510 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
511 ((f32)texture->getOriginalSize().Height) * mult);
513 // Don't draw the footer if there isn't enough room
514 s32 free_space = (((s32)screensize.Height)-320)/2;
516 if (free_space > footersize.Y) {
517 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
518 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
519 rect -= v2s32(footersize.X/2, 0);
521 draw2DImageFilterScaled(driver, texture, rect,
522 core::rect<s32>(core::position2d<s32>(0,0),
523 core::dimension2di(texture->getOriginalSize())),
528 /******************************************************************************/
529 bool GUIEngine::setTexture(texture_layer layer, std::string texturepath,
530 bool tile_image, unsigned int minsize)
532 video::IVideoDriver* driver = m_device->getVideoDriver();
533 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
535 if (m_textures[layer].texture != NULL)
537 driver->removeTexture(m_textures[layer].texture);
538 m_textures[layer].texture = NULL;
541 if ((texturepath == "") || !fs::PathExists(texturepath))
546 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
547 m_textures[layer].tile = tile_image;
548 m_textures[layer].minsize = minsize;
550 if (m_textures[layer].texture == NULL)
558 /******************************************************************************/
559 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
562 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
564 if (!target_file.good()) {
568 HTTPFetchRequest fetch_request;
569 HTTPFetchResult fetch_result;
570 fetch_request.url = url;
571 fetch_request.caller = HTTPFETCH_SYNC;
572 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
573 httpfetch_sync(fetch_request, fetch_result);
575 if (!fetch_result.succeeded) {
578 target_file << fetch_result.data;
586 /******************************************************************************/
587 void GUIEngine::setTopleftText(const std::string &text)
589 m_toplefttext = utf8_to_wide(text);
591 updateTopLeftTextSize();
594 /******************************************************************************/
595 void GUIEngine::updateTopLeftTextSize()
597 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
598 g_fontengine->getTextHeight());
601 m_irr_toplefttext->remove();
603 addStaticText(m_device->getGUIEnvironment(), m_toplefttext,
604 rect, false, true, 0, -1);
607 /******************************************************************************/
608 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
610 s32 handle = m_sound_manager->playSound(spec, looped);
614 /******************************************************************************/
615 void GUIEngine::stopSound(s32 handle)
617 m_sound_manager->stopSound(handle);
620 /******************************************************************************/
621 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
622 const std::string &serialized_params)
624 return m_script->queueAsync(serialized_func, serialized_params);