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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
|
/* ResidualVM - A 3D game interpreter
*
* ResidualVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the AUTHORS
* file distributed with this source distribution.
*
* This program 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 2
* 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 General Public License for more details.
*
* You should have received a copy of the GNU 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.
*
*/
#ifndef STARK_SERVICES_USER_INTERFACE_H
#define STARK_SERVICES_USER_INTERFACE_H
#include "common/rect.h"
#include "common/str-array.h"
namespace Common {
struct SeekableReadStream;
struct WriteStream;
}
namespace Graphics {
struct Surface;
}
namespace Stark {
namespace Gfx {
class Driver;
}
class ActionMenu;
class DialogPanel;
class InventoryWindow;
class TopMenu;
class Cursor;
class FMVPlayer;
class GameWindow;
class Window;
/**
* Facade object for interacting with the user interface from the rest of the engine
*
* @todo: perhaps move all window management to a new class
* @todo: perhaps introduce a 'Screen' class or just a window with sub-windows for the game screen
*/
class UserInterface {
public:
UserInterface(Gfx::Driver *gfx);
virtual ~UserInterface();
enum Screen {
kScreenGame,
kScreenFMV
};
void init();
void update();
void render();
void handleMouseMove(const Common::Point &pos);
void handleClick();
void handleRightClick();
void handleDoubleClick();
void notifyShouldExit() { _exitGame = true; }
void inventoryOpen(bool open);
bool shouldExit() { return _exitGame; }
/** Start playing a FMV */
void requestFMVPlayback(const Common::String &name);
/** FMV playback has just ended */
void onFMVStopped();
/**
* Abort the currently playing FMV, if any
*
* @return true if a FMV was skipped
*/
bool skipFMV();
/** Set the currently displayed screen */
void changeScreen(Screen screen);
/** Is the game screen currently displayed? */
bool isInGameScreen() const;
/** Is the inventory panel being displayed? */
bool isInventoryOpen() const;
/** Can the player interact with the game world? */
bool isInteractive() const;
/** Allow or forbid interaction with the game world */
void setInteractive(bool interactive);
int16 getSelectedInventoryItem() const;
/** Set the selected inventory item */
void selectInventoryItem(int16 itemIndex);
/** Clears all the pointers to data that may be location dependent */
void clearLocationDependentState();
/** Open the in game options menu */
void optionsOpen();
/** Signal a denied interaction that occurred during a non interactive period */
void markInteractionDenied();
/** Was a player interaction with the world denied during this non interactive period? */
bool wasInteractionDenied() const;
/** The screen resolution just changed, rebuild resolution dependent data */
void onScreenChanged();
/** Grab a screenshot of the game screen and store it in the class context as a thumbnail */
void saveGameScreenThumbnail();
/** Clear the currently stored game screen thumbnail, if any */
void freeGameScreenThumbnail();
/** Get the currently stored game screen thumbnail, returns nullptr if there is not thumbnail stored */
const Graphics::Surface *getGameWindowThumbnail() const;
static const uint kThumbnailWidth = 160;
static const uint kThumbnailHeight = 92;
static const uint kThumbnailSize = kThumbnailWidth * kThumbnailHeight * 4;
private:
typedef void (Window::*WindowHandler)();
void dispatchEvent(WindowHandler handler);
// Game Screen windows
ActionMenu *_actionMenu;
DialogPanel *_dialogPanel;
InventoryWindow *_inventoryWindow;
TopMenu *_topMenu;
GameWindow *_gameWindow;
// Game screen windows array
Common::Array<Window *> _gameScreenWindows;
// FMV screen window
FMVPlayer *_fmvPlayer;
Gfx::Driver *_gfx;
Cursor *_cursor;
bool _exitGame;
Screen _currentScreen;
bool _interactive;
bool _interactionAttemptDenied;
Graphics::Surface *_gameWindowThumbnail;
};
} // End of namespace Stark
#endif // STARK_SERVICES_USER_INTERFACE_H
|
