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,
171 m_menu->allowClose(false);
172 m_menu->lockSize(true,v2u32(800,600));
174 // Initialize scripting
176 infostream << "GUIEngine: Initializing Lua" << std::endl;
178 m_script = new MainMenuScripting(this);
181 m_script->setMainMenuData(&m_data->script_data);
182 m_data->script_data.errormessage = "";
184 if (!loadMainMenuScript()) {
185 errorstream << "No future without main menu!" << std::endl;
190 } catch (LuaError &e) {
191 errorstream << "Main menu error: " << e.what() << std::endl;
192 m_data->script_data.errormessage = e.what();
200 /******************************************************************************/
201 bool GUIEngine::loadMainMenuScript()
203 // Set main menu path (for core.get_mainmenu_path())
204 m_scriptdir = g_settings->get("main_menu_path");
205 if (m_scriptdir.empty()) {
206 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
209 // Load builtin (which will load the main menu script)
210 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
212 m_script->loadScript(script);
213 // Menu script loaded
215 } catch (const ModError &e) {
216 errorstream << "GUIEngine: execution of menu script failed: "
217 << e.what() << std::endl;
223 /******************************************************************************/
224 void GUIEngine::run()
226 // Always create clouds because they may or may not be
227 // needed based on the game selected
228 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
232 unsigned int text_height = g_fontengine->getTextHeight();
234 irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screen_w"),
235 g_settings->getU16("screen_h"));
237 while (RenderingEngine::run() && (!m_startgame) && (!m_kill)) {
239 const irr::core::dimension2d<u32> ¤t_screen_size =
240 RenderingEngine::get_video_driver()->getScreenSize();
241 // Verify if window size has changed and save it if it's the case
242 // Ensure evaluating settings->getBool after verifying screensize
243 // First condition is cheaper
244 if (previous_screen_size != current_screen_size &&
245 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
246 g_settings->getBool("autosave_screensize")) {
247 g_settings->setU16("screen_w", current_screen_size.Width);
248 g_settings->setU16("screen_h", current_screen_size.Height);
249 previous_screen_size = current_screen_size;
252 //check if we need to update the "upper left corner"-text
253 if (text_height != g_fontengine->getTextHeight()) {
254 updateTopLeftTextSize();
255 text_height = g_fontengine->getTextHeight();
258 driver->beginScene(true, true, video::SColor(255,140,186,250));
260 if (m_clouds_enabled)
266 drawBackground(driver);
271 RenderingEngine::get_gui_env()->drawAll();
275 if (m_clouds_enabled)
283 m_menu->getAndroidUIInput();
288 /******************************************************************************/
289 GUIEngine::~GUIEngine()
291 if (m_sound_manager != &dummySoundManager){
292 delete m_sound_manager;
293 m_sound_manager = NULL;
296 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
299 m_irr_toplefttext->setText(L"");
301 //clean up texture pointers
302 for (image_definition &texture : m_textures) {
304 RenderingEngine::get_video_driver()->removeTexture(texture.texture);
307 delete m_texture_source;
310 m_cloud.clouds->drop();
313 /******************************************************************************/
314 void GUIEngine::cloudInit()
316 m_cloud.clouds = new Clouds(m_smgr, -1, rand());
317 m_cloud.clouds->setHeight(100.0f);
318 m_cloud.clouds->update(v3f(0, 0, 0), video::SColor(255,200,200,255));
320 m_cloud.camera = m_smgr->addCameraSceneNode(0,
321 v3f(0,0,0), v3f(0, 60, 100));
322 m_cloud.camera->setFarValue(10000);
324 m_cloud.lasttime = RenderingEngine::get_timer_time();
327 /******************************************************************************/
328 void GUIEngine::cloudPreProcess()
330 u32 time = RenderingEngine::get_timer_time();
332 if(time > m_cloud.lasttime)
333 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
337 m_cloud.lasttime = time;
339 m_cloud.clouds->step(m_cloud.dtime*3);
340 m_cloud.clouds->render();
344 /******************************************************************************/
345 void GUIEngine::cloudPostProcess()
347 float fps_max = g_settings->getFloat("pause_fps_max");
348 // Time of frame without fps limit
351 // not using getRealTime is necessary for wine
352 u32 time = RenderingEngine::get_timer_time();
353 if(time > m_cloud.lasttime)
354 busytime_u32 = time - m_cloud.lasttime;
359 u32 frametime_min = 1000./fps_max;
361 if (busytime_u32 < frametime_min) {
362 u32 sleeptime = frametime_min - busytime_u32;
363 RenderingEngine::get_raw_device()->sleep(sleeptime);
367 /******************************************************************************/
368 void GUIEngine::drawBackground(video::IVideoDriver *driver)
370 v2u32 screensize = driver->getScreenSize();
372 video::ITexture* texture = m_textures[TEX_LAYER_BACKGROUND].texture;
374 /* If no texture, draw background of solid color */
376 video::SColor color(255,80,58,37);
377 core::rect<s32> rect(0, 0, screensize.X, screensize.Y);
378 driver->draw2DRectangle(color, rect, NULL);
382 v2u32 sourcesize = texture->getOriginalSize();
384 if (m_textures[TEX_LAYER_BACKGROUND].tile)
387 MYMAX(sourcesize.X,m_textures[TEX_LAYER_BACKGROUND].minsize),
388 MYMAX(sourcesize.Y,m_textures[TEX_LAYER_BACKGROUND].minsize));
389 for (unsigned int x = 0; x < screensize.X; x += tilesize.X )
391 for (unsigned int y = 0; y < screensize.Y; y += tilesize.Y )
393 draw2DImageFilterScaled(driver, texture,
394 core::rect<s32>(x, y, x+tilesize.X, y+tilesize.Y),
395 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
402 /* Draw background texture */
403 draw2DImageFilterScaled(driver, texture,
404 core::rect<s32>(0, 0, screensize.X, screensize.Y),
405 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
409 /******************************************************************************/
410 void GUIEngine::drawOverlay(video::IVideoDriver *driver)
412 v2u32 screensize = driver->getScreenSize();
414 video::ITexture* texture = m_textures[TEX_LAYER_OVERLAY].texture;
416 /* If no texture, draw nothing */
420 /* Draw background texture */
421 v2u32 sourcesize = texture->getOriginalSize();
422 draw2DImageFilterScaled(driver, texture,
423 core::rect<s32>(0, 0, screensize.X, screensize.Y),
424 core::rect<s32>(0, 0, sourcesize.X, sourcesize.Y),
428 /******************************************************************************/
429 void GUIEngine::drawHeader(video::IVideoDriver *driver)
431 core::dimension2d<u32> screensize = driver->getScreenSize();
433 video::ITexture* texture = m_textures[TEX_LAYER_HEADER].texture;
435 /* If no texture, draw nothing */
439 f32 mult = (((f32)screensize.Width / 2.0)) /
440 ((f32)texture->getOriginalSize().Width);
442 v2s32 splashsize(((f32)texture->getOriginalSize().Width) * mult,
443 ((f32)texture->getOriginalSize().Height) * mult);
445 // Don't draw the header if there isn't enough room
446 s32 free_space = (((s32)screensize.Height)-320)/2;
448 if (free_space > splashsize.Y) {
449 core::rect<s32> splashrect(0, 0, splashsize.X, splashsize.Y);
450 splashrect += v2s32((screensize.Width/2)-(splashsize.X/2),
451 ((free_space/2)-splashsize.Y/2)+10);
453 video::SColor bgcolor(255,50,50,50);
455 draw2DImageFilterScaled(driver, texture, splashrect,
456 core::rect<s32>(core::position2d<s32>(0,0),
457 core::dimension2di(texture->getOriginalSize())),
462 /******************************************************************************/
463 void GUIEngine::drawFooter(video::IVideoDriver *driver)
465 core::dimension2d<u32> screensize = driver->getScreenSize();
467 video::ITexture* texture = m_textures[TEX_LAYER_FOOTER].texture;
469 /* If no texture, draw nothing */
473 f32 mult = (((f32)screensize.Width)) /
474 ((f32)texture->getOriginalSize().Width);
476 v2s32 footersize(((f32)texture->getOriginalSize().Width) * mult,
477 ((f32)texture->getOriginalSize().Height) * mult);
479 // Don't draw the footer if there isn't enough room
480 s32 free_space = (((s32)screensize.Height)-320)/2;
482 if (free_space > footersize.Y) {
483 core::rect<s32> rect(0,0,footersize.X,footersize.Y);
484 rect += v2s32(screensize.Width/2,screensize.Height-footersize.Y);
485 rect -= v2s32(footersize.X/2, 0);
487 draw2DImageFilterScaled(driver, texture, rect,
488 core::rect<s32>(core::position2d<s32>(0,0),
489 core::dimension2di(texture->getOriginalSize())),
494 /******************************************************************************/
495 bool GUIEngine::setTexture(texture_layer layer, std::string texturepath,
496 bool tile_image, unsigned int minsize)
498 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
500 if (m_textures[layer].texture) {
501 driver->removeTexture(m_textures[layer].texture);
502 m_textures[layer].texture = NULL;
505 if (texturepath.empty() || !fs::PathExists(texturepath)) {
509 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
510 m_textures[layer].tile = tile_image;
511 m_textures[layer].minsize = minsize;
513 if (!m_textures[layer].texture) {
520 /******************************************************************************/
521 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
524 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
526 if (!target_file.good()) {
530 HTTPFetchRequest fetch_request;
531 HTTPFetchResult fetch_result;
532 fetch_request.url = url;
533 fetch_request.caller = HTTPFETCH_SYNC;
534 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
535 httpfetch_sync(fetch_request, fetch_result);
537 if (!fetch_result.succeeded) {
540 target_file << fetch_result.data;
548 /******************************************************************************/
549 void GUIEngine::setTopleftText(const std::string &text)
551 m_toplefttext = translate_string(utf8_to_wide(text));
553 updateTopLeftTextSize();
556 /******************************************************************************/
557 void GUIEngine::updateTopLeftTextSize()
559 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
560 g_fontengine->getTextHeight());
563 m_irr_toplefttext->remove();
564 m_irr_toplefttext = gui::StaticText::add(RenderingEngine::get_gui_env(),
565 m_toplefttext, rect, false, true, 0, -1);
568 /******************************************************************************/
569 s32 GUIEngine::playSound(SimpleSoundSpec spec, bool looped)
571 s32 handle = m_sound_manager->playSound(spec, looped);
575 /******************************************************************************/
576 void GUIEngine::stopSound(s32 handle)
578 m_sound_manager->stopSound(handle);
581 /******************************************************************************/
582 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
583 const std::string &serialized_params)
585 return m_script->queueAsync(serialized_func, serialized_params);