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"
35 #include "client/clouds.h"
36 #include "httpfetch.h"
38 #include "client/fontengine.h"
39 #include "client/guiscalingfilter.h"
40 #include "irrlicht_changes/static_text.h"
43 #include "client/tile.h"
47 /******************************************************************************/
48 void TextDestGuiEngine::gotText(const StringMap &fields)
50 m_engine->getScriptIface()->handleMainMenuButtons(fields);
53 /******************************************************************************/
54 void TextDestGuiEngine::gotText(const std::wstring &text)
56 m_engine->getScriptIface()->handleMainMenuEvent(wide_to_utf8(text));
59 /******************************************************************************/
60 MenuTextureSource::~MenuTextureSource()
62 for (const std::string &texture_to_delete : m_to_delete) {
63 const char *tname = texture_to_delete.c_str();
64 video::ITexture *texture = m_driver->getTexture(tname);
65 m_driver->removeTexture(texture);
69 /******************************************************************************/
70 video::ITexture *MenuTextureSource::getTexture(const std::string &name, u32 *id)
78 m_to_delete.insert(name);
81 video::ITexture *retval = m_driver->findTexture(name.c_str());
85 video::IImage *image = m_driver->createImageFromFile(name.c_str());
89 image = Align2Npot2(image, m_driver);
90 retval = m_driver->addTexture(name.c_str(), image);
94 return m_driver->getTexture(name.c_str());
98 /******************************************************************************/
99 /** MenuMusicFetcher */
100 /******************************************************************************/
101 void MenuMusicFetcher::fetchSounds(const std::string &name,
102 std::set<std::string> &dst_paths,
103 std::set<std::string> &dst_datas)
105 if(m_fetched.count(name))
107 m_fetched.insert(name);
109 base = porting::path_share + DIR_DELIM + "sounds";
110 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
113 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
114 base = porting::path_user + DIR_DELIM + "sounds";
115 dst_paths.insert(base + DIR_DELIM + name + ".ogg");
117 dst_paths.insert(base + DIR_DELIM + name + "."+itos(i)+".ogg");
120 /******************************************************************************/
122 /******************************************************************************/
123 GUIEngine::GUIEngine(JoystickController *joystick,
124 gui::IGUIElement *parent,
125 IMenuManager *menumgr,
129 m_menumanager(menumgr),
130 m_smgr(RenderingEngine::get_scene_manager()),
134 //initialize texture pointers
135 for (image_definition &texture : m_textures) {
136 texture.texture = NULL;
138 // is deleted by guiformspec!
139 m_buttonhandler = new TextDestGuiEngine(this);
141 //create texture source
142 m_texture_source = new MenuTextureSource(RenderingEngine::get_video_driver());
144 //create soundmanager
145 MenuMusicFetcher soundfetcher;
147 if (g_settings->getBool("enable_sound"))
148 m_sound_manager = createOpenALSoundManager(g_sound_manager_singleton.get(), &soundfetcher);
151 m_sound_manager = &dummySoundManager;
153 //create topleft header
156 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
157 g_fontengine->getTextHeight());
160 m_irr_toplefttext = gui::StaticText::add(RenderingEngine::get_gui_env(),
161 m_toplefttext, rect, false, true, 0, -1);
163 //create formspecsource
164 m_formspecgui = new FormspecFormSource("");
167 m_menu = new GUIFormSpecMenu(joystick,
178 m_menu->allowClose(false);
179 m_menu->lockSize(true,v2u32(800,600));
181 // Initialize scripting
183 infostream << "GUIEngine: Initializing Lua" << std::endl;
185 m_script = new MainMenuScripting(this);
188 m_script->setMainMenuData(&m_data->script_data);
189 m_data->script_data.errormessage = "";
191 if (!loadMainMenuScript()) {
192 errorstream << "No future without main menu!" << std::endl;
197 } catch (LuaError &e) {
198 errorstream << "Main menu error: " << e.what() << std::endl;
199 m_data->script_data.errormessage = e.what();
207 /******************************************************************************/
208 bool GUIEngine::loadMainMenuScript()
210 // Set main menu path (for core.get_mainmenu_path())
211 m_scriptdir = g_settings->get("main_menu_path");
212 if (m_scriptdir.empty()) {
213 m_scriptdir = porting::path_share + DIR_DELIM + "builtin" + DIR_DELIM + "mainmenu";
216 // Load builtin (which will load the main menu script)
217 std::string script = porting::path_share + DIR_DELIM "builtin" + DIR_DELIM "init.lua";
219 m_script->loadScript(script);
220 // Menu script loaded
222 } catch (const ModError &e) {
223 errorstream << "GUIEngine: execution of menu script failed: "
224 << e.what() << std::endl;
230 /******************************************************************************/
231 void GUIEngine::run()
233 // Always create clouds because they may or may not be
234 // needed based on the game selected
235 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
239 unsigned int text_height = g_fontengine->getTextHeight();
241 irr::core::dimension2d<u32> previous_screen_size(g_settings->getU16("screen_w"),
242 g_settings->getU16("screen_h"));
244 static const video::SColor sky_color(255, 140, 186, 250);
248 video::SColor fog_color;
249 video::E_FOG_TYPE fog_type = video::EFT_FOG_LINEAR;
253 bool fog_pixelfog = false;
254 bool fog_rangefog = false;
255 driver->getFog(fog_color, fog_type, fog_start, fog_end, fog_density,
256 fog_pixelfog, fog_rangefog);
258 driver->setFog(sky_color, fog_type, fog_start, fog_end, fog_density,
259 fog_pixelfog, fog_rangefog);
262 while (RenderingEngine::run() && (!m_startgame) && (!m_kill)) {
264 const irr::core::dimension2d<u32> ¤t_screen_size =
265 RenderingEngine::get_video_driver()->getScreenSize();
266 // Verify if window size has changed and save it if it's the case
267 // Ensure evaluating settings->getBool after verifying screensize
268 // First condition is cheaper
269 if (previous_screen_size != current_screen_size &&
270 current_screen_size != irr::core::dimension2d<u32>(0,0) &&
271 g_settings->getBool("autosave_screensize")) {
272 g_settings->setU16("screen_w", current_screen_size.Width);
273 g_settings->setU16("screen_h", current_screen_size.Height);
274 previous_screen_size = current_screen_size;
277 //check if we need to update the "upper left corner"-text
278 if (text_height != g_fontengine->getTextHeight()) {
279 updateTopLeftTextSize();
280 text_height = g_fontengine->getTextHeight();
283 driver->beginScene(true, true, sky_color);
285 if (m_clouds_enabled)
291 drawBackground(driver);
296 RenderingEngine::get_gui_env()->drawAll();
300 if (m_clouds_enabled)
308 m_menu->getAndroidUIInput();
313 /******************************************************************************/
314 GUIEngine::~GUIEngine()
316 if (m_sound_manager != &dummySoundManager){
317 delete m_sound_manager;
318 m_sound_manager = NULL;
321 infostream<<"GUIEngine: Deinitializing scripting"<<std::endl;
324 m_irr_toplefttext->setText(L"");
326 //clean up texture pointers
327 for (image_definition &texture : m_textures) {
329 RenderingEngine::get_video_driver()->removeTexture(texture.texture);
332 delete m_texture_source;
335 m_cloud.clouds->drop();
338 /******************************************************************************/
339 void GUIEngine::cloudInit()
341 m_cloud.clouds = new Clouds(m_smgr, -1, rand());
342 m_cloud.clouds->setHeight(100.0f);
343 m_cloud.clouds->update(v3f(0, 0, 0), video::SColor(255,240,240,255));
345 m_cloud.camera = m_smgr->addCameraSceneNode(0,
346 v3f(0,0,0), v3f(0, 60, 100));
347 m_cloud.camera->setFarValue(10000);
349 m_cloud.lasttime = RenderingEngine::get_timer_time();
352 /******************************************************************************/
353 void GUIEngine::cloudPreProcess()
355 u32 time = RenderingEngine::get_timer_time();
357 if(time > m_cloud.lasttime)
358 m_cloud.dtime = (time - m_cloud.lasttime) / 1000.0;
362 m_cloud.lasttime = time;
364 m_cloud.clouds->step(m_cloud.dtime*3);
365 m_cloud.clouds->render();
369 /******************************************************************************/
370 void GUIEngine::cloudPostProcess()
372 float fps_max = g_settings->getFloat("pause_fps_max");
373 // Time of frame without fps limit
376 // not using getRealTime is necessary for wine
377 u32 time = RenderingEngine::get_timer_time();
378 if(time > m_cloud.lasttime)
379 busytime_u32 = time - m_cloud.lasttime;
384 u32 frametime_min = 1000./fps_max;
386 if (busytime_u32 < frametime_min) {
387 u32 sleeptime = frametime_min - busytime_u32;
388 RenderingEngine::get_raw_device()->sleep(sleeptime);
392 /******************************************************************************/
393 void GUIEngine::setFormspecPrepend(const std::string &fs)
396 m_menu->setFormspecPrepend(fs);
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, const std::string &texturepath,
530 bool tile_image, unsigned int minsize)
532 video::IVideoDriver *driver = RenderingEngine::get_video_driver();
534 if (m_textures[layer].texture) {
535 driver->removeTexture(m_textures[layer].texture);
536 m_textures[layer].texture = NULL;
539 if (texturepath.empty() || !fs::PathExists(texturepath)) {
543 m_textures[layer].texture = driver->getTexture(texturepath.c_str());
544 m_textures[layer].tile = tile_image;
545 m_textures[layer].minsize = minsize;
547 if (!m_textures[layer].texture) {
554 /******************************************************************************/
555 bool GUIEngine::downloadFile(const std::string &url, const std::string &target)
558 std::ofstream target_file(target.c_str(), std::ios::out | std::ios::binary);
559 if (!target_file.good()) {
563 HTTPFetchRequest fetch_request;
564 HTTPFetchResult fetch_result;
565 fetch_request.url = url;
566 fetch_request.caller = HTTPFETCH_SYNC;
567 fetch_request.timeout = g_settings->getS32("curl_file_download_timeout");
568 httpfetch_sync(fetch_request, fetch_result);
570 if (!fetch_result.succeeded) {
572 fs::DeleteSingleFileOrEmptyDirectory(target);
575 target_file << fetch_result.data;
583 /******************************************************************************/
584 void GUIEngine::setTopleftText(const std::string &text)
586 m_toplefttext = translate_string(utf8_to_wide(text));
588 updateTopLeftTextSize();
591 /******************************************************************************/
592 void GUIEngine::updateTopLeftTextSize()
594 core::rect<s32> rect(0, 0, g_fontengine->getTextWidth(m_toplefttext.c_str()),
595 g_fontengine->getTextHeight());
598 m_irr_toplefttext->remove();
599 m_irr_toplefttext = gui::StaticText::add(RenderingEngine::get_gui_env(),
600 m_toplefttext, rect, false, true, 0, -1);
603 /******************************************************************************/
604 s32 GUIEngine::playSound(const SimpleSoundSpec &spec, bool looped)
606 s32 handle = m_sound_manager->playSound(spec, looped);
610 /******************************************************************************/
611 void GUIEngine::stopSound(s32 handle)
613 m_sound_manager->stopSound(handle);
616 /******************************************************************************/
617 unsigned int GUIEngine::queueAsync(const std::string &serialized_func,
618 const std::string &serialized_params)
620 return m_script->queueAsync(serialized_func, serialized_params);