2 // Copyright (C) 2006 Matthias Braun <matze@braunis.de>
4 // This program is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
9 // This program is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 // GNU General Public License for more details.
14 // You should have received a copy of the GNU General Public License
15 // along with this program. If not, see <http://www.gnu.org/licenses/>.
17 #include "gui/menu.hpp"
22 #include "control/joystickkeyboardcontroller.hpp"
23 #include "gui/menu_item.hpp"
24 #include "gui/menu_manager.hpp"
25 #include "gui/mousecursor.hpp"
26 #include "supertux/globals.hpp"
27 #include "supertux/screen_manager.hpp"
28 #include "supertux/resources.hpp"
29 #include "supertux/timer.hpp"
30 #include "util/gettext.hpp"
31 #include "video/drawing_context.hpp"
32 #include "video/font.hpp"
34 static const float MENU_REPEAT_INITIAL = 0.4f;
35 static const float MENU_REPEAT_RATE = 0.1f;
56 MenuManager::all_menus.push_back(this);
59 menuaction = MENU_ACTION_NONE;
63 pos = SCREEN_SIZE/2.0f;
67 effect_progress = 0.0f;
68 effect_start_time = 0.0f;
70 checkbox = Surface::create("images/engine/menu/checkbox-unchecked.png");
71 checkbox_checked = Surface::create("images/engine/menu/checkbox-checked.png");
72 back = Surface::create("images/engine/menu/arrow-back.png");
73 arrow_left = Surface::create("images/engine/menu/arrow-left.png");
74 arrow_right = Surface::create("images/engine/menu/arrow-right.png");
79 MenuManager::all_menus.remove(this);
81 for(std::vector<MenuItem*>::iterator i = items.begin();
82 i != items.end(); ++i)
87 if (MenuManager::current_ == this)
88 MenuManager::current_ = NULL;
90 if (MenuManager::previous == this)
91 MenuManager::previous = NULL;
95 Menu::set_pos(Vector loc, Vector r)
97 pos = loc + get_size() * r;
100 /* Add an item to a menu */
102 Menu::additem(MenuItem* item)
104 items.push_back(item);
106 /* If a new menu is being built, the active item shouldn't be set to
107 * something that isn't selectable. Set the active_item to the first
108 * selectable item added.
110 if (active_item == -1
111 && item->kind != MN_HL
112 && item->kind != MN_LABEL
113 && item->kind != MN_INACTIVE) {
114 active_item = items.size() - 1;
121 MenuItem* item = new MenuItem(MN_HL);
127 Menu::add_label(const std::string& text)
129 MenuItem* item = new MenuItem(MN_LABEL);
136 Menu::add_controlfield(int id, const std::string& text,
137 const std::string& mapping)
139 MenuItem* item = new MenuItem(MN_CONTROLFIELD, id);
140 item->change_text(text);
141 item->change_input(mapping);
147 Menu::add_entry(int id, const std::string& text)
149 MenuItem* item = new MenuItem(MN_ACTION, id);
156 Menu::add_inactive(int id, const std::string& text)
158 MenuItem* item = new MenuItem(MN_INACTIVE, id);
165 Menu::add_toggle(int id, const std::string& text, bool toogled)
167 MenuItem* item = new MenuItem(MN_TOGGLE, id);
169 item->toggled = toogled;
175 Menu::add_string_select(int id, const std::string& text)
177 MenuItem* item = new MenuItem(MN_STRINGSELECT, id);
184 Menu::add_back(const std::string& text)
186 MenuItem* item = new MenuItem(MN_BACK);
193 Menu::add_submenu(const std::string& text, Menu* submenu, int id)
195 MenuItem* item = new MenuItem(MN_GOTO, id);
197 item->target_menu = submenu;
205 for(std::vector<MenuItem*>::iterator i = items.begin();
206 i != items.end(); ++i) {
213 /* Process actions done on the menu */
217 int menu_height = (int) get_height();
218 if (menu_height > SCREEN_HEIGHT)
220 int scroll_offset = (menu_height - SCREEN_HEIGHT) / 2 + 32;
221 pos_y = SCREEN_HEIGHT/2 - scroll_offset * ((float(active_item) / (items.size()-1)) - 0.5f) * 2.0f;
224 effect_progress = (real_time - effect_start_time) * 6.0f;
226 if(effect_progress >= 1.0f) {
227 effect_progress = 1.0f;
230 MenuManager::current_ = 0;
234 else if (effect_progress <= 0.0f) {
235 effect_progress = 0.0f;
238 /** check main input controller... */
239 if(g_main_controller->pressed(Controller::UP)) {
240 menuaction = MENU_ACTION_UP;
241 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
243 if(g_main_controller->hold(Controller::UP) &&
244 menu_repeat_time != 0 && real_time > menu_repeat_time) {
245 menuaction = MENU_ACTION_UP;
246 menu_repeat_time = real_time + MENU_REPEAT_RATE;
249 if(g_main_controller->pressed(Controller::DOWN)) {
250 menuaction = MENU_ACTION_DOWN;
251 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
253 if(g_main_controller->hold(Controller::DOWN) &&
254 menu_repeat_time != 0 && real_time > menu_repeat_time) {
255 menuaction = MENU_ACTION_DOWN;
256 menu_repeat_time = real_time + MENU_REPEAT_RATE;
259 if(g_main_controller->pressed(Controller::LEFT)) {
260 menuaction = MENU_ACTION_LEFT;
261 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
263 if(g_main_controller->hold(Controller::LEFT) &&
264 menu_repeat_time != 0 && real_time > menu_repeat_time) {
265 menuaction = MENU_ACTION_LEFT;
266 menu_repeat_time = real_time + MENU_REPEAT_RATE;
269 if(g_main_controller->pressed(Controller::RIGHT)) {
270 menuaction = MENU_ACTION_RIGHT;
271 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
273 if(g_main_controller->hold(Controller::RIGHT) &&
274 menu_repeat_time != 0 && real_time > menu_repeat_time) {
275 menuaction = MENU_ACTION_RIGHT;
276 menu_repeat_time = real_time + MENU_REPEAT_RATE;
279 if(g_main_controller->pressed(Controller::ACTION)
280 || g_main_controller->pressed(Controller::MENU_SELECT)) {
281 menuaction = MENU_ACTION_HIT;
283 if(g_main_controller->pressed(Controller::PAUSE_MENU)) {
284 menuaction = MENU_ACTION_BACK;
288 if(items.size() == 0)
291 int last_active_item = active_item;
298 active_item = int(items.size())-1;
299 } while ((items[active_item]->kind == MN_HL
300 || items[active_item]->kind == MN_LABEL
301 || items[active_item]->kind == MN_INACTIVE)
302 && (active_item != last_active_item));
306 case MENU_ACTION_DOWN:
308 if(active_item < int(items.size())-1 )
312 } while ((items[active_item]->kind == MN_HL
313 || items[active_item]->kind == MN_LABEL
314 || items[active_item]->kind == MN_INACTIVE)
315 && (active_item != last_active_item));
319 case MENU_ACTION_LEFT:
320 if(items[active_item]->kind == MN_STRINGSELECT) {
321 if(items[active_item]->selected > 0)
322 items[active_item]->selected--;
324 items[active_item]->selected = items[active_item]->list.size()-1;
326 menu_action(items[active_item]);
330 case MENU_ACTION_RIGHT:
331 if(items[active_item]->kind == MN_STRINGSELECT) {
332 if(items[active_item]->selected+1 < items[active_item]->list.size())
333 items[active_item]->selected++;
335 items[active_item]->selected = 0;
337 menu_action(items[active_item]);
341 case MENU_ACTION_HIT: {
342 hit_item = active_item;
343 switch (items[active_item]->kind) {
345 assert(items[active_item]->target_menu != 0);
346 MenuManager::push_current(items[active_item]->target_menu);
350 items[active_item]->toggled = !items[active_item]->toggled;
351 menu_action(items[active_item]);
354 case MN_CONTROLFIELD:
355 menu_action(items[active_item]);
359 menu_action(items[active_item]);
362 case MN_STRINGSELECT:
363 if(items[active_item]->selected+1 < items[active_item]->list.size())
364 items[active_item]->selected++;
366 items[active_item]->selected = 0;
368 menu_action(items[active_item]);
373 menuaction = MENU_ACTION_DOWN;
378 MenuManager::pop_current();
386 case MENU_ACTION_REMOVE:
387 if(items[active_item]->kind == MN_TEXTFIELD
388 || items[active_item]->kind == MN_NUMFIELD)
390 if(!items[active_item]->input.empty())
392 int i = items[active_item]->input.size();
394 while(delete_character > 0) /* remove characters */
396 items[active_item]->input.resize(i-1);
403 case MENU_ACTION_INPUT:
404 if(items[active_item]->kind == MN_TEXTFIELD
405 || (items[active_item]->kind == MN_NUMFIELD
406 && mn_input_char >= '0' && mn_input_char <= '9'))
408 items[active_item]->input.push_back(mn_input_char);
412 case MENU_ACTION_BACK:
413 MenuManager::pop_current();
416 case MENU_ACTION_NONE:
419 menuaction = MENU_ACTION_NONE;
421 assert(active_item < int(items.size()));
429 int id = items[hit_item]->id;
430 // Clear event when checked out.. (we would end up in a loop when we try to leave "fake" submenu like Addons or Contrib)
439 Menu::menu_action(MenuItem* )
443 Menu::draw_item(DrawingContext& context, int index)
445 float menu_height = get_height();
446 float menu_width = get_width();
448 MenuItem& pitem = *(items[index]);
450 Color text_color = default_color;
452 float y_pos = pos_y + 24*index - menu_height/2 + 12;
454 int text_width = int(Resources::normal_font->get_text_width(pitem.text));
455 int input_width = int(Resources::normal_font->get_text_width(pitem.input) + 10);
458 float left = pos_x - menu_width/2 + 16;
459 float right = pos_x + menu_width/2 - 16;
461 if(pitem.list.size() > 0) {
462 list_width = (int) Resources::normal_font->get_text_width(pitem.list[pitem.selected]);
466 x_pos += 24 - menu_width/2 + (text_width + input_width + list_width)/2;
468 if(index == active_item)
471 text_color = active_color;
474 if(active_item == index)
476 float blink = (sinf(real_time * M_PI * 1.0f)/2.0f + 0.5f) * 0.5f + 0.25f;
477 context.draw_filled_rect(Rectf(Vector(pos_x - menu_width/2 + 10 - 2, y_pos - 12 - 2),
478 Vector(pos_x + menu_width/2 - 10 + 2, y_pos + 12 + 2)),
479 Color(1.0f, 1.0f, 1.0f, blink),
482 context.draw_filled_rect(Rectf(Vector(pos_x - menu_width/2 + 10, y_pos - 12),
483 Vector(pos_x + menu_width/2 - 10, y_pos + 12)),
484 Color(1.0f, 1.0f, 1.0f, 0.5f),
493 context.draw_text(Resources::normal_font, pitem.text,
494 Vector(pos_x, y_pos - int(Resources::normal_font->get_height()/2)),
495 ALIGN_CENTER, LAYER_GUI, inactive_color);
502 float x = pos_x - menu_width/2;
503 float y = y_pos - 12;
504 /* Draw a horizontal line with a little 3d effect */
505 context.draw_filled_rect(Vector(x, y + 6),
506 Vector(menu_width, 4),
507 Color(0.6f, 0.7f, 1.0f, 1.0f), LAYER_GUI);
508 context.draw_filled_rect(Vector(x, y + 6),
509 Vector(menu_width, 2),
510 Color(1.0f, 1.0f, 1.0f, 1.0f), LAYER_GUI);
515 context.draw_text(Resources::big_font, pitem.text,
516 Vector(pos_x, y_pos - int(Resources::big_font->get_height()/2)),
517 ALIGN_CENTER, LAYER_GUI, label_color);
522 case MN_CONTROLFIELD:
524 if(pitem.kind == MN_TEXTFIELD || pitem.kind == MN_NUMFIELD)
526 if(active_item == index)
527 context.draw_text(Resources::normal_font,
528 pitem.get_input_with_symbol(true),
529 Vector(right, y_pos - int(Resources::normal_font->get_height()/2)),
530 ALIGN_RIGHT, LAYER_GUI, field_color);
532 context.draw_text(Resources::normal_font,
533 pitem.get_input_with_symbol(false),
534 Vector(right, y_pos - int(Resources::normal_font->get_height()/2)),
535 ALIGN_RIGHT, LAYER_GUI, field_color);
538 context.draw_text(Resources::normal_font, pitem.input,
539 Vector(right, y_pos - int(Resources::normal_font->get_height()/2)),
540 ALIGN_RIGHT, LAYER_GUI, field_color);
542 context.draw_text(Resources::normal_font, pitem.text,
543 Vector(left, y_pos - int(Resources::normal_font->get_height()/2)),
544 ALIGN_LEFT, LAYER_GUI, text_color);
547 case MN_STRINGSELECT:
549 float roff = arrow_left->get_width();
551 context.draw_text(Resources::normal_font, pitem.text,
552 Vector(left, y_pos - int(Resources::normal_font->get_height()/2)),
553 ALIGN_LEFT, LAYER_GUI, text_color);
556 context.draw_surface(arrow_left,
557 Vector(right - list_width - roff - roff, y_pos - 8),
559 context.draw_surface(arrow_right,
560 Vector(right - roff, y_pos - 8),
562 context.draw_text(Resources::normal_font, pitem.list[pitem.selected],
563 Vector(right - roff, y_pos - int(Resources::normal_font->get_height()/2)),
564 ALIGN_RIGHT, LAYER_GUI, text_color);
569 context.draw_text(Resources::Resources::normal_font, pitem.text,
570 Vector(pos_x, y_pos - int(Resources::normal_font->get_height()/2)),
571 ALIGN_CENTER, LAYER_GUI, text_color);
572 context.draw_surface(back,
573 Vector(x_pos + text_width/2 + 16, y_pos - 8),
580 context.draw_text(Resources::normal_font, pitem.text,
581 Vector(pos_x - menu_width/2 + 16, y_pos - (Resources::normal_font->get_height()/2)),
582 ALIGN_LEFT, LAYER_GUI, text_color);
585 context.draw_surface(checkbox_checked,
586 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
589 context.draw_surface(checkbox,
590 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
595 context.draw_text(Resources::normal_font, pitem.text,
596 Vector(pos_x, y_pos - int(Resources::normal_font->get_height()/2)),
597 ALIGN_CENTER, LAYER_GUI, text_color);
601 context.draw_text(Resources::normal_font, pitem.text,
602 Vector(pos_x, y_pos - int(Resources::normal_font->get_height()/2)),
603 ALIGN_CENTER, LAYER_GUI, text_color);
609 Menu::get_width() const
611 /* The width of the menu has to be more than the width of the text
612 with the most characters */
613 float menu_width = 0;
614 for(unsigned int i = 0; i < items.size(); ++i)
616 FontPtr font = Resources::Resources::normal_font;
617 if(items[i]->kind == MN_LABEL)
618 font = Resources::big_font;
620 float w = font->get_text_width(items[i]->text) +
621 Resources::big_font->get_text_width(items[i]->input) + 16;
622 if(items[i]->kind == MN_TOGGLE)
629 return menu_width + 24;
633 Menu::get_height() const
635 return items.size() * 24;
638 /* Draw the current menu. */
640 Menu::draw(DrawingContext& context)
642 if(MouseCursor::current()) {
643 MouseCursor::current()->draw(context);
646 float menu_width = get_width();
647 float menu_height = get_height();
649 if (effect_progress != 1.0f)
653 menu_width = (MenuManager::current_->get_width() * (1.0f - effect_progress));
654 menu_height = (MenuManager::current_->get_height() * (1.0f - effect_progress));
656 else if (MenuManager::previous)
658 menu_width = (menu_width * effect_progress) + (MenuManager::previous->get_width() * (1.0f - effect_progress));
659 menu_height = (menu_height * effect_progress) + (MenuManager::previous->get_height() * (1.0f - effect_progress));
660 //std::cout << effect_progress << " " << this << " " << last_menus.back() << std::endl;
664 menu_width *= effect_progress;
665 menu_height *= effect_progress;
669 /* Draw a transparent background */
670 context.draw_filled_rect(Rectf(Vector(pos_x - menu_width/2-4, pos_y - menu_height/2 - 10-4),
671 Vector(pos_x + menu_width/2+4, pos_y - menu_height/2 + 10 + menu_height+4)),
672 Color(0.2f, 0.3f, 0.4f, 0.8f),
676 context.draw_filled_rect(Rectf(Vector(pos_x - menu_width/2, pos_y - menu_height/2 - 10),
677 Vector(pos_x + menu_width/2, pos_y - menu_height/2 + 10 + menu_height)),
678 Color(0.6f, 0.7f, 0.8f, 0.5f),
682 if (!items[active_item]->help.empty())
684 int text_width = (int) Resources::normal_font->get_text_width(items[active_item]->help);
685 int text_height = (int) Resources::normal_font->get_text_height(items[active_item]->help);
687 Rectf text_rect(pos_x - text_width/2 - 8,
688 SCREEN_HEIGHT - 48 - text_height/2 - 4,
689 pos_x + text_width/2 + 8,
690 SCREEN_HEIGHT - 48 + text_height/2 + 4);
692 context.draw_filled_rect(Rectf(text_rect.p1 - Vector(4,4),
693 text_rect.p2 + Vector(4,4)),
694 Color(0.2f, 0.3f, 0.4f, 0.8f),
698 context.draw_filled_rect(text_rect,
699 Color(0.6f, 0.7f, 0.8f, 0.5f),
703 context.draw_text(Resources::normal_font, items[active_item]->help,
704 Vector(pos_x, SCREEN_HEIGHT - 48 - text_height/2),
705 ALIGN_CENTER, LAYER_GUI);
708 if (effect_progress == 1.0f)
709 for(unsigned int i = 0; i < items.size(); ++i)
711 draw_item(context, i);
716 Menu::get_item_by_id(int id)
718 for(std::vector<MenuItem*>::iterator i = items.begin();
719 i != items.end(); ++i) {
720 MenuItem& item = **i;
726 throw std::runtime_error("MenuItem not found");
730 Menu::get_item_by_id(int id) const
732 for(std::vector<MenuItem*>::const_iterator i = items.begin();
733 i != items.end(); ++i) {
734 const MenuItem& item = **i;
740 throw std::runtime_error("MenuItem not found");
743 int Menu::get_active_item_id()
745 return items[active_item]->id;
749 Menu::is_toggled(int id) const
751 return get_item_by_id(id).toggled;
755 Menu::set_toggled(int id, bool toggled)
757 get_item_by_id(id).toggled = toggled;
761 Menu::get_parent() const
763 if (MenuManager::last_menus.empty())
766 return MenuManager::last_menus.back();
769 /* Check for menu event */
771 Menu::event(const SDL_Event& event)
773 if(effect_progress != 1.0f)
777 case SDL_MOUSEBUTTONDOWN:
779 int x = int(event.motion.x * float(SCREEN_WIDTH)/g_screen->w);
780 int y = int(event.motion.y * float(SCREEN_HEIGHT)/g_screen->h);
782 if(x > pos_x - get_width()/2 &&
783 x < pos_x + get_width()/2 &&
784 y > pos_y - get_height()/2 &&
785 y < pos_y + get_height()/2)
787 menuaction = MENU_ACTION_HIT;
792 case SDL_MOUSEMOTION:
794 float x = event.motion.x * SCREEN_WIDTH/g_screen->w;
795 float y = event.motion.y * SCREEN_HEIGHT/g_screen->h;
797 if(x > pos_x - get_width()/2 &&
798 x < pos_x + get_width()/2 &&
799 y > pos_y - get_height()/2 &&
800 y < pos_y + get_height()/2)
803 = static_cast<int> ((y - (pos_y - get_height()/2)) / 24);
805 /* only change the mouse focus to a selectable item */
806 if ((items[new_active_item]->kind != MN_HL)
807 && (items[new_active_item]->kind != MN_LABEL)
808 && (items[new_active_item]->kind != MN_INACTIVE))
809 active_item = new_active_item;
811 if(MouseCursor::current())
812 MouseCursor::current()->set_state(MC_LINK);
816 if(MouseCursor::current())
817 MouseCursor::current()->set_state(MC_NORMAL);
828 Menu::set_active_item(int id)
830 for(size_t i = 0; i < items.size(); ++i) {
831 MenuItem* item = items[i];