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/>.
19 #include "control/joystickkeyboardcontroller.hpp"
20 #include "gui/menu.hpp"
21 #include "supertux/main.hpp"
22 #include "supertux/mainloop.hpp"
23 #include "supertux/resources.hpp"
24 #include "supertux/timer.hpp"
25 #include "util/gettext.hpp"
26 #include "video/drawing_context.hpp"
28 static const float MENU_REPEAT_INITIAL = 0.4f;
29 static const float MENU_REPEAT_RATE = 0.1f;
30 static const float FLICK_CURSOR_TIME = 0.5f;
32 extern SDL_Surface* g_screen;
34 std::vector<Menu*> Menu::last_menus;
35 std::list<Menu*> Menu::all_menus;
36 Menu* Menu::current_ = 0;
37 Menu* Menu::previous = 0;
39 /* just displays a Yes/No text that can be used to confirm stuff */
40 bool confirm_dialog(Surface *background, std::string text)
42 //Surface* cap_screen = Surface::CaptureScreen();
43 Menu* dialog = new Menu;
44 dialog->add_inactive(-1, text);
46 dialog->add_entry(true, _("Yes"));
47 dialog->add_entry(false, _("No"));
50 Menu::set_current(dialog);
52 DrawingContext context;
54 // TODO make this a screen and not another mainloop...
58 while (SDL_PollEvent(&event)) {
59 if(event.type == SDL_QUIT)
61 g_main_controller->process_event(event);
65 if(background == NULL)
66 context.draw_gradient(Color(0.8f, 0.95f, 0.85f), Color(0.8f, 0.8f, 0.8f),
69 context.draw_surface(background, Vector(0,0), LAYER_BACKGROUND0);
71 dialog->draw(context);
74 switch (dialog->check())
92 mouse_cursor->draw(context);
101 Menu::push_current(Menu* pmenu)
106 last_menus.push_back(current_);
109 current_->effect_start_time = real_time;
110 current_->effect_progress = 0.0f;
118 if (last_menus.size() >= 1) {
119 current_ = last_menus.back();
120 current_->effect_start_time = real_time;
121 current_->effect_progress = 0.0f;
122 last_menus.pop_back();
129 Menu::set_current(Menu* menu)
131 if (current_ && current_->close == true)
137 menu->effect_start_time = real_time;
138 menu->effect_progress = 0.0f;
142 last_menus.clear(); //NULL new menu pointer => close all menus
143 current_->effect_start_time = real_time;
144 current_->effect_progress = 0.0f;
145 current_->close = true;
148 // just to be sure...
149 g_main_controller->reset();
156 current_->set_pos(SCREEN_WIDTH/2, SCREEN_HEIGHT/2);
158 for(std::list<Menu*>::iterator i = all_menus.begin(); i != all_menus.end(); ++i)
160 // FIXME: This is of course not quite right, since it ignores any previous set_pos() calls
161 (*i)->set_pos(SCREEN_WIDTH/2, SCREEN_HEIGHT/2);
165 MenuItem::MenuItem(MenuItemKind _kind, int _id)
166 : kind(_kind) , id(_id)
174 MenuItem::change_text(const std::string& text_)
180 MenuItem::change_input(const std::string& text_)
186 MenuItem::set_help(const std::string& help_text)
188 std::string overflow;
189 help = normal_font->wrap_to_width(help_text, 600, &overflow);
190 while (!overflow.empty())
193 help += normal_font->wrap_to_width(overflow, 600, &overflow);
197 std::string MenuItem::get_input_with_symbol(bool active_item)
200 input_flickering = true;
202 input_flickering = ((int) (real_time / FLICK_CURSOR_TIME)) % 2;
207 snprintf(str, sizeof(str), "%s ",input.c_str());
209 snprintf(str, sizeof(str), "%s_",input.c_str());
211 std::string string = str;
218 all_menus.remove(this);
220 for(std::vector<MenuItem*>::iterator i = items.begin();
221 i != items.end(); ++i)
227 if (previous == this)
234 all_menus.push_back(this);
237 menuaction = MENU_ACTION_NONE;
238 delete_character = 0;
239 mn_input_char = '\0';
241 pos_x = SCREEN_WIDTH/2;
242 pos_y = SCREEN_HEIGHT/2;
246 effect_progress = 0.0f;
247 effect_start_time = 0.0f;
249 checkbox.reset(new Surface("images/engine/menu/checkbox-unchecked.png"));
250 checkbox_checked.reset(new Surface("images/engine/menu/checkbox-checked.png"));
251 back.reset(new Surface("images/engine/menu/arrow-back.png"));
252 arrow_left.reset(new Surface("images/engine/menu/arrow-left.png"));
253 arrow_right.reset(new Surface("images/engine/menu/arrow-right.png"));
257 Menu::set_pos(float x, float y, float rw, float rh)
259 pos_x = x + get_width() * rw;
260 pos_y = y + get_height() * rh;
263 /* Add an item to a menu */
265 Menu::additem(MenuItem* item)
267 items.push_back(item);
269 /* If a new menu is being built, the active item shouldn't be set to
270 * something that isn't selectable. Set the active_item to the first
271 * selectable item added.
273 if (active_item == -1
274 && item->kind != MN_HL
275 && item->kind != MN_LABEL
276 && item->kind != MN_INACTIVE) {
277 active_item = items.size() - 1;
284 MenuItem* item = new MenuItem(MN_HL);
290 Menu::add_label(const std::string& text)
292 MenuItem* item = new MenuItem(MN_LABEL);
299 Menu::add_controlfield(int id, const std::string& text,
300 const std::string& mapping)
302 MenuItem* item = new MenuItem(MN_CONTROLFIELD, id);
303 item->change_text(text);
304 item->change_input(mapping);
310 Menu::add_entry(int id, const std::string& text)
312 MenuItem* item = new MenuItem(MN_ACTION, id);
319 Menu::add_inactive(int id, const std::string& text)
321 MenuItem* item = new MenuItem(MN_INACTIVE, id);
328 Menu::add_toggle(int id, const std::string& text, bool toogled)
330 MenuItem* item = new MenuItem(MN_TOGGLE, id);
332 item->toggled = toogled;
338 Menu::add_string_select(int id, const std::string& text)
340 MenuItem* item = new MenuItem(MN_STRINGSELECT, id);
347 Menu::add_back(const std::string& text)
349 MenuItem* item = new MenuItem(MN_BACK);
356 Menu::add_submenu(const std::string& text, Menu* submenu, int id)
358 MenuItem* item = new MenuItem(MN_GOTO, id);
360 item->target_menu = submenu;
368 for(std::vector<MenuItem*>::iterator i = items.begin();
369 i != items.end(); ++i) {
376 /* Process actions done on the menu */
380 int menu_height = (int) get_height();
381 if (menu_height > SCREEN_HEIGHT)
383 int scroll_offset = (menu_height - SCREEN_HEIGHT) / 2 + 32;
384 pos_y = SCREEN_HEIGHT/2 - scroll_offset * ((float(active_item) / (items.size()-1)) - 0.5f) * 2.0f;
387 effect_progress = (real_time - effect_start_time) * 6.0f;
389 if(effect_progress >= 1.0f) {
390 effect_progress = 1.0f;
397 else if (effect_progress <= 0.0f) {
398 effect_progress = 0.0f;
401 /** check main input controller... */
402 if(g_main_controller->pressed(Controller::UP)) {
403 menuaction = MENU_ACTION_UP;
404 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
406 if(g_main_controller->hold(Controller::UP) &&
407 menu_repeat_time != 0 && real_time > menu_repeat_time) {
408 menuaction = MENU_ACTION_UP;
409 menu_repeat_time = real_time + MENU_REPEAT_RATE;
412 if(g_main_controller->pressed(Controller::DOWN)) {
413 menuaction = MENU_ACTION_DOWN;
414 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
416 if(g_main_controller->hold(Controller::DOWN) &&
417 menu_repeat_time != 0 && real_time > menu_repeat_time) {
418 menuaction = MENU_ACTION_DOWN;
419 menu_repeat_time = real_time + MENU_REPEAT_RATE;
422 if(g_main_controller->pressed(Controller::LEFT)) {
423 menuaction = MENU_ACTION_LEFT;
424 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
426 if(g_main_controller->hold(Controller::LEFT) &&
427 menu_repeat_time != 0 && real_time > menu_repeat_time) {
428 menuaction = MENU_ACTION_LEFT;
429 menu_repeat_time = real_time + MENU_REPEAT_RATE;
432 if(g_main_controller->pressed(Controller::RIGHT)) {
433 menuaction = MENU_ACTION_RIGHT;
434 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
436 if(g_main_controller->hold(Controller::RIGHT) &&
437 menu_repeat_time != 0 && real_time > menu_repeat_time) {
438 menuaction = MENU_ACTION_RIGHT;
439 menu_repeat_time = real_time + MENU_REPEAT_RATE;
442 if(g_main_controller->pressed(Controller::ACTION)
443 || g_main_controller->pressed(Controller::MENU_SELECT)) {
444 menuaction = MENU_ACTION_HIT;
446 if(g_main_controller->pressed(Controller::PAUSE_MENU)) {
447 menuaction = MENU_ACTION_BACK;
451 if(items.size() == 0)
454 int last_active_item = active_item;
461 active_item = int(items.size())-1;
462 } while ((items[active_item]->kind == MN_HL
463 || items[active_item]->kind == MN_LABEL
464 || items[active_item]->kind == MN_INACTIVE)
465 && (active_item != last_active_item));
469 case MENU_ACTION_DOWN:
471 if(active_item < int(items.size())-1 )
475 } while ((items[active_item]->kind == MN_HL
476 || items[active_item]->kind == MN_LABEL
477 || items[active_item]->kind == MN_INACTIVE)
478 && (active_item != last_active_item));
482 case MENU_ACTION_LEFT:
483 if(items[active_item]->kind == MN_STRINGSELECT) {
484 if(items[active_item]->selected > 0)
485 items[active_item]->selected--;
487 items[active_item]->selected = items[active_item]->list.size()-1;
489 menu_action(items[active_item]);
493 case MENU_ACTION_RIGHT:
494 if(items[active_item]->kind == MN_STRINGSELECT) {
495 if(items[active_item]->selected+1 < items[active_item]->list.size())
496 items[active_item]->selected++;
498 items[active_item]->selected = 0;
500 menu_action(items[active_item]);
504 case MENU_ACTION_HIT: {
505 hit_item = active_item;
506 switch (items[active_item]->kind) {
508 assert(items[active_item]->target_menu != 0);
509 Menu::push_current(items[active_item]->target_menu);
513 items[active_item]->toggled = !items[active_item]->toggled;
514 menu_action(items[active_item]);
517 case MN_CONTROLFIELD:
518 menu_action(items[active_item]);
522 menu_action(items[active_item]);
525 case MN_STRINGSELECT:
526 if(items[active_item]->selected+1 < items[active_item]->list.size())
527 items[active_item]->selected++;
529 items[active_item]->selected = 0;
531 menu_action(items[active_item]);
536 menuaction = MENU_ACTION_DOWN;
549 case MENU_ACTION_REMOVE:
550 if(items[active_item]->kind == MN_TEXTFIELD
551 || items[active_item]->kind == MN_NUMFIELD)
553 if(!items[active_item]->input.empty())
555 int i = items[active_item]->input.size();
557 while(delete_character > 0) /* remove characters */
559 items[active_item]->input.resize(i-1);
566 case MENU_ACTION_INPUT:
567 if(items[active_item]->kind == MN_TEXTFIELD
568 || (items[active_item]->kind == MN_NUMFIELD
569 && mn_input_char >= '0' && mn_input_char <= '9'))
571 items[active_item]->input.push_back(mn_input_char);
575 case MENU_ACTION_BACK:
579 case MENU_ACTION_NONE:
582 menuaction = MENU_ACTION_NONE;
584 assert(active_item < int(items.size()));
590 if (hit_item != -1) {
591 int id = items[hit_item]->id;
592 hit_item = -1; //Clear event when checked out.. (we would end up in a loop when we try to leave "fake" submenu like Addons or Contrib)
600 Menu::menu_action(MenuItem* )
604 Menu::draw_item(DrawingContext& context, int index)
606 float menu_height = get_height();
607 float menu_width = get_width();
609 MenuItem& pitem = *(items[index]);
611 Color text_color = default_color;
613 float y_pos = pos_y + 24*index - menu_height/2 + 12;
615 int text_width = int(normal_font->get_text_width(pitem.text));
616 int input_width = int(normal_font->get_text_width(pitem.input) + 10);
619 float left = pos_x - menu_width/2 + 16;
620 float right = pos_x + menu_width/2 - 16;
622 if(pitem.list.size() > 0) {
623 list_width = (int) normal_font->get_text_width(pitem.list[pitem.selected]);
627 x_pos += 24 - menu_width/2 + (text_width + input_width + list_width)/2;
629 if(index == active_item)
632 text_color = active_color;
635 if(active_item == index)
637 float blink = (sinf(real_time * M_PI * 1.0f)/2.0f + 0.5f) * 0.5f + 0.25f;
638 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2 + 10 - 2, y_pos - 12 - 2),
639 Vector(pos_x + menu_width/2 - 10 + 2, y_pos + 12 + 2)),
640 Color(1.0f, 1.0f, 1.0f, blink),
643 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2 + 10, y_pos - 12),
644 Vector(pos_x + menu_width/2 - 10, y_pos + 12)),
645 Color(1.0f, 1.0f, 1.0f, 0.5f),
654 context.draw_text(normal_font, pitem.text,
655 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
656 ALIGN_CENTER, LAYER_GUI, inactive_color);
663 float x = pos_x - menu_width/2;
664 float y = y_pos - 12;
665 /* Draw a horizontal line with a little 3d effect */
666 context.draw_filled_rect(Vector(x, y + 6),
667 Vector(menu_width, 4),
668 Color(0.6f, 0.7f, 1.0f, 1.0f), LAYER_GUI);
669 context.draw_filled_rect(Vector(x, y + 6),
670 Vector(menu_width, 2),
671 Color(1.0f, 1.0f, 1.0f, 1.0f), LAYER_GUI);
676 context.draw_text(big_font, pitem.text,
677 Vector(pos_x, y_pos - int(big_font->get_height()/2)),
678 ALIGN_CENTER, LAYER_GUI, label_color);
683 case MN_CONTROLFIELD:
685 if(pitem.kind == MN_TEXTFIELD || pitem.kind == MN_NUMFIELD)
687 if(active_item == index)
688 context.draw_text(normal_font,
689 pitem.get_input_with_symbol(true),
690 Vector(right, y_pos - int(normal_font->get_height()/2)),
691 ALIGN_RIGHT, LAYER_GUI, field_color);
693 context.draw_text(normal_font,
694 pitem.get_input_with_symbol(false),
695 Vector(right, y_pos - int(normal_font->get_height()/2)),
696 ALIGN_RIGHT, LAYER_GUI, field_color);
699 context.draw_text(normal_font, pitem.input,
700 Vector(right, y_pos - int(normal_font->get_height()/2)),
701 ALIGN_RIGHT, LAYER_GUI, field_color);
703 context.draw_text(normal_font, pitem.text,
704 Vector(left, y_pos - int(normal_font->get_height()/2)),
705 ALIGN_LEFT, LAYER_GUI, text_color);
708 case MN_STRINGSELECT:
710 float roff = arrow_left->get_width();
712 context.draw_text(normal_font, pitem.text,
713 Vector(left, y_pos - int(normal_font->get_height()/2)),
714 ALIGN_LEFT, LAYER_GUI, text_color);
717 context.draw_surface(arrow_left.get(),
718 Vector(right - list_width - roff - roff, y_pos - 8),
720 context.draw_surface(arrow_right.get(),
721 Vector(right - roff, y_pos - 8),
723 context.draw_text(normal_font, pitem.list[pitem.selected],
724 Vector(right - roff, y_pos - int(normal_font->get_height()/2)),
725 ALIGN_RIGHT, LAYER_GUI, text_color);
730 context.draw_text(normal_font, pitem.text,
731 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
732 ALIGN_CENTER, LAYER_GUI, text_color);
733 context.draw_surface(back.get(),
734 Vector(x_pos + text_width/2 + 16, y_pos - 8),
741 context.draw_text(normal_font, pitem.text,
742 Vector(pos_x - menu_width/2 + 16, y_pos - (normal_font->get_height()/2)),
743 ALIGN_LEFT, LAYER_GUI, text_color);
746 context.draw_surface(checkbox_checked.get(),
747 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
750 context.draw_surface(checkbox.get(),
751 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
756 context.draw_text(normal_font, pitem.text,
757 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
758 ALIGN_CENTER, LAYER_GUI, text_color);
762 context.draw_text(normal_font, pitem.text,
763 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
764 ALIGN_CENTER, LAYER_GUI, text_color);
770 Menu::get_width() const
772 /* The width of the menu has to be more than the width of the text
773 with the most characters */
774 float menu_width = 0;
775 for(unsigned int i = 0; i < items.size(); ++i)
777 Font* font = normal_font;
778 if(items[i]->kind == MN_LABEL)
781 float w = font->get_text_width(items[i]->text) +
782 big_font->get_text_width(items[i]->input) + 16;
783 if(items[i]->kind == MN_TOGGLE)
790 return menu_width + 24;
794 Menu::get_height() const
796 return items.size() * 24;
799 /* Draw the current menu. */
801 Menu::draw(DrawingContext& context)
803 if(MouseCursor::current()) {
804 MouseCursor::current()->draw(context);
807 float menu_width = get_width();
808 float menu_height = get_height();
810 if (effect_progress != 1.0f)
814 menu_width = (current_->get_width() * (1.0f - effect_progress));
815 menu_height = (current_->get_height() * (1.0f - effect_progress));
817 else if (Menu::previous)
819 menu_width = (menu_width * effect_progress) + (Menu::previous->get_width() * (1.0f - effect_progress));
820 menu_height = (menu_height * effect_progress) + (Menu::previous->get_height() * (1.0f - effect_progress));
821 //std::cout << effect_progress << " " << this << " " << last_menus.back() << std::endl;
825 menu_width *= effect_progress;
826 menu_height *= effect_progress;
830 /* Draw a transparent background */
831 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2-4, pos_y - menu_height/2 - 10-4),
832 Vector(pos_x + menu_width/2+4, pos_y - menu_height/2 + 10 + menu_height+4)),
833 Color(0.2f, 0.3f, 0.4f, 0.8f),
837 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2, pos_y - menu_height/2 - 10),
838 Vector(pos_x + menu_width/2, pos_y - menu_height/2 + 10 + menu_height)),
839 Color(0.6f, 0.7f, 0.8f, 0.5f),
843 if (!items[active_item]->help.empty())
845 int text_width = (int) normal_font->get_text_width(items[active_item]->help);
846 int text_height = (int) normal_font->get_text_height(items[active_item]->help);
848 Rect text_rect(pos_x - text_width/2 - 8,
849 SCREEN_HEIGHT - 48 - text_height/2 - 4,
850 pos_x + text_width/2 + 8,
851 SCREEN_HEIGHT - 48 + text_height/2 + 4);
853 context.draw_filled_rect(Rect(text_rect.p1 - Vector(4,4),
854 text_rect.p2 + Vector(4,4)),
855 Color(0.2f, 0.3f, 0.4f, 0.8f),
859 context.draw_filled_rect(text_rect,
860 Color(0.6f, 0.7f, 0.8f, 0.5f),
864 context.draw_text(normal_font, items[active_item]->help,
865 Vector(pos_x, SCREEN_HEIGHT - 48 - text_height/2),
866 ALIGN_CENTER, LAYER_GUI);
869 if (effect_progress == 1.0f)
870 for(unsigned int i = 0; i < items.size(); ++i)
872 draw_item(context, i);
877 Menu::get_item_by_id(int id)
879 for(std::vector<MenuItem*>::iterator i = items.begin();
880 i != items.end(); ++i) {
881 MenuItem& item = **i;
887 throw std::runtime_error("MenuItem not found");
891 Menu::get_item_by_id(int id) const
893 for(std::vector<MenuItem*>::const_iterator i = items.begin();
894 i != items.end(); ++i) {
895 const MenuItem& item = **i;
901 throw std::runtime_error("MenuItem not found");
904 int Menu::get_active_item_id()
906 return items[active_item]->id;
910 Menu::is_toggled(int id) const
912 return get_item_by_id(id).toggled;
916 Menu::set_toggled(int id, bool toggled)
918 get_item_by_id(id).toggled = toggled;
922 Menu::get_parent() const
924 if (last_menus.empty())
927 return last_menus.back();
930 /* Check for menu event */
932 Menu::event(const SDL_Event& event)
934 if(effect_progress != 1.0f)
938 case SDL_MOUSEBUTTONDOWN:
940 int x = int(event.motion.x * float(SCREEN_WIDTH)/g_screen->w);
941 int y = int(event.motion.y * float(SCREEN_HEIGHT)/g_screen->h);
943 if(x > pos_x - get_width()/2 &&
944 x < pos_x + get_width()/2 &&
945 y > pos_y - get_height()/2 &&
946 y < pos_y + get_height()/2)
948 menuaction = MENU_ACTION_HIT;
953 case SDL_MOUSEMOTION:
955 float x = event.motion.x * SCREEN_WIDTH/g_screen->w;
956 float y = event.motion.y * SCREEN_HEIGHT/g_screen->h;
958 if(x > pos_x - get_width()/2 &&
959 x < pos_x + get_width()/2 &&
960 y > pos_y - get_height()/2 &&
961 y < pos_y + get_height()/2)
964 = static_cast<int> ((y - (pos_y - get_height()/2)) / 24);
966 /* only change the mouse focus to a selectable item */
967 if ((items[new_active_item]->kind != MN_HL)
968 && (items[new_active_item]->kind != MN_LABEL)
969 && (items[new_active_item]->kind != MN_INACTIVE))
970 active_item = new_active_item;
972 if(MouseCursor::current())
973 MouseCursor::current()->set_state(MC_LINK);
977 if(MouseCursor::current())
978 MouseCursor::current()->set_state(MC_NORMAL);
989 Menu::set_active_item(int id)
991 for(size_t i = 0; i < items.size(); ++i) {
992 MenuItem* item = items[i];