Pi.h

Go to the documentation of this file.

// Copyright © 2008-2023 Pioneer Developers. See AUTHORS.txt for details
// Licensed under the terms of the GPL v3. See licenses/GPL-3.txt
 
#ifndef _PI_H
#define _PI_H
 
#include "Random.h"
#include "core/GuiApplication.h"
#include "gameconsts.h"
#include "libs.h"
 
#include "SDL_keyboard.h"
#include <sigc++/sigc++.h>
#include <map>
#include <string>
#include <vector>
 
namespace Input {
    class Manager;
} //namespace Input
 
namespace PiGui {
    class Instance;
} //namespace PiGui
 
class Game;
class GameConfig;
class Intro;
class JobSet;
class LuaConsole;
class LuaNameGen;
class LuaTimer;
class ModelCache;
class ObjectViewerView;
class Player;
class SystemPath;
class TransferPlanner;
class View;
class SDLGraphics;
class LuaSerializer;
 
#if ENABLE_SERVER_AGENT
class ServerAgent;
#endif
 
namespace Graphics {
    class Renderer;
} // namespace Graphics
 
namespace SceneGraph {
    class Model;
}
 
namespace Sound {
    class MusicPlayer;
}
 
class DetailLevel {
public:
    DetailLevel() :
        planets(0),
        cities(0) {}
    int planets;
    int cities;
};
 
class Pi {
public:
    Pi() = delete;
 
    class App final : public GuiApplication {
    public:
        // TODO: headless mode should be part of a different, process-wide inter
        bool HeadlessMode() { return m_noGui; }
 
        void SetStartPath(const SystemPath &startPath);
 
        // Returns a pointer to the async JobSet for the current startup loading step.
        // The current load step will not complete until all ordered jobs have finished.
        // NOTE: this queue runs on a different thread.
        JobSet *GetCurrentLoadStepQueue() const;
 
        // Returns a pointer to the async JobSet for the entire startup loading screen.
        // Loading will not finish until all ordered jobs have finished.
        // NOTE: this queue runs on a different thread.
        JobSet *GetAsyncStartupQueue() const;
 
    protected:
        // for compatibility, while we're moving Pi's internals into App
        friend class Pi;
 
        // Pi-internal lifecycle classes
        friend class MainMenu;
        friend class GameLoop;
        friend class TombstoneLoop;
 
        App() :
            GuiApplication("Pioneer") {}
 
        void Startup() override;
        void Shutdown() override;
 
        void PreUpdate() override;
        void PostUpdate() override;
 
        void RunJobs();
 
        void HandleRequests();
 
    private:
        // msgs/requests that can be posted which the game processes at the end of a game loop in HandleRequests
        enum class InternalRequests {
            END_GAME = 0,
            QUIT_GAME,
            DETAIL_LEVEL_CHANGED // FIXME: right idea, wrong place
        };
 
        std::vector<InternalRequests> internalRequests;
 
        bool m_noGui;
 
        RefCountedPtr<Lifecycle> m_loader;
        RefCountedPtr<Lifecycle> m_mainMenu;
        RefCountedPtr<Lifecycle> m_gameLoop;
    };
 
public:
    static void Init(const std::map<std::string, std::string> &options, bool no_gui = false);
 
    static void StartGame(Game *game);
 
    static void RequestEndGame(); // request that the game is ended as soon as safely possible
    static void RequestQuit();
 
    static void OnChangeDetailLevel();
    static float GetFrameTime() { return frameTime; }
    static float GetGameTickAlpha() { return gameTickAlpha; }
    // for internal use, don't modify unless you know what you're doing
    static void SetGameTickAlpha(float alpha) { gameTickAlpha = alpha; }
 
    static void SetShowDebugInfo(bool enabled) { showDebugInfo = enabled; };
    static void ToggleShowDebugInfo() { showDebugInfo = !showDebugInfo; };
 
    // FIXME: hacked-in singleton pattern, find a better way to locate the application
    static App *GetApp() { return m_instance; }
 
    static bool IsNavTunnelDisplayed() { return navTunnelDisplayed; }
    static void SetNavTunnelDisplayed(bool state) { navTunnelDisplayed = state; }
    static bool AreSpeedLinesDisplayed() { return speedLinesDisplayed; }
    static void SetSpeedLinesDisplayed(bool state) { speedLinesDisplayed = state; }
    static bool AreHudTrailsDisplayed() { return hudTrailsDisplayed; }
    static void SetHudTrailsDisplayed(bool state) { hudTrailsDisplayed = state; }
 
    // Get the default speed modifier to apply to movement (scrolling, zooming...), depending on the "shift" keys.
    // This is a default value only, centralized here to promote uniform user expericience.
    static float GetMoveSpeedShiftModifier();
 
    static std::string GetSaveDir();
    static SceneGraph::Model *FindModel(const std::string &, bool allowPlaceholder = true);
 
    static const char SAVE_DIR_NAME[];
 
    static LuaSerializer *luaSerializer;
    static LuaTimer *luaTimer;
 
    static LuaNameGen *luaNameGen;
 
#if ENABLE_SERVER_AGENT
    static ServerAgent *serverAgent;
#endif
 
    static PiGui::Instance *pigui;
 
    static Random rng;
    static int statSceneTris;
    static int statNumPatches;
 
    static void SetView(View *v);
    static View *GetView() { return currentView; }
 
    static void SetAmountBackgroundStars(const float pc)
    {
        amountOfBackgroundStarsDisplayed = Clamp(pc, 0.0f, 1.0f);
        bRefreshBackgroundStars = true;
    }
    static float GetAmountBackgroundStars() { return amountOfBackgroundStarsDisplayed; }
    static void SetStarFieldStarSizeFactor(const float pc)
    {
        starFieldStarSizeFactor = Clamp(pc, 0.0f, 1.0f);
        bRefreshBackgroundStars = true;
    }
    static float GetStarFieldStarSizeFactor() { return starFieldStarSizeFactor; }
    static bool MustRefreshBackgroundClearFlag()
    {
        const bool bRet = bRefreshBackgroundStars;
        bRefreshBackgroundStars = false;
        return bRet;
    }
 
    /* Only use #if WITH_DEVKEYS */
    static bool showDebugInfo;
 
    static Input::Manager *input;
    static Player *player;
    static TransferPlanner *planner;
    static std::unique_ptr<LuaConsole> luaConsole;
    static Sound::MusicPlayer &GetMusicPlayer() { return musicPlayer; }
    static Graphics::Renderer *renderer;
    static ModelCache *modelCache;
    static Intro *intro;
    static SDLGraphics *sdl;
 
    static Game *game;
 
    static DetailLevel detail;
    static GameConfig *config;
 
    static JobQueue *GetAsyncJobQueue() { return GetApp()->GetAsyncJobQueue(); }
    static JobQueue *GetSyncJobQueue() { return GetApp()->GetSyncJobQueue(); }
 
    static bool DrawGUI;
 
private:
    static void HandleKeyDown(SDL_Keysym *key);
 
    // private members
 
    static bool menuDone;
 
    static View *currentView;
 
    static float gameTickAlpha;
    static float frameTime;
 
    static Sound::MusicPlayer musicPlayer;
 
    static bool navTunnelDisplayed;
    static bool speedLinesDisplayed;
    static bool hudTrailsDisplayed;
    static bool bRefreshBackgroundStars;
    static float amountOfBackgroundStarsDisplayed;
    static float starFieldStarSizeFactor;
 
    static bool doingMouseGrab;
 
    static bool isRecordingVideo;
    static FILE *ffmpegFile;
 
private:
    // for compatibility, while we're moving Pi's internals into App
    friend class App;
 
    static App *m_instance;
};
 
#endif /* _PI_H */