1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
|
/* UI.h
Copyright (c) 2014 by Michael Zahniser
Endless Sky is free software: you can redistribute it and/or modify it under the
terms of the GNU General Public License as published by the Free Software
Foundation, either version 3 of the License, or (at your option) any later version.
Endless Sky 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 General Public License for more details.
You should have received a copy of the GNU General Public License along with
this program. If not, see <https://www.gnu.org/licenses/>.
*/
#pragma once
#include "Point.h"
#include <memory>
#include <vector>
#include <SDL2/SDL_events.h>
class Panel;
// Class representing a UI (i.e. a series of Panels stacked on top of each other,
// with Panels added or removed in response to user events). This handles events
// and passing them on to whatever panel is on top, and drawing of the panels
// starting with whichever one is on the bottom.
class UI {
public:
enum class UISound
{
NONE,
SOFT,
NORMAL,
SOFT_BUZZ,
TARGET,
FAILURE
};
public:
// Handle an event. The event is handed to each panel on the stack until one
// of them handles it. If none do, this returns false.
bool Handle(const SDL_Event &event);
// Step all the panels forward (advance animations, move objects, etc.).
void StepAll();
// Draw all the panels.
void DrawAll();
// Get the current panel stack.
const std::vector<std::shared_ptr<Panel>> &Stack() const;
// Add the given panel to the stack. If you do not want a panel to be
// deleted when it is popped, save a copy of its shared pointer elsewhere.
void Push(Panel *panel);
void Push(const std::shared_ptr<Panel> &panel);
// Remove the given panel from the stack (if it is in it). The panel will be
// deleted at the start of the next time Step() is called, so it is safe for
// a panel to Pop() itself.
void Pop(const Panel *panel);
// Remove the given panel and every panel that is higher in the stack.
void PopThrough(const Panel *panel);
// Check whether the given panel is on top, i.e. is the active one, out of
// all panels that are already drawn on this step.
bool IsTop(const Panel *panel) const;
// Get the top panel, out of all possible panels, including ones not yet drawn.
std::shared_ptr<Panel> Top() const;
// Delete all the panels and clear the "done" flag.
void Reset();
// Get the lower-most panel.
std::shared_ptr<Panel> Root() const;
// If the player enters the game, enable saving the loaded file.
void CanSave(bool canSave);
bool CanSave() const;
// Tell the UI to quit.
void Quit();
// Check if it is time to quit.
bool IsDone() const;
// Check if there are no panels left.
bool IsEmpty() const;
void AdjustViewport() const;
// Get the current mouse position.
static Point GetMouse();
static void PlaySound(UISound sound);
private:
// If a push or pop is queued, apply it.
void PushOrPop();
private:
// Whether the player has taken actions that enable us to save the game.
bool canSave = false;
// Whether the player has requested the game to shut down.
bool isDone = false;
std::vector<std::shared_ptr<Panel>> stack;
std::vector<std::shared_ptr<Panel>> toPush;
std::vector<const Panel *> toPop;
};
|
