ScummVM API documentation
qd_interface_element_state.h
1/* ScummVM - Graphic Adventure Engine
2 *
3 * ScummVM is the legal property of its developers, whose names
4 * are too numerous to list here. Please refer to the COPYRIGHT
5 * file distributed with this source distribution.
6 *
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 *
20 */
21
22#ifndef QDENGINE_QDCORE_QD_INTERFACE_ELEMENT_STATE_H
23#define QDENGINE_QDCORE_QD_INTERFACE_ELEMENT_STATE_H
24
25#include "qdengine/parser/xml_fwd.h"
26#include "qdengine/qdcore/qd_animation_info.h"
27#include "qdengine/qdcore/qd_interface_object_base.h"
28#include "qdengine/qdcore/qd_interface_element_state_mode.h"
29
30
31namespace QDEngine {
32
33
36public:
38 enum event_t {
39 EVENT_NONE = 0,
53 // (парметер имя элемента)
56 // (парметер имя элемента)
59 // (парметер имя элемента)
64
70
91 EVENT_SCROLL_RIGHT, // 21
92 EVENT_SCROLL_UP, // 22
93 EVENT_SCROLL_DOWN, // 23
106 };
107
114 };
115
116 qdInterfaceEvent(event_t id, const char *data, bool anm_flag, activation_t activation = EVENT_ACTIVATION_CLICK) : _event(id), _event_data(data), _is_before_animation(anm_flag), _activation(activation) { }
117 ~qdInterfaceEvent() {}
118
119 bool operator == (event_t id) const {
120 return (_event == id);
121 }
122
124 event_t event() const {
125 return _event;
126 }
128 bool has_data() const {
129 return !_event_data.empty();
130 }
132 const char *event_data() const {
133 return _event_data.c_str();
134 }
136 bool is_before_animation() const {
137 return _is_before_animation;
138 }
139 activation_t activation() const {
140 return _activation;
141 }
142
143private:
144
146 event_t _event;
148 Common::String _event_data;
150 bool _is_before_animation;
152 activation_t _activation;
153};
154
157public:
166 };
167
168 enum {
170 NUM_MODES = 3
171 };
172
176
177 qdInterfaceElementState &operator = (const qdInterfaceElementState &st);
178
180
186 return _modes[snd_id].sound_file();
187 }
189 const qdSound *sound(state_mode_t snd_id = DEFAULT_MODE) const {
190 return _modes[snd_id].sound();
191 }
193 bool has_sound(state_mode_t snd_id = DEFAULT_MODE) const {
194 return _modes[snd_id].has_sound();
195 }
196
198
204 return _modes[anm_id].animation_file();
205 }
208 return _modes[anm_id].animation_flags();
209 }
210
213 _modes[anm_id].set_animation_flag(fl);
214 }
217 _modes[anm_id].drop_animation_flag(fl);
218 }
220 bool check_animation_flag(int fl, state_mode_t anm_id = DEFAULT_MODE) const {
221 return _modes[anm_id].check_animation_flag(fl);
222 }
223
226 return _modes[anm_id].animation();
227 }
230 return _modes[anm_id].has_animation();
231 }
232
237
238 Common::String event2Str(int fl, bool truncate = false) const;
239 Common::String eventActivation2Str(int fl, bool truncate = false) const;
240
242 bool save_script(Common::WriteStream &fh, int indent = 0) const;
244 bool load_script(const xml::tag *p);
245
247
250 bool quant(float dt);
251
254 _state_mode = mode;
255 }
258 return _state_mode;
259 }
261 bool has_state_mode(state_mode_t mode) const;
262
264 bool has_contour(state_mode_t mode) const {
265 return _modes[mode].has_contour();
266 }
268 bool get_contour(state_mode_t mode, qdContour &cnt) const;
270 bool set_contour(state_mode_t mode, const qdContour &cnt);
271
273 bool hit_test(int x, int y, state_mode_t mode) const {
274 return _modes[mode].hit_test(x, y);
275 }
276
280 bool keyboard_handler(Common::KeyCode vkey);
281
284 const events_container_t &events() const {
285 return _events;
286 }
288 void add_event(const qdInterfaceEvent &ev) {
289 _events.push_back(ev);
290 }
292 void erase_event(int iNum) {
293 _events.erase(_events.begin() + iNum);
294 }
297 _events.clear();
298 }
299
304 bool need_active_game() const;
305
306 const qdInterfaceEvent *find_event(qdInterfaceEvent::event_t type) const;
307 bool has_event(qdInterfaceEvent::event_t type, const char *ev_data = NULL) const;
308
309private:
310
312 events_container_t _events;
313
316
318 state_mode_t _state_mode;
320 state_mode_t _prev_state_mode;
321
323
327 bool handle_events(qdInterfaceEvent::activation_t activation_type, bool before_animation);
328};
329
330} // namespace QDEngine
331
332#endif // QDENGINE_QDCORE_QD_INTERFACE_ELEMENT_STATE_H
iterator erase(iterator pos)
Definition: array.h:329
void clear()
Definition: array.h:321
void push_back(const T &element)
Definition: array.h:181
iterator begin()
Definition: array.h:375
Definition: path.h:52
Definition: str.h:59
Definition: stream.h:77
mouseEvent
События.
Definition: mouse_input.h:41
Анимация.
Definition: qd_animation.h:57
Контур.
Definition: qd_contour.h:39
Состояние элемента интерфейса.
Definition: qd_interface_element_state.h:156
void add_event(const qdInterfaceEvent &ev)
Добавление события.
Definition: qd_interface_element_state.h:288
void set_animation_flag(int fl, state_mode_t anm_id=DEFAULT_MODE)
Устанавливает флаг анимации.
Definition: qd_interface_element_state.h:212
const Common::Path animation_file(state_mode_t anm_id=DEFAULT_MODE) const
Возвращает имя файла для анимации.
Definition: qd_interface_element_state.h:203
bool save_script(Common::WriteStream &fh, int indent=0) const
Запись данных в скрипт.
void set_sound_file(const Common::Path &str, state_mode_t snd_id=DEFAULT_MODE)
Устанавливает имя файла звукового эффекта, привязанного к состоянию.
void set_animation_file(const Common::Path &name, state_mode_t anm_id=DEFAULT_MODE)
Устанавливает имя файла для анимации.
bool mouse_handler(int x, int y, mouseDispatcher::mouseEvent ev)
Обработчик событий мыши.
bool check_animation_flag(int fl, state_mode_t anm_id=DEFAULT_MODE) const
Возвращает true, если для анимации установлен флаг fl.
Definition: qd_interface_element_state.h:220
const qdSound * sound(state_mode_t snd_id=DEFAULT_MODE) const
Возвращает указатель на звуковой эффект, привязанный к состоянию.
Definition: qd_interface_element_state.h:189
state_mode_t
Идентификаторы для режимов работы состояния.
Definition: qd_interface_element_state.h:159
@ EVENT_MODE
режим, который включается при клике по элементу-владельцу
Definition: qd_interface_element_state.h:165
@ DEFAULT_MODE
режим по умолчанию
Definition: qd_interface_element_state.h:161
@ MOUSE_HOVER_MODE
режим, который включается когда мышиный курсор находится над элементом-владельцем
Definition: qd_interface_element_state.h:163
bool keyboard_handler(Common::KeyCode vkey)
Обработчик ввода с клавиатуры.
bool set_contour(state_mode_t mode, const qdContour &cnt)
Устанавливает контур для режима mode.
@ NUM_MODES
количество режимов работы состояния
Definition: qd_interface_element_state.h:170
bool has_state_mode(state_mode_t mode) const
Возвращает true, если у состояния может быть включен режим работы mode.
const Common::Path sound_file(state_mode_t snd_id=DEFAULT_MODE) const
Возвращает имя файла звукового эффекта, привязанного к состоянию.
Definition: qd_interface_element_state.h:185
const qdAnimation * animation(state_mode_t anm_id=DEFAULT_MODE) const
Возвращает указатель на анимацию, привязанную к состоянию.
Definition: qd_interface_element_state.h:225
bool unregister_resources()
Высвобождает ресурсы, связанные с состоянием (анимацию и звук).
void erase_all_events()
Удаление всех событий
Definition: qd_interface_element_state.h:296
void erase_event(int iNum)
Уделение события
Definition: qd_interface_element_state.h:292
const events_container_t & events() const
Список событий.
Definition: qd_interface_element_state.h:284
state_mode_t state_mode() const
Возвращает режим работы состояния.
Definition: qd_interface_element_state.h:257
int animation_flags(state_mode_t anm_id=DEFAULT_MODE) const
Возвращает флаги анимации.
Definition: qd_interface_element_state.h:207
bool register_resources()
Регистрирует ресурсы, связанные с состоянием (анимацию и звук).
bool has_contour(state_mode_t mode) const
Возвращает true, если у состояния задан контур для режима mode.
Definition: qd_interface_element_state.h:264
bool get_contour(state_mode_t mode, qdContour &cnt) const
Записывает контур режима mode в cnt.
bool quant(float dt)
Обсчет логики, параметр - время в секундах.
bool load_script(const xml::tag *p)
Загрузка данных из скрипта.
bool has_animation(state_mode_t anm_id=DEFAULT_MODE) const
Возвращает true, если к состоянию привязана анимация.
Definition: qd_interface_element_state.h:229
bool has_sound(state_mode_t snd_id=DEFAULT_MODE) const
Возвращает true, если к состоянию привязан звук.
Definition: qd_interface_element_state.h:193
void set_state_mode(state_mode_t mode)
Устанавливает режим работы состояния.
Definition: qd_interface_element_state.h:253
void drop_animation_flag(int fl, state_mode_t anm_id=DEFAULT_MODE)
Скидывает флаг анимации.
Definition: qd_interface_element_state.h:216
bool hit_test(int x, int y, state_mode_t mode) const
Возвращает true, если точка с экранными координатами (x,у) попадает внутрь контура режима mode.
Definition: qd_interface_element_state.h:273
Событие, привязанное к состоянию интерфейсного элемента.
Definition: qd_interface_element_state_mode.h:36
const Common::Path animation_file() const
Возвращает имя файла для анимации.
Definition: qd_interface_element_state_mode.h:72
bool has_sound() const
Возвращает true, если к событию привязан звук.
Definition: qd_interface_element_state_mode.h:62
bool hit_test(int x, int y) const
Возвращает true, если точка с экранными координатами (x,у) попадает внутрь контура.
Definition: qd_interface_element_state_mode.h:111
bool has_contour() const
Возвращает true, если у состояния задан контур.
Definition: qd_interface_element_state_mode.h:107
const qdAnimation * animation() const
Возвращает указатель на анимацию события.
Definition: qd_interface_element_state_mode.h:99
const Common::Path sound_file() const
Возвращает имя файла звука.
Definition: qd_interface_element_state_mode.h:50
void set_animation_flag(int fl)
Устанавливает флаг анимации.
Definition: qd_interface_element_state_mode.h:81
int animation_flags() const
Возвращает флаги анимации.
Definition: qd_interface_element_state_mode.h:76
void drop_animation_flag(int fl)
Скидывает флаг анимации.
Definition: qd_interface_element_state_mode.h:85
const qdSound * sound() const
Возвращает звук события.
Definition: qd_interface_element_state_mode.h:58
bool check_animation_flag(int fl) const
Возвращает true, если для анимации установлен флаг fl.
Definition: qd_interface_element_state_mode.h:89
bool has_animation() const
Возвращает true, если к состоянию привязана анимация.
Definition: qd_interface_element_state_mode.h:103
Интерфейсное событие.
Definition: qd_interface_element_state.h:35
bool is_before_animation() const
Возвращает true, если событие должно происходить до включения анимации.
Definition: qd_interface_element_state.h:136
event_t event() const
Код события.
Definition: qd_interface_element_state.h:124
activation_t
Способы запуска события
Definition: qd_interface_element_state.h:109
@ EVENT_ACTIVATION_CLICK
левый клик по кнопке
Definition: qd_interface_element_state.h:111
@ EVENT_ACTIVATION_HOVER
наведение мышиного курсора
Definition: qd_interface_element_state.h:113
bool has_data() const
Возвращает true, если у события есть данные.
Definition: qd_interface_element_state.h:128
const char * event_data() const
Возвращает данные для события.
Definition: qd_interface_element_state.h:132
event_t
События, производимые элементами интерфейса.
Definition: qd_interface_element_state.h:38
@ EVENT_LOAD_SCENE
перейти на сцену, параметр - имя сцены
Definition: qd_interface_element_state.h:43
@ EVENT_NEXT_ELEMENT_STATE
включить следующее состояние кнопки (парметер имя кнопки)
Definition: qd_interface_element_state.h:80
@ EVENT_SCROLL_LEFT
скроллинг
Definition: qd_interface_element_state.h:90
@ EVENT_HALL_OF_FAME_SCORE
Очки игрока в таблице рекордов, параметр - номер места
Definition: qd_interface_element_state.h:103
@ EVENT_BUTTON_STATE
включить определенное состояние кнопки, параметр - имя кнопки
Definition: qd_interface_element_state.h:86
@ EVENT_NEW_GAME
новая игра
Definition: qd_interface_element_state.h:47
@ EVENT_MODAL_CANCEL
пользователь завершил работу с модальным окном и ответил Отмена
Definition: qd_interface_element_state.h:99
@ EVENT_CHANGE_INTERFACE_SCREEN
перейти на другой интерфейсный экран (парметер имя экрана)
Definition: qd_interface_element_state.h:49
@ EVENT_HIDE_ELEMENT
спрятать элемент активного экрана (насовсем)
Definition: qd_interface_element_state.h:57
@ EVENT_MAIN_MENU
перейти в main menu
Definition: qd_interface_element_state.h:82
@ EVENT_SAVE_GAME
записать игру [не используется]
Definition: qd_interface_element_state.h:45
@ EVENT_SET_SAVE_MODE
включить режим записи игры
Definition: qd_interface_element_state.h:68
@ EVENT_PLAY_VIDEO
играть видеоролик (параметр - имя видеоролика из списка в qdGameDispatcher)
Definition: qd_interface_element_state.h:84
@ EVENT_SET_LOAD_MODE
включить режим загрузки игры
Definition: qd_interface_element_state.h:74
@ EVENT_CLEAR_MOUSE
скинуть с мыши объект в инвентори
Definition: qd_interface_element_state.h:88
@ EVENT_TMP_HIDE_ELEMENT
временно спрятать элемент активного экрана (до перехода на другой экран)
Definition: qd_interface_element_state.h:54
@ EVENT_RESUME_GAME
продолжить игру
Definition: qd_interface_element_state.h:62
@ EVENT_MODAL_OK
пользователь завершил работу с модальным окном и ответил Ок
Definition: qd_interface_element_state.h:97
@ EVENT_CHANGE_PERSONAGE
сменить активного персонажа
Definition: qd_interface_element_state.h:51
@ EVENT_SHOW_INTERFACE_SCREEN_AS_MODAL
показать экран интерфейса, как модальный
Definition: qd_interface_element_state.h:95
@ EVENT_SHOW_ELEMENT
показать элемент активного экрана
Definition: qd_interface_element_state.h:60
@ EVENT_HALL_OF_FAME_PLAYER
Имя игрока в таблице рекордов, параметр - номер места
Definition: qd_interface_element_state.h:101
@ EVENT_PREV_ELEMENT_STATE
включить предыдущее состояние кнопки (парметер имя кнопки)
Definition: qd_interface_element_state.h:78
@ EVENT_EXIT
выйти из игры
Definition: qd_interface_element_state.h:41
@ EVENT_ACTIVATE_PERSONAGE
сделать персонажа активным, имя персонажа - в данных события
Definition: qd_interface_element_state.h:76
@ EVENT_HALL_OF_FAME_CUR_SCORE
Текущие очки игрока на экране таблицы рекордов
Definition: qd_interface_element_state.h:105
Базовый класс для всех интерфейсных объектов.
Definition: qd_interface_object_base.h:32
const char * name() const
Возвращает имя объекта.
Definition: qd_named_object_base.h:40
Звук.
Definition: qd_sound.h:35
XML тег.
Definition: xml_tag.h:33
Базовый класс для игровых ресурсов.
Definition: console.h:28