guiEngine.h

Go to the documentation of this file.

/*
Minetest
Copyright (C) 2013 sapier
 
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation; either version 2.1 of the License, or
(at your option) any later version.
 
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Lesser General Public License for more details.
 
You should have received a copy of the GNU Lesser General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
 
#pragma once
 
/******************************************************************************/
/* Includes                                                                   */
/******************************************************************************/
#include "irrlichttypes.h"
#include "guiFormSpecMenu.h"
#include "client/sound.h"
#include "client/tile.h"
#include "util/enriched_string.h"
 
/******************************************************************************/
/* Structs and macros                                                         */
/******************************************************************************/
enum texture_layer {
    TEX_LAYER_BACKGROUND = 0,
    TEX_LAYER_OVERLAY,
    TEX_LAYER_HEADER,
    TEX_LAYER_FOOTER,
    TEX_LAYER_MAX
};
 
struct image_definition {
    video::ITexture *texture = nullptr;
    bool             tile;
    unsigned int     minsize;
};
 
/******************************************************************************/
/* forward declarations                                                       */
/******************************************************************************/
class GUIEngine;
class MainMenuScripting;
class Clouds;
struct MainMenuData;
 
/******************************************************************************/
/* declarations                                                               */
/******************************************************************************/
 
class TextDestGuiEngine : public TextDest
{
public:
    TextDestGuiEngine(GUIEngine* engine) : m_engine(engine) {};
 
    void gotText(const StringMap &fields);
 
    void gotText(const std::wstring &text);
 
private:
    GUIEngine *m_engine = nullptr;
};
 
class MenuTextureSource : public ISimpleTextureSource
{
public:
    MenuTextureSource(video::IVideoDriver *driver) : m_driver(driver) {};
 
    virtual ~MenuTextureSource();
 
    video::ITexture *getTexture(const std::string &name, u32 *id = NULL);
 
private:
    video::IVideoDriver *m_driver = nullptr;
    std::set<std::string> m_to_delete;
};
 
class MenuMusicFetcher: public OnDemandSoundFetcher
{
public:
    void fetchSounds(const std::string &name,
            std::set<std::string> &dst_paths,
            std::set<std::string> &dst_datas);
 
private:
    std::set<std::string> m_fetched;
};
 
class GUIEngine {
    friend class ModApiMainMenu;
    friend class ModApiSound;
 
public:
    GUIEngine(JoystickController *joystick,
            gui::IGUIElement *parent,
            IMenuManager *menumgr,
            MainMenuData *data,
            bool &kill);
 
    virtual ~GUIEngine();
 
    MainMenuScripting *getScriptIface()
    {
        return m_script;
    }
 
    std::string getScriptDir()
    {
        return m_scriptdir;
    }
 
    unsigned int queueAsync(const std::string &serialized_fct,
            const std::string &serialized_params);
 
private:
 
    bool loadMainMenuScript();
 
    void run();
 
    void updateTopLeftTextSize();
 
    gui::IGUIElement        *m_parent = nullptr;
    IMenuManager            *m_menumanager = nullptr;
    scene::ISceneManager    *m_smgr = nullptr;
    MainMenuData            *m_data = nullptr;
    ISimpleTextureSource    *m_texture_source = nullptr;
    ISoundManager           *m_sound_manager = nullptr;
 
    FormspecFormSource      *m_formspecgui = nullptr;
    TextDestGuiEngine       *m_buttonhandler = nullptr;
    GUIFormSpecMenu         *m_menu = nullptr;
 
    bool                    &m_kill;
 
    bool                     m_startgame = false;
 
    MainMenuScripting       *m_script = nullptr;
 
    std::string              m_scriptdir = "";
 
    void setFormspecPrepend(const std::string &fs);
 
    void drawBackground(video::IVideoDriver *driver);
    void drawOverlay(video::IVideoDriver *driver);
    void drawHeader(video::IVideoDriver *driver);
    void drawFooter(video::IVideoDriver *driver);
 
    bool setTexture(texture_layer layer, const std::string &texturepath,
            bool tile_image, unsigned int minsize);
 
    static bool downloadFile(const std::string &url, const std::string &target);
 
    image_definition m_textures[TEX_LAYER_MAX];
 
    void setTopleftText(const std::string &text);
 
    irr::gui::IGUIStaticText *m_irr_toplefttext = nullptr;
    EnrichedString m_toplefttext;
 
    void cloudInit();
    void cloudPreProcess();
    void cloudPostProcess(u32 frametime_min, IrrlichtDevice *device);
 
    struct clouddata {
        f32     dtime;
        u32     lasttime;
        Clouds *clouds = nullptr;
        scene::ICameraSceneNode *camera = nullptr;
    };
 
    bool        m_clouds_enabled = true;
    clouddata   m_cloud;
 
    s32 playSound(const SimpleSoundSpec &spec, bool looped);
    void stopSound(s32 handle);
 
 
};