guiEngine.h

Go to the documentation of this file.

// Luanti
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 2013 sapier
 
#pragma once
 
/******************************************************************************/
/* Includes                                                                   */
/******************************************************************************/
#include "irrlichttypes.h"
#include "guiFormSpecMenu.h"
#include "statusTextHelper.h"
#include "client/clouds.h"
#include "client/sound.h"
#include "util/enriched_string.h"
#include "translation.h"
 
#include <csignal>
#include <memory>
 
/******************************************************************************/
/* 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 RenderingEngine;
class MainMenuScripting;
struct MainMenuData;
 
/******************************************************************************/
/* declarations                                                               */
/******************************************************************************/

class TextDestGuiEngine : public TextDest
{
public:
        TextDestGuiEngine(GUIEngine* engine) : m_engine(engine) {};

        void gotText(const StringMap &fields);

        void requestScreenshot();
 
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::vector<video::ITexture*> m_to_delete;
};

class MenuMusicFetcher final : public SoundFallbackPathProvider
{
protected:
        void addThePaths(const std::string &name,
                        std::vector<std::string> &paths) override;
};

class GUIEngine {
        friend class ModApiMainMenu;
        friend class ModApiMainMenuSound;
        friend class MainMenuSoundHandle;
 
public:
        GUIEngine(JoystickController *joystick,
                        gui::IGUIElement *parent,
                        RenderingEngine *rendering_engine,
                        IMenuManager *menumgr,
                        MainMenuData *data,
                        volatile std::sig_atomic_t &kill);

        virtual ~GUIEngine();

        MainMenuScripting *getScriptIface()
        {
                return m_script.get();
        }

        std::string getScriptDir()
        {
                return m_scriptdir;
        }

        void requestScreenshot()
        {
                m_take_screenshot = true;
        }

        Translations *getContentTranslations(const std::string &path,
                        const std::string &domain, const std::string &lang_code);
 
private:
        std::string m_last_translations_key;
        Translations m_last_translations;

        bool loadMainMenuScript();

        void run();

        void updateTopLeftTextSize();
 
        RenderingEngine                      *m_rendering_engine = nullptr;
        gui::IGUIElement                     *m_parent = nullptr;
        IMenuManager                         *m_menumanager = nullptr;
        scene::ISceneManager                 *m_smgr = nullptr;
        MainMenuData                         *m_data = nullptr;
        std::unique_ptr<ISimpleTextureSource> m_texture_source;
        std::unique_ptr<ISoundManager>        m_sound_manager;

        FormspecFormSource                   *m_formspecgui = nullptr;
        TextDestGuiEngine                    *m_buttonhandler = nullptr;
        irr_ptr<GUIFormSpecMenu>              m_menu;

        volatile std::sig_atomic_t           &m_kill;

        bool                                  m_startgame = false;

        bool                                  m_take_screenshot = false;

        std::unique_ptr<MainMenuScripting>    m_script;

        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);

        gui::IGUIStaticText *m_irr_toplefttext = nullptr;
        EnrichedString m_toplefttext;

        std::unique_ptr<StatusTextHelper> m_status_text;

        void drawClouds(float dtime);

        bool m_clouds_enabled = true;
 
        void setMenuCloudsColor(video::SColor color);
        void setMenuSkyColor(video::SColor color);
 
        static void fullscreenChangedCallback(const std::string &name, void *data);
};