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"
42 #include "client/tile.h"
47 /******************************************************************************/
48 /** TextDestGuiEngine */
49 /******************************************************************************/
50 TextDestGuiEngine::TextDestGuiEngine(GUIEngine* engine)
55 /******************************************************************************/
56 void TextDestGuiEngine::gotText(const StringMap &fields)
58 m_engine->getScriptIface()->handleMainMenuButtons(fields);
61 /******************************************************************************/
62 void TextDestGuiEngine::gotText(std::wstring text)
64 m_engine->getScriptIface()->handleMainMenuEvent(wide_to_utf8(text));
67 /******************************************************************************/
68 /** MenuTextureSource */
69 /******************************************************************************/
70 MenuTextureSource::MenuTextureSource(video::IVideoDriver *driver)
75 /******************************************************************************/
76 MenuTextureSource::~MenuTextureSource()
78 for (std::set<std::string>::iterator it = m_to_delete.begin();
79 it != m_to_delete.end(); ++it) {
80 const char *tname = (*it).c_str();
81 video::ITexture *texture = m_driver->getTexture(tname);
82 m_driver->removeTexture(texture);
86 /******************************************************************************/
87 video::ITexture* MenuTextureSource::getTexture(const std::string &name, u32 *id)
93 m_to_delete.insert(name);
96 video::IImage *image = m_driver->createImageFromFile(name.c_str());
98 image = Align2Npot2(image, m_driver);
99 video::ITexture* retval = m_driver->addTexture(name.c_str(), image);
104 return m_driver->getTexture(name.c_str());
107 /******************************************************************************/
108 /** MenuMusicFetcher */
109 /******************************************************************************/
110 void MenuMusicFetcher::fetchSounds(const std::string &name,
111 std::set<std::string> &dst_paths,
112 std::set<std::string> &dst_datas)
114 if(m_fetched.count(name))
116 m_fetched.insert(name);
118 base = porting::path_share + DIR_DELIM + "sounds";
119 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
122 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
123 base = porting::path_user + DIR_DELIM + "sounds";
124 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
126 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
129 /******************************************************************************/
131 /******************************************************************************/
132 GUIEngine::GUIEngine( irr::IrrlichtDevice* dev,
133 gui::IGUIElement* parent,
134 IMenuManager *menumgr,
135 scene::ISceneManager* smgr,
140 m_menumanager(menumgr),
143 m_texture_source(NULL),
144 m_sound_manager(NULL),
152 m_irr_toplefttext(0),
153 m_clouds_enabled(true),
156 //initialize texture pointers
157 for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
158 m_textures[i].texture = NULL;
160 // is deleted by guiformspec!
161 m_buttonhandler = new TextDestGuiEngine(this);
163 //create texture source
164 m_texture_source = new MenuTextureSource(m_device->getVideoDriver());
166 //create soundmanager
167 MenuMusicFetcher soundfetcher;
169 m_sound_manager = createOpenALSoundManager(&soundfetcher);
172 m_sound_manager = &dummySoundManager;
174 //create topleft header
175 std::wstring t = utf8_to_wide(std::string(PROJECT_NAME_C " ") +
178 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(t), g_fontengine->getTextHeight());
182 m_device->getGUIEnvironment()->addStaticText(t.c_str(),
183 rect,false,true,0,-1);
185 //create formspecsource
186 m_formspecgui = new FormspecFormSource("");
189 m_menu = new GUIFormSpecMenu(m_device,
201 m_menu->allowClose(false);
202 m_menu->lockSize(true,v2u32(800,600));
204 // Initialize scripting
206 infostream << "GUIEngine: Initializing Lua" << std::endl;
208 m_script = new MainMenuScripting(this);
211 m_script->setMainMenuData(&m_data->script_data);
212 m_data->script_data.errormessage = "";
214 if (!loadMainMenuScript()) {
215 errorstream << "No future without mainmenu" << std::endl;
220 } catch (LuaError &e) {
221 errorstream << "MAINMENU ERROR: " << e.what() << std::endl;
222 m_data->script_data.errormessage = e.what();
230 /******************************************************************************/
231 bool GUIEngine::loadMainMenuScript()
233 // Try custom menu script (main_menu_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 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
241 if (m_script->loadScript(script)) {
242 // Menu script loaded
246 << "GUIEngine: execution of menu script in: \""
247 << m_scriptdir << "\" failed!" << std::endl;
253 /******************************************************************************/
254 void GUIEngine::run()
256 // Always create clouds because they may or may not be
257 // needed based on the game selected
258 video::IVideoDriver* driver = m_device->getVideoDriver();
262 unsigned int text_height = g_fontengine->getTextHeight();
264 while(m_device->run() && (!m_startgame) && (!m_kill))
266 //check if we need to update the "upper left corner"-text
267 if (text_height != g_fontengine->getTextHeight()) {
268 updateTopLeftTextSize();
269 text_height = g_fontengine->getTextHeight();
272 driver->beginScene(true, true, video::SColor(255,140,186,250));
274 if (m_clouds_enabled)
280 drawBackground(driver);
285 m_device->getGUIEnvironment()->drawAll();
289 if (m_clouds_enabled)
297 m_menu->getAndroidUIInput();
302 /******************************************************************************/
303 GUIEngine::~GUIEngine()
305 video::IVideoDriver* driver = m_device->getVideoDriver();
306 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
308 if(m_sound_manager != &dummySoundManager){
309 delete m_sound_manager;
310 m_sound_manager = NULL;
313 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
316 m_irr_toplefttext->setText(L"");
318 //clean up texture pointers
319 for (unsigned int i = 0; i < TEX_LAYER_MAX; i++) {
320 if (m_textures[i].texture != NULL)
321 driver->removeTexture(m_textures[i].texture);
324 delete m_texture_source;
327 m_cloud.clouds->drop();
330 /******************************************************************************/
331 void GUIEngine::cloudInit()
333 m_cloud.clouds = new Clouds(m_smgr->getRootSceneNode(),
334 m_smgr, -1, rand(), 100);
335 m_cloud.clouds->update(v2f(0, 0), video::SColor(255,200,200,255));
337 m_cloud.camera = m_smgr->addCameraSceneNode(0,
338 v3f(0,0,0), v3f(0, 60, 100));
339 m_cloud.camera->setFarValue(10000);
341 m_cloud.lasttime = m_device->getTimer()->getTime();
344 /******************************************************************************/
345 void GUIEngine::cloudPreProcess()
347 u32 time = m_device->getTimer()->getTime();
349 if(time > m_cloud.lasttime)
350 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
354 m_cloud.lasttime = time;
356 m_cloud.clouds->step(m_cloud.dtime*3);
357 m_cloud.clouds->render();
361 /******************************************************************************/
362 void GUIEngine::cloudPostProcess()
364 float fps_max = g_settings->getFloat("fps_max");
365 // Time of frame without fps limit
368 // not using getRealTime is necessary for wine
369 u32 time = m_device->getTimer()->getTime();
370 if(time > m_cloud.lasttime)
371 busytime_u32 = time - m_cloud.lasttime;
376 u32 frametime_min = 1000./fps_max;
378 if(busytime_u32 < frametime_min) {
379 u32 sleeptime = frametime_min - busytime_u32;
380 m_device->sleep(sleeptime);
384 /******************************************************************************/
385 void GUIEngine::drawBackground(video::IVideoDriver* driver)
387 v2u32 screensize = driver->getScreenSize();
389 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
391 /* If no texture, draw background of solid color */
393 video::SColor color(255,80,58,37);
394 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
395 driver->draw2DRectangle(color, rect, NULL);
399 v2u32 sourcesize = texture->getOriginalSize();
401 if (m_textures[TEX_LAYER_BACKGROUND].tile)
404 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
405 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
406 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
408 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
410 draw2DImageFilterScaled(driver, texture,
411 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
412 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
419 /* Draw background texture */
420 draw2DImageFilterScaled(driver, texture,
421 core::rect<s32>(0, 0, screensize.X, screensize.Y),
422 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
426 /******************************************************************************/
427 void GUIEngine::drawOverlay(video::IVideoDriver* driver)
429 v2u32 screensize = driver->getScreenSize();
431 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
433 /* If no texture, draw background of solid color */
437 /* Draw background texture */
438 v2u32 sourcesize = texture->getOriginalSize();
439 draw2DImageFilterScaled(driver, texture,
440 core::rect<s32>(0, 0, screensize.X, screensize.Y),
441 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
445 /******************************************************************************/
446 void GUIEngine::drawHeader(video::IVideoDriver* driver)
448 core::dimension2d<u32> screensize = driver->getScreenSize();
450 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
452 /* If no texture, draw nothing */
456 f32 mult = (((f32)screensize.Width / 2.0)) /
457 ((f32)texture->getOriginalSize().Width);
459 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
460 ((f32)texture->getOriginalSize().Height) * mult);
462 // Don't draw the header is there isn't enough room
463 s32 free_space = (((s32)screensize.Height)-320)/2;
465 if (free_space > splashsize.Y) {
466 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
467 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
468 ((free_space/2)-splashsize.Y/2)+10);
470 video::SColor bgcolor(255,50,50,50);
472 draw2DImageFilterScaled(driver, texture, splashrect,
473 core::rect<s32>(core::position2d<s32>(0,0),
474 core::dimension2di(texture->getOriginalSize())),
479 /******************************************************************************/
480 void GUIEngine::drawFooter(video::IVideoDriver* driver)
482 core::dimension2d<u32> screensize = driver->getScreenSize();
484 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
486 /* If no texture, draw nothing */
490 f32 mult = (((f32)screensize.Width)) /
491 ((f32)texture->getOriginalSize().Width);
493 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
494 ((f32)texture->getOriginalSize().Height) * mult);
496 // Don't draw the footer if there isn't enough room
497 s32 free_space = (((s32)screensize.Height)-320)/2;
499 if (free_space > footersize.Y) {
500 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
501 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
502 rect -= v2s32(footersize.X/2, 0);
504 draw2DImageFilterScaled(driver, texture, rect,
505 core::rect<s32>(core::position2d<s32>(0,0),
506 core::dimension2di(texture->getOriginalSize())),
511 /******************************************************************************/
512 bool GUIEngine::setTexture(texture_layer layer, std::string texturepath,
513 bool tile_image, unsigned int minsize)
515 video::IVideoDriver* driver = m_device->getVideoDriver();
516 FATAL_ERROR_IF(driver == 0, "Could not get video driver");
518 if (m_textures[layer].texture != NULL)
520 driver->removeTexture(m_textures[layer].texture);
521 m_textures[layer].texture = NULL;
524 if ((texturepath == "") || !fs::PathExists(texturepath))
529 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
530 m_textures[layer].tile = tile_image;
531 m_textures[layer].minsize = minsize;
533 if (m_textures[layer].texture == NULL)
541 /******************************************************************************/
542 bool GUIEngine::downloadFile(std::string url, std::string target)
545 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
547 if (!target_file.good()) {
551 HTTPFetchRequest fetch_request;
552 HTTPFetchResult fetch_result;
553 fetch_request.url = url;
554 fetch_request.caller = HTTPFETCH_SYNC;
555 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
556 httpfetch_sync(fetch_request, fetch_result);
558 if (!fetch_result.succeeded) {
561 target_file << fetch_result.data;
569 /******************************************************************************/
570 void GUIEngine::setTopleftText(std::string append)
572 std::wstring toset = utf8_to_wide(std::string(PROJECT_NAME_C " ") +
578 toset += utf8_to_wide(append);
581 m_irr_toplefttext->setText(toset.c_str());
583 updateTopLeftTextSize();
586 /******************************************************************************/
587 void GUIEngine::updateTopLeftTextSize()
589 std::wstring text = m_irr_toplefttext->getText();
591 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(text), g_fontengine->getTextHeight());
594 m_irr_toplefttext->remove();
596 m_device->getGUIEnvironment()->addStaticText(text.c_str(),
597 rect,false,true,0,-1);
600 /******************************************************************************/
601 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
603 s32 handle = m_sound_manager->playSound(spec, looped);
607 /******************************************************************************/
608 void GUIEngine::stopSound(s32 handle)
610 m_sound_manager->stopSound(handle);
613 /******************************************************************************/
614 unsigned int GUIEngine::queueAsync(std::string serialized_func,
615 std::string serialized_params)
617 return m_script->queueAsync(serialized_func, serialized_params);