src/guiEngine.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 sapier
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef GUI_ENGINE_H_
  21 #define GUI_ENGINE_H_
  22
  23 /******************************************************************************/
  24 /* Includes                                                                   */
  25 /******************************************************************************/
  26 #include "irrlichttypes.h"
  27 #include "modalMenu.h"
  28 #include "guiFormSpecMenu.h"
  29 #include "sound.h"
  30 #include "client/tile.h"
  31 #include "util/enriched_string.h"
  32
  33 /******************************************************************************/
  34 /* Typedefs and macros                                                        */
  35 /******************************************************************************/
  36 /** texture layer ids */
  37 typedef enum {
  38         TEX_LAYER_BACKGROUND = 0,
  39         TEX_LAYER_OVERLAY,
  40         TEX_LAYER_HEADER,
  41         TEX_LAYER_FOOTER,
  42         TEX_LAYER_MAX
  43 } texture_layer;
  44
  45 typedef struct {
  46         video::ITexture *texture = nullptr;
  47         bool             tile;
  48         unsigned int     minsize;
  49 } image_definition;
  50
  51 /******************************************************************************/
  52 /* forward declarations                                                       */
  53 /******************************************************************************/
  54 class GUIEngine;
  55 class MainMenuScripting;
  56 class Clouds;
  57 struct MainMenuData;
  58
  59 /******************************************************************************/
  60 /* declarations                                                               */
  61 /******************************************************************************/
  62
  63 /** GUIEngine specific implementation of TextDest used within guiFormSpecMenu */
  64 class TextDestGuiEngine : public TextDest
  65 {
  66 public:
  67         /**
  68          * default constructor
  69          * @param engine the engine data is transmitted for further processing
  70          */
  71         TextDestGuiEngine(GUIEngine* engine) : m_engine(engine) {};
  72
  73         /**
  74          * receive fields transmitted by guiFormSpecMenu
  75          * @param fields map containing formspec field elements currently active
  76          */
  77         void gotText(const StringMap &fields);
  78
  79         /**
  80          * receive text/events transmitted by guiFormSpecMenu
  81          * @param text textual representation of event
  82          */
  83         void gotText(const std::wstring &text);
  84
  85 private:
  86         /** target to transmit data to */
  87         GUIEngine *m_engine = nullptr;
  88 };
  89
  90 /** GUIEngine specific implementation of ISimpleTextureSource */
  91 class MenuTextureSource : public ISimpleTextureSource
  92 {
  93 public:
  94         /**
  95          * default constructor
  96          * @param driver the video driver to load textures from
  97          */
  98         MenuTextureSource(video::IVideoDriver *driver) : m_driver(driver) {};
  99
 100         /**
 101          * destructor, removes all loaded textures
 102          */
 103         virtual ~MenuTextureSource();
 104
 105         /**
 106          * get a texture, loading it if required
 107          * @param name path to the texture
 108          * @param id receives the texture ID, always 0 in this implementation
 109          */
 110         video::ITexture *getTexture(const std::string &name, u32 *id = NULL);
 111
 112 private:
 113         /** driver to get textures from */
 114         video::IVideoDriver *m_driver = nullptr;
 115         /** set of texture names to delete */
 116         std::set<std::string> m_to_delete;
 117 };
 118
 119 /** GUIEngine specific implementation of OnDemandSoundFetcher */
 120 class MenuMusicFetcher: public OnDemandSoundFetcher
 121 {
 122 public:
 123         /**
 124          * get sound file paths according to sound name
 125          * @param name sound name
 126          * @param dst_paths receives possible paths to sound files
 127          * @param dst_datas receives binary sound data (not used here)
 128          */
 129         void fetchSounds(const std::string &name,
 130                         std::set<std::string> &dst_paths,
 131                         std::set<std::string> &dst_datas);
 132
 133 private:
 134         /** set of fetched sound names */
 135         std::set<std::string> m_fetched;
 136 };
 137
 138 /** implementation of main menu based uppon formspecs */
 139 class GUIEngine {
 140         /** grant ModApiMainMenu access to private members */
 141         friend class ModApiMainMenu;
 142         friend class ModApiSound;
 143
 144 public:
 145         /**
 146          * default constructor
 147          * @param dev device to draw at
 148          * @param parent parent gui element
 149          * @param menumgr manager to add menus to
 150          * @param smgr scene manager to add scene elements to
 151          * @param data struct to transfer data to main game handling
 152          */
 153         GUIEngine(JoystickController *joystick,
 154                         gui::IGUIElement *parent,
 155                         IMenuManager *menumgr,
 156                         MainMenuData *data,
 157                         bool &kill);
 158
 159         /** default destructor */
 160         virtual ~GUIEngine();
 161
 162         /**
 163          * return MainMenuScripting interface
 164          */
 165         MainMenuScripting *getScriptIface()
 166         {
 167                 return m_script;
 168         }
 169
 170         /**
 171          * return dir of current menuscript
 172          */
 173         std::string getScriptDir()
 174         {
 175                 return m_scriptdir;
 176         }
 177
 178         /** pass async callback to scriptengine **/
 179         unsigned int queueAsync(const std::string &serialized_fct,
 180                         const std::string &serialized_params);
 181
 182 private:
 183
 184         /** find and run the main menu script */
 185         bool loadMainMenuScript();
 186
 187         /** run main menu loop */
 188         void run();
 189
 190         /** update size of topleftext element */
 191         void updateTopLeftTextSize();
 192
 193         /** parent gui element */
 194         gui::IGUIElement        *m_parent = nullptr;
 195         /** manager to add menus to */
 196         IMenuManager            *m_menumanager = nullptr;
 197         /** scene manager to add scene elements to */
 198         scene::ISceneManager    *m_smgr = nullptr;
 199         /** pointer to data beeing transfered back to main game handling */
 200         MainMenuData            *m_data = nullptr;
 201         /** pointer to texture source */
 202         ISimpleTextureSource    *m_texture_source = nullptr;
 203         /** pointer to soundmanager*/
 204         ISoundManager           *m_sound_manager = nullptr;
 205
 206         /** representation of form source to be used in mainmenu formspec */
 207         FormspecFormSource      *m_formspecgui = nullptr;
 208         /** formspec input receiver */
 209         TextDestGuiEngine       *m_buttonhandler = nullptr;
 210         /** the formspec menu */
 211         GUIFormSpecMenu         *m_menu = nullptr;
 212
 213         /** reference to kill variable managed by SIGINT handler */
 214         bool                    &m_kill;
 215
 216         /** variable used to abort menu and return back to main game handling */
 217         bool                     m_startgame = false;
 218
 219         /** scripting interface */
 220         MainMenuScripting       *m_script = nullptr;
 221
 222         /** script basefolder */
 223         std::string              m_scriptdir = "";
 224
 225         /**
 226          * draw background layer
 227          * @param driver to use for drawing
 228          */
 229         void drawBackground(video::IVideoDriver *driver);
 230         /**
 231          * draw overlay layer
 232          * @param driver to use for drawing
 233          */
 234         void drawOverlay(video::IVideoDriver *driver);
 235         /**
 236          * draw header layer
 237          * @param driver to use for drawing
 238          */
 239         void drawHeader(video::IVideoDriver *driver);
 240         /**
 241          * draw footer layer
 242          * @param driver to use for drawing
 243          */
 244         void drawFooter(video::IVideoDriver *driver);
 245
 246         /**
 247          * load a texture for a specified layer
 248          * @param layer draw layer to specify texture
 249          * @param texturepath full path of texture to load
 250          */
 251         bool setTexture(texture_layer layer, std::string texturepath,
 252                         bool tile_image, unsigned int minsize);
 253
 254         /**
 255          * download a file using curl
 256          * @param url url to download
 257          * @param target file to store to
 258          */
 259         static bool downloadFile(const std::string &url, const std::string &target);
 260
 261         /** array containing pointers to current specified texture layers */
 262         image_definition m_textures[TEX_LAYER_MAX];
 263
 264         /**
 265          * specify text to appear as top left string
 266          * @param text to set
 267          */
 268         void setTopleftText(const std::string &text);
 269
 270         /** pointer to gui element shown at topleft corner */
 271         irr::gui::IGUIStaticText *m_irr_toplefttext = nullptr;
 272         /** and text that is in it */
 273         EnrichedString m_toplefttext;
 274
 275         /** initialize cloud subsystem */
 276         void cloudInit();
 277         /** do preprocessing for cloud subsystem */
 278         void cloudPreProcess();
 279         /** do postprocessing for cloud subsystem */
 280         void cloudPostProcess();
 281
 282         /** internam data required for drawing clouds */
 283         struct clouddata {
 284                 /** delta time since last cloud processing */
 285                 f32     dtime;
 286                 /** absolute time of last cloud processing */
 287                 u32     lasttime;
 288                 /** pointer to cloud class */
 289                 Clouds *clouds = nullptr;
 290                 /** camera required for drawing clouds */
 291                 scene::ICameraSceneNode *camera = nullptr;
 292         };
 293
 294         /** is drawing of clouds enabled atm */
 295         bool        m_clouds_enabled = true;
 296         /** data used to draw clouds */
 297         clouddata   m_cloud;
 298
 299         /** start playing a sound and return handle */
 300         s32 playSound(SimpleSoundSpec spec, bool looped);
 301         /** stop playing a sound started with playSound() */
 302         void stopSound(s32 handle);
 303
 304
 305 };
 306
 307 #endif /* GUI_ENGINE_H_ */