ScreenManager.h

#ifndef SCREEN_MANAGER_H
#define SCREEN_MANAGER_H
 
#include "Etterna/Models/Misc/PlayerNumber.h"
#include "RageUtil/Sound/RageSound.h"
#include "Etterna/Screen/Others/ScreenMessage.h"
 
class Actor;
class Screen;
struct Menu;
struct lua_State;
class InputEventPlus;
class ScreenManager
{
  public:
    ScreenManager();
    ~ScreenManager();
 
    // pass these messages along to the current state
    void Update(float fDeltaTime);
    void Draw();
    void Input(const InputEventPlus& input);
 
    // Main screen stack management
    void SetNewScreen(const std::string& sName);
    void AddNewScreenToTop(const std::string& sName,
                           ScreenMessage SendOnPop = SM_None);
    void PrepareScreen(const std::string& sScreenName);
    void GroupScreen(const std::string& sScreenName);
    void PersistantScreen(const std::string& sScreenName);
    void PopTopScreen(ScreenMessage SM);
    void PopAllScreens();
    auto GetTopScreen() -> Screen*;
    auto GetScreen(int iPosition) -> Screen*;
    auto AllowOperatorMenuButton() const -> bool;
 
    auto IsScreenNameValid(std::string const& name) const -> bool;
 
    // System messages
    void SystemMessage(const std::string& sMessage);
    void SystemMessageNoAnimate(const std::string& sMessage);
    void HideSystemMessage();
 
    // Screen messages
    void PostMessageToTopScreen(ScreenMessage SM, float fDelay);
    void SendMessageToTopScreen(ScreenMessage SM);
 
    void RefreshCreditsMessages();
    void ThemeChanged();
    void ReloadOverlayScreens();
    void ReloadOverlayScreensAfterInputFinishes();
 
    auto IsStackedScreen(const Screen* pScreen) const -> bool;
 
    auto get_input_redirected(PlayerNumber pn) -> bool;
    void set_input_redirected(PlayerNumber pn, bool redir);
 
    // Lua
    void PushSelf(lua_State* L);
 
    void PlaySharedBackgroundOffCommand();
    void ZeroNextUpdate();
 
  private:
    // Screen loads, removals, and concurrent prepares are delayed until the
    // next update.
    std::string m_sDelayedScreen;
    std::string m_sDelayedConcurrentPrepare;
    ScreenMessage m_OnDonePreparingScreen;
    ScreenMessage m_PopTopScreen;
 
    // Set this to true anywhere we create of delete objects.  These
    // operations take a long time, and will cause a skip on the next update.
    bool m_bZeroNextUpdate;
 
    // This exists so the debug overlay can reload the overlay screens without
    // seg faulting. It's "AfterInput" because the debug overlay carries out
    // actions in Input.
    bool m_bReloadOverlayScreensAfterInput;
 
    // m_input_redirected exists to allow the theme to prevent input being
    // passed to the normal Screen::Input function, on a per-player basis.
    // Input is still passed to lua callbacks, so it's intended for the case
    // where someone has a custom menu on a screen and needs to disable normal
    // input for navigating the custom menu to work. -Kyz
    std::vector<bool> m_input_redirected;
 
    auto MakeNewScreen(const std::string& sName) -> Screen*;
    void LoadDelayedScreen();
    auto ActivatePreparedScreenAndBackground(const std::string& sScreenName)
      -> bool;
    auto PopTopScreenInternal(bool bSendLoseFocus = true) -> ScreenMessage;
 
    // Keep these sounds always loaded, because they could be
    // played at any time.  We want to eliminate SOUND->PlayOnce
  public:
    void PlayStartSound();
    void PlayCoinSound();
    void PlayCancelSound();
    void PlayInvalidSound();
    void PlayScreenshotSound();
 
  private:
    RageSound m_soundStart;
    RageSound m_soundCoin;
    RageSound m_soundCancel;
    RageSound m_soundInvalid;
    RageSound m_soundScreenshot;
};
 
extern ScreenManager*
  SCREENMAN; // global and accessible from anywhere in our program
 
#endif