ScreenFlow.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2026 Valentin Eloy
// SPDX-License-Identifier: GPL-3.0-or-later
 
#pragma once
 
#include <optional>

 
namespace hmi {

enum class ScreenId {
    Menu,
    Editor,
    Game,
    Options,
    Pause,
    Credits,
    RpgScreen,
};

enum class ScreenEvent {
    OpenMenu,
    OpenEditor,
    OpenGame,
    OpenOptions,
    CloseOptions,
    OpenPause,
    ResumePause,
    QuitPauseToMenu,
    OpenCredits,
    CloseCredits,
    OpenRpgScreen,
    CloseRpgScreen,
};

struct ScreenDressing {
    bool docksVisible = false;
    bool menuBarVisible = false;
    bool toolBarVisible = false;
    bool pixelToolBarVisible = false;
    bool editingCommandsEnabled = false;
    bool gamepadNavigationActive = false;
    bool overlayVisible = false;
 
    friend bool operator==(const ScreenDressing&, const ScreenDressing&) = default;
};

[[nodiscard]] ScreenDressing dressingFor(ScreenId screen) noexcept;

struct ScreenState {
    ScreenId screen = ScreenId::Menu;
    ScreenId optionsReturnTo = ScreenId::Menu;
    ScreenId rpgReturnTo = ScreenId::Menu;
 
    friend bool operator==(const ScreenState&, const ScreenState&) = default;
};

[[nodiscard]] std::optional<ScreenState> resolveTransition(const ScreenState& current,
                                                           ScreenEvent event) noexcept;
 
}  // namespace hmi