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),
147 //initialize texture pointers
148 for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
149 m_textures[i].texture = NULL;
151 // is deleted by guiformspec!
152 m_buttonhandler = new TextDestGuiEngine(this);
154 //create texture source
155 m_texture_source = new MenuTextureSource(m_device->getVideoDriver());
157 //create soundmanager
158 MenuMusicFetcher soundfetcher;
160 m_sound_manager = createOpenALSoundManager(&soundfetcher);
163 m_sound_manager = &dummySoundManager;
165 //create topleft header
168 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
169 g_fontengine->getTextHeight());
173 addStaticText(m_device->getGUIEnvironment(), m_toplefttext,
174 rect, false, true, 0, -1);
176 //create formspecsource
177 m_formspecgui = new FormspecFormSource("");
180 m_menu = new GUIFormSpecMenu(m_device,
191 m_menu->allowClose(false);
192 m_menu->lockSize(true,v2u32(800,600));
194 // Initialize scripting
196 infostream << "GUIEngine: Initializing Lua" << std::endl;
198 m_script = new MainMenuScripting(this);
201 m_script->setMainMenuData(&m_data->script_data);
202 m_data->script_data.errormessage = "";
204 if (!loadMainMenuScript()) {
205 errorstream << "No future without main menu!" << std::endl;
210 } catch (LuaError &e) {
211 errorstream << "Main menu error: " << e.what() << std::endl;
212 m_data->script_data.errormessage = e.what();
220 /******************************************************************************/
221 bool GUIEngine::loadMainMenuScript()
223 // Set main menu path (for core.get_mainmenu_path())
224 m_scriptdir = g_settings->get("main_menu_path");
225 if (m_scriptdir.empty()) {
226 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
229 // Load builtin (which will load the main menu script)
230 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
232 m_script->loadScript(script);
233 // Menu script loaded
235 } catch (const ModError &e) {
236 errorstream << "GUIEngine: execution of menu script failed: "
237 << e.what() << std::endl;
243 /******************************************************************************/
244 void GUIEngine::run()
246 // Always create clouds because they may or may not be
247 // needed based on the game selected
248 video::IVideoDriver* driver = m_device->getVideoDriver();
252 unsigned int text_height = g_fontengine->getTextHeight();
254 irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screen_w"),
255 g_settings->getU16("screen_h"));
257 while (m_device->run() && (!m_startgame) && (!m_kill)) {
259 const irr::core::dimension2d<u32> ¤t_screen_size =
260 m_device->getVideoDriver()->getScreenSize();
261 // Verify if window size has changed and save it if it's the case
262 // Ensure evaluating settings->getBool after verifying screensize
263 // First condition is cheaper
264 if (previous_screen_size != current_screen_size &&
265 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
266 g_settings->getBool("autosave_screensize")) {
267 g_settings->setU16("screen_w", current_screen_size.Width);
268 g_settings->setU16("screen_h", current_screen_size.Height);
269 previous_screen_size = current_screen_size;
272 //check if we need to update the "upper left corner"-text
273 if (text_height != g_fontengine->getTextHeight()) {
274 updateTopLeftTextSize();
275 text_height = g_fontengine->getTextHeight();
278 driver->beginScene(true, true, video::SColor(255,140,186,250));
280 if (m_clouds_enabled)
286 drawBackground(driver);
291 m_device->getGUIEnvironment()->drawAll();
295 if (m_clouds_enabled)
303 m_menu->getAndroidUIInput();
308 /******************************************************************************/
309 GUIEngine::~GUIEngine()
311 video::IVideoDriver* driver = m_device->getVideoDriver();
312 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
314 if(m_sound_manager != &dummySoundManager){
315 delete m_sound_manager;
316 m_sound_manager = NULL;
319 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
322 m_irr_toplefttext->setText(L"");
324 //clean up texture pointers
325 for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
326 if (m_textures[i].texture)
327 driver->removeTexture(m_textures[i].texture);
330 delete m_texture_source;
333 m_cloud.clouds->drop();
336 /******************************************************************************/
337 void GUIEngine::cloudInit()
339 m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
340 m_smgr, -1, rand(), 100);
341 m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
343 m_cloud.camera = m_smgr->addCameraSceneNode(0,
344 v3f(0,0,0), v3f(0, 60, 100));
345 m_cloud.camera->setFarValue(10000);
347 m_cloud.lasttime = m_device->getTimer()->getTime();
350 /******************************************************************************/
351 void GUIEngine::cloudPreProcess()
353 u32 time = m_device->getTimer()->getTime();
355 if(time > m_cloud.lasttime)
356 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
360 m_cloud.lasttime = time;
362 m_cloud.clouds->step(m_cloud.dtime*3);
363 m_cloud.clouds->render();
367 /******************************************************************************/
368 void GUIEngine::cloudPostProcess()
370 float fps_max = g_settings->getFloat("pause_fps_max");
371 // Time of frame without fps limit
374 // not using getRealTime is necessary for wine
375 u32 time = m_device->getTimer()->getTime();
376 if(time > m_cloud.lasttime)
377 busytime_u32 = time - m_cloud.lasttime;
382 u32 frametime_min = 1000./fps_max;
384 if(busytime_u32 < frametime_min) {
385 u32 sleeptime = frametime_min - busytime_u32;
386 m_device->sleep(sleeptime);
390 /******************************************************************************/
391 void GUIEngine::drawBackground(video::IVideoDriver* driver)
393 v2u32 screensize = driver->getScreenSize();
395 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
397 /* If no texture, draw background of solid color */
399 video::SColor color(255,80,58,37);
400 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
401 driver->draw2DRectangle(color, rect, NULL);
405 v2u32 sourcesize = texture->getOriginalSize();
407 if (m_textures[TEX_LAYER_BACKGROUND].tile)
410 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
411 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
412 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
414 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
416 draw2DImageFilterScaled(driver, texture,
417 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
418 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
425 /* Draw background texture */
426 draw2DImageFilterScaled(driver, texture,
427 core::rect<s32>(0, 0, screensize.X, screensize.Y),
428 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
432 /******************************************************************************/
433 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
435 v2u32 screensize = driver->getScreenSize();
437 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
439 /* If no texture, draw nothing */
443 /* Draw background texture */
444 v2u32 sourcesize = texture->getOriginalSize();
445 draw2DImageFilterScaled(driver, texture,
446 core::rect<s32>(0, 0, screensize.X, screensize.Y),
447 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
451 /******************************************************************************/
452 void GUIEngine::drawHeader(video::IVideoDriver* driver)
454 core::dimension2d<u32> screensize = driver->getScreenSize();
456 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
458 /* If no texture, draw nothing */
462 f32 mult = (((f32)screensize.Width / 2.0)) /
463 ((f32)texture->getOriginalSize().Width);
465 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
466 ((f32)texture->getOriginalSize().Height) * mult);
468 // Don't draw the header if there isn't enough room
469 s32 free_space = (((s32)screensize.Height)-320)/2;
471 if (free_space > splashsize.Y) {
472 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
473 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
474 ((free_space/2)-splashsize.Y/2)+10);
476 video::SColor bgcolor(255,50,50,50);
478 draw2DImageFilterScaled(driver, texture, splashrect,
479 core::rect<s32>(core::position2d<s32>(0,0),
480 core::dimension2di(texture->getOriginalSize())),
485 /******************************************************************************/
486 void GUIEngine::drawFooter(video::IVideoDriver* driver)
488 core::dimension2d<u32> screensize = driver->getScreenSize();
490 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
492 /* If no texture, draw nothing */
496 f32 mult = (((f32)screensize.Width)) /
497 ((f32)texture->getOriginalSize().Width);
499 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
500 ((f32)texture->getOriginalSize().Height) * mult);
502 // Don't draw the footer if there isn't enough room
503 s32 free_space = (((s32)screensize.Height)-320)/2;
505 if (free_space > footersize.Y) {
506 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
507 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
508 rect -= v2s32(footersize.X/2, 0);
510 draw2DImageFilterScaled(driver, texture, rect,
511 core::rect<s32>(core::position2d<s32>(0,0),
512 core::dimension2di(texture->getOriginalSize())),
517 /******************************************************************************/
518 bool GUIEngine::setTexture(texture_layer layer, std::string texturepath,
519 bool tile_image, unsigned int minsize)
521 video::IVideoDriver* driver = m_device->getVideoDriver();
522 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
524 if (m_textures[layer].texture != NULL)
526 driver->removeTexture(m_textures[layer].texture);
527 m_textures[layer].texture = NULL;
530 if ((texturepath == "") || !fs::PathExists(texturepath))
535 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
536 m_textures[layer].tile = tile_image;
537 m_textures[layer].minsize = minsize;
539 if (m_textures[layer].texture == NULL)
547 /******************************************************************************/
548 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
551 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
553 if (!target_file.good()) {
557 HTTPFetchRequest fetch_request;
558 HTTPFetchResult fetch_result;
559 fetch_request.url = url;
560 fetch_request.caller = HTTPFETCH_SYNC;
561 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
562 httpfetch_sync(fetch_request, fetch_result);
564 if (!fetch_result.succeeded) {
567 target_file << fetch_result.data;
575 /******************************************************************************/
576 void GUIEngine::setTopleftText(const std::string &text)
578 m_toplefttext = utf8_to_wide(text);
580 updateTopLeftTextSize();
583 /******************************************************************************/
584 void GUIEngine::updateTopLeftTextSize()
586 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
587 g_fontengine->getTextHeight());
590 m_irr_toplefttext->remove();
592 addStaticText(m_device->getGUIEnvironment(), m_toplefttext,
593 rect, false, true, 0, -1);
596 /******************************************************************************/
597 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
599 s32 handle = m_sound_manager->playSound(spec, looped);
603 /******************************************************************************/
604 void GUIEngine::stopSound(s32 handle)
606 m_sound_manager->stopSound(handle);
609 /******************************************************************************/
610 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
611 const std::string &serialized_params)
613 return m_script->queueAsync(serialized_func, serialized_params);