mirror of https://github.com/minetest/minetest.git
300 lines
8.8 KiB
C++
300 lines
8.8 KiB
C++
/*
|
|
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/clouds.h"
|
|
#include "client/sound.h"
|
|
#include "util/enriched_string.h"
|
|
#include "translation.h"
|
|
|
|
/******************************************************************************/
|
|
/* Structs and macros */
|
|
/******************************************************************************/
|
|
/** texture layer ids */
|
|
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;
|
|
class IWritableShaderSource;
|
|
struct MainMenuData;
|
|
|
|
/******************************************************************************/
|
|
/* declarations */
|
|
/******************************************************************************/
|
|
|
|
/** GUIEngine specific implementation of TextDest used within guiFormSpecMenu */
|
|
class TextDestGuiEngine : public TextDest
|
|
{
|
|
public:
|
|
/**
|
|
* default constructor
|
|
* @param engine the engine data is transmitted for further processing
|
|
*/
|
|
TextDestGuiEngine(GUIEngine* engine) : m_engine(engine) {};
|
|
|
|
/**
|
|
* receive fields transmitted by guiFormSpecMenu
|
|
* @param fields map containing formspec field elements currently active
|
|
*/
|
|
void gotText(const StringMap &fields);
|
|
|
|
/**
|
|
* receive text/events transmitted by guiFormSpecMenu
|
|
* @param text textual representation of event
|
|
*/
|
|
void gotText(const std::wstring &text);
|
|
|
|
private:
|
|
/** target to transmit data to */
|
|
GUIEngine *m_engine = nullptr;
|
|
};
|
|
|
|
/** GUIEngine specific implementation of ISimpleTextureSource */
|
|
class MenuTextureSource : public ISimpleTextureSource
|
|
{
|
|
public:
|
|
/**
|
|
* default constructor
|
|
* @param driver the video driver to load textures from
|
|
*/
|
|
MenuTextureSource(video::IVideoDriver *driver) : m_driver(driver) {};
|
|
|
|
/**
|
|
* destructor, removes all loaded textures
|
|
*/
|
|
virtual ~MenuTextureSource();
|
|
|
|
/**
|
|
* get a texture, loading it if required
|
|
* @param name path to the texture
|
|
* @param id receives the texture ID, always 0 in this implementation
|
|
*/
|
|
video::ITexture *getTexture(const std::string &name, u32 *id = NULL);
|
|
|
|
private:
|
|
/** driver to get textures from */
|
|
video::IVideoDriver *m_driver = nullptr;
|
|
/** set of textures to delete */
|
|
std::vector<video::ITexture*> m_to_delete;
|
|
};
|
|
|
|
/** GUIEngine specific implementation of SoundFallbackPathProvider */
|
|
class MenuMusicFetcher final : public SoundFallbackPathProvider
|
|
{
|
|
protected:
|
|
void addThePaths(const std::string &name,
|
|
std::vector<std::string> &paths) override;
|
|
};
|
|
|
|
/** implementation of main menu based uppon formspecs */
|
|
class GUIEngine {
|
|
/** grant ModApiMainMenu access to private members */
|
|
friend class ModApiMainMenu;
|
|
friend class ModApiMainMenuSound;
|
|
friend class MainMenuSoundHandle;
|
|
|
|
public:
|
|
/**
|
|
* default constructor
|
|
* @param dev device to draw at
|
|
* @param parent parent gui element
|
|
* @param menumgr manager to add menus to
|
|
* @param smgr scene manager to add scene elements to
|
|
* @param data struct to transfer data to main game handling
|
|
*/
|
|
GUIEngine(JoystickController *joystick,
|
|
gui::IGUIElement *parent,
|
|
RenderingEngine *rendering_engine,
|
|
IMenuManager *menumgr,
|
|
MainMenuData *data,
|
|
bool &kill);
|
|
|
|
/** default destructor */
|
|
virtual ~GUIEngine();
|
|
|
|
/**
|
|
* return MainMenuScripting interface
|
|
*/
|
|
MainMenuScripting *getScriptIface()
|
|
{
|
|
return m_script.get();
|
|
}
|
|
|
|
/**
|
|
* return dir of current menuscript
|
|
*/
|
|
std::string getScriptDir()
|
|
{
|
|
return m_scriptdir;
|
|
}
|
|
|
|
/**
|
|
* Get translations for content
|
|
*
|
|
* Only loads a single textdomain from the path, as specified by `domain`,
|
|
* for performance reasons.
|
|
*
|
|
* WARNING: Do not store the returned pointer for long as the contents may
|
|
* change with the next call to `getContentTranslations`.
|
|
* */
|
|
Translations *getContentTranslations(const std::string &path,
|
|
const std::string &domain, const std::string &lang_code);
|
|
|
|
private:
|
|
std::string m_last_translations_key;
|
|
/** Only the most recently used translation set is kept loaded */
|
|
Translations m_last_translations;
|
|
|
|
/** find and run the main menu script */
|
|
bool loadMainMenuScript();
|
|
|
|
/** run main menu loop */
|
|
void run();
|
|
|
|
/** update size of topleftext element */
|
|
void updateTopLeftTextSize();
|
|
|
|
RenderingEngine *m_rendering_engine = nullptr;
|
|
/** parent gui element */
|
|
gui::IGUIElement *m_parent = nullptr;
|
|
/** manager to add menus to */
|
|
IMenuManager *m_menumanager = nullptr;
|
|
/** scene manager to add scene elements to */
|
|
scene::ISceneManager *m_smgr = nullptr;
|
|
/** pointer to data beeing transfered back to main game handling */
|
|
MainMenuData *m_data = nullptr;
|
|
/** texture source */
|
|
std::unique_ptr<ISimpleTextureSource> m_texture_source;
|
|
/** shader source */
|
|
std::unique_ptr<IWritableShaderSource> m_shader_source;
|
|
/** sound manager */
|
|
std::unique_ptr<ISoundManager> m_sound_manager;
|
|
|
|
/** representation of form source to be used in mainmenu formspec */
|
|
FormspecFormSource *m_formspecgui = nullptr;
|
|
/** formspec input receiver */
|
|
TextDestGuiEngine *m_buttonhandler = nullptr;
|
|
/** the formspec menu */
|
|
irr_ptr<GUIFormSpecMenu> m_menu;
|
|
|
|
/** reference to kill variable managed by SIGINT handler */
|
|
bool &m_kill;
|
|
|
|
/** variable used to abort menu and return back to main game handling */
|
|
bool m_startgame = false;
|
|
|
|
/** scripting interface */
|
|
std::unique_ptr<MainMenuScripting> m_script;
|
|
|
|
/** script basefolder */
|
|
std::string m_scriptdir = "";
|
|
|
|
void setFormspecPrepend(const std::string &fs);
|
|
|
|
/**
|
|
* draw background layer
|
|
* @param driver to use for drawing
|
|
*/
|
|
void drawBackground(video::IVideoDriver *driver);
|
|
/**
|
|
* draw overlay layer
|
|
* @param driver to use for drawing
|
|
*/
|
|
void drawOverlay(video::IVideoDriver *driver);
|
|
/**
|
|
* draw header layer
|
|
* @param driver to use for drawing
|
|
*/
|
|
void drawHeader(video::IVideoDriver *driver);
|
|
/**
|
|
* draw footer layer
|
|
* @param driver to use for drawing
|
|
*/
|
|
void drawFooter(video::IVideoDriver *driver);
|
|
|
|
/**
|
|
* load a texture for a specified layer
|
|
* @param layer draw layer to specify texture
|
|
* @param texturepath full path of texture to load
|
|
*/
|
|
bool setTexture(texture_layer layer, const std::string &texturepath,
|
|
bool tile_image, unsigned int minsize);
|
|
|
|
/**
|
|
* download a file using curl
|
|
* @param url url to download
|
|
* @param target file to store to
|
|
*/
|
|
static bool downloadFile(const std::string &url, const std::string &target);
|
|
|
|
/** array containing pointers to current specified texture layers */
|
|
image_definition m_textures[TEX_LAYER_MAX];
|
|
|
|
/**
|
|
* specify text to appear as top left string
|
|
* @param text to set
|
|
*/
|
|
void setTopleftText(const std::string &text);
|
|
|
|
/** pointer to gui element shown at topleft corner */
|
|
irr::gui::IGUIStaticText *m_irr_toplefttext = nullptr;
|
|
/** and text that is in it */
|
|
EnrichedString m_toplefttext;
|
|
|
|
/** initialize cloud subsystem */
|
|
void cloudInit();
|
|
/** do preprocessing for cloud subsystem */
|
|
void drawClouds(float dtime);
|
|
|
|
/** internam data required for drawing clouds */
|
|
struct clouddata {
|
|
/** pointer to cloud class */
|
|
irr_ptr<Clouds> clouds;
|
|
/** camera required for drawing clouds */
|
|
scene::ICameraSceneNode *camera = nullptr;
|
|
};
|
|
|
|
/** is drawing of clouds enabled atm */
|
|
bool m_clouds_enabled = true;
|
|
/** data used to draw clouds */
|
|
clouddata m_cloud;
|
|
};
|