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) :
182 MenuItem::change_text(const std::string& text_)
188 MenuItem::change_input(const std::string& text_)
194 MenuItem::set_help(const std::string& help_text)
196 std::string overflow;
197 help = normal_font->wrap_to_width(help_text, 600, &overflow);
198 while (!overflow.empty())
201 help += normal_font->wrap_to_width(overflow, 600, &overflow);
205 std::string MenuItem::get_input_with_symbol(bool active_item)
208 input_flickering = true;
210 input_flickering = ((int) (real_time / FLICK_CURSOR_TIME)) % 2;
215 snprintf(str, sizeof(str), "%s ",input.c_str());
217 snprintf(str, sizeof(str), "%s_",input.c_str());
219 std::string string = str;
226 all_menus.remove(this);
228 for(std::vector<MenuItem*>::iterator i = items.begin();
229 i != items.end(); ++i)
235 if (previous == this)
259 all_menus.push_back(this);
262 menuaction = MENU_ACTION_NONE;
263 delete_character = 0;
264 mn_input_char = '\0';
266 pos_x = SCREEN_WIDTH/2;
267 pos_y = SCREEN_HEIGHT/2;
271 effect_progress = 0.0f;
272 effect_start_time = 0.0f;
274 checkbox.reset(new Surface("images/engine/menu/checkbox-unchecked.png"));
275 checkbox_checked.reset(new Surface("images/engine/menu/checkbox-checked.png"));
276 back.reset(new Surface("images/engine/menu/arrow-back.png"));
277 arrow_left.reset(new Surface("images/engine/menu/arrow-left.png"));
278 arrow_right.reset(new Surface("images/engine/menu/arrow-right.png"));
282 Menu::set_pos(float x, float y, float rw, float rh)
284 pos_x = x + get_width() * rw;
285 pos_y = y + get_height() * rh;
288 /* Add an item to a menu */
290 Menu::additem(MenuItem* item)
292 items.push_back(item);
294 /* If a new menu is being built, the active item shouldn't be set to
295 * something that isn't selectable. Set the active_item to the first
296 * selectable item added.
298 if (active_item == -1
299 && item->kind != MN_HL
300 && item->kind != MN_LABEL
301 && item->kind != MN_INACTIVE) {
302 active_item = items.size() - 1;
309 MenuItem* item = new MenuItem(MN_HL);
315 Menu::add_label(const std::string& text)
317 MenuItem* item = new MenuItem(MN_LABEL);
324 Menu::add_controlfield(int id, const std::string& text,
325 const std::string& mapping)
327 MenuItem* item = new MenuItem(MN_CONTROLFIELD, id);
328 item->change_text(text);
329 item->change_input(mapping);
335 Menu::add_entry(int id, const std::string& text)
337 MenuItem* item = new MenuItem(MN_ACTION, id);
344 Menu::add_inactive(int id, const std::string& text)
346 MenuItem* item = new MenuItem(MN_INACTIVE, id);
353 Menu::add_toggle(int id, const std::string& text, bool toogled)
355 MenuItem* item = new MenuItem(MN_TOGGLE, id);
357 item->toggled = toogled;
363 Menu::add_string_select(int id, const std::string& text)
365 MenuItem* item = new MenuItem(MN_STRINGSELECT, id);
372 Menu::add_back(const std::string& text)
374 MenuItem* item = new MenuItem(MN_BACK);
381 Menu::add_submenu(const std::string& text, Menu* submenu, int id)
383 MenuItem* item = new MenuItem(MN_GOTO, id);
385 item->target_menu = submenu;
393 for(std::vector<MenuItem*>::iterator i = items.begin();
394 i != items.end(); ++i) {
401 /* Process actions done on the menu */
405 int menu_height = (int) get_height();
406 if (menu_height > SCREEN_HEIGHT)
408 int scroll_offset = (menu_height - SCREEN_HEIGHT) / 2 + 32;
409 pos_y = SCREEN_HEIGHT/2 - scroll_offset * ((float(active_item) / (items.size()-1)) - 0.5f) * 2.0f;
412 effect_progress = (real_time - effect_start_time) * 6.0f;
414 if(effect_progress >= 1.0f) {
415 effect_progress = 1.0f;
422 else if (effect_progress <= 0.0f) {
423 effect_progress = 0.0f;
426 /** check main input controller... */
427 if(g_main_controller->pressed(Controller::UP)) {
428 menuaction = MENU_ACTION_UP;
429 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
431 if(g_main_controller->hold(Controller::UP) &&
432 menu_repeat_time != 0 && real_time > menu_repeat_time) {
433 menuaction = MENU_ACTION_UP;
434 menu_repeat_time = real_time + MENU_REPEAT_RATE;
437 if(g_main_controller->pressed(Controller::DOWN)) {
438 menuaction = MENU_ACTION_DOWN;
439 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
441 if(g_main_controller->hold(Controller::DOWN) &&
442 menu_repeat_time != 0 && real_time > menu_repeat_time) {
443 menuaction = MENU_ACTION_DOWN;
444 menu_repeat_time = real_time + MENU_REPEAT_RATE;
447 if(g_main_controller->pressed(Controller::LEFT)) {
448 menuaction = MENU_ACTION_LEFT;
449 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
451 if(g_main_controller->hold(Controller::LEFT) &&
452 menu_repeat_time != 0 && real_time > menu_repeat_time) {
453 menuaction = MENU_ACTION_LEFT;
454 menu_repeat_time = real_time + MENU_REPEAT_RATE;
457 if(g_main_controller->pressed(Controller::RIGHT)) {
458 menuaction = MENU_ACTION_RIGHT;
459 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
461 if(g_main_controller->hold(Controller::RIGHT) &&
462 menu_repeat_time != 0 && real_time > menu_repeat_time) {
463 menuaction = MENU_ACTION_RIGHT;
464 menu_repeat_time = real_time + MENU_REPEAT_RATE;
467 if(g_main_controller->pressed(Controller::ACTION)
468 || g_main_controller->pressed(Controller::MENU_SELECT)) {
469 menuaction = MENU_ACTION_HIT;
471 if(g_main_controller->pressed(Controller::PAUSE_MENU)) {
472 menuaction = MENU_ACTION_BACK;
476 if(items.size() == 0)
479 int last_active_item = active_item;
486 active_item = int(items.size())-1;
487 } while ((items[active_item]->kind == MN_HL
488 || items[active_item]->kind == MN_LABEL
489 || items[active_item]->kind == MN_INACTIVE)
490 && (active_item != last_active_item));
494 case MENU_ACTION_DOWN:
496 if(active_item < int(items.size())-1 )
500 } while ((items[active_item]->kind == MN_HL
501 || items[active_item]->kind == MN_LABEL
502 || items[active_item]->kind == MN_INACTIVE)
503 && (active_item != last_active_item));
507 case MENU_ACTION_LEFT:
508 if(items[active_item]->kind == MN_STRINGSELECT) {
509 if(items[active_item]->selected > 0)
510 items[active_item]->selected--;
512 items[active_item]->selected = items[active_item]->list.size()-1;
514 menu_action(items[active_item]);
518 case MENU_ACTION_RIGHT:
519 if(items[active_item]->kind == MN_STRINGSELECT) {
520 if(items[active_item]->selected+1 < items[active_item]->list.size())
521 items[active_item]->selected++;
523 items[active_item]->selected = 0;
525 menu_action(items[active_item]);
529 case MENU_ACTION_HIT: {
530 hit_item = active_item;
531 switch (items[active_item]->kind) {
533 assert(items[active_item]->target_menu != 0);
534 Menu::push_current(items[active_item]->target_menu);
538 items[active_item]->toggled = !items[active_item]->toggled;
539 menu_action(items[active_item]);
542 case MN_CONTROLFIELD:
543 menu_action(items[active_item]);
547 menu_action(items[active_item]);
550 case MN_STRINGSELECT:
551 if(items[active_item]->selected+1 < items[active_item]->list.size())
552 items[active_item]->selected++;
554 items[active_item]->selected = 0;
556 menu_action(items[active_item]);
561 menuaction = MENU_ACTION_DOWN;
574 case MENU_ACTION_REMOVE:
575 if(items[active_item]->kind == MN_TEXTFIELD
576 || items[active_item]->kind == MN_NUMFIELD)
578 if(!items[active_item]->input.empty())
580 int i = items[active_item]->input.size();
582 while(delete_character > 0) /* remove characters */
584 items[active_item]->input.resize(i-1);
591 case MENU_ACTION_INPUT:
592 if(items[active_item]->kind == MN_TEXTFIELD
593 || (items[active_item]->kind == MN_NUMFIELD
594 && mn_input_char >= '0' && mn_input_char <= '9'))
596 items[active_item]->input.push_back(mn_input_char);
600 case MENU_ACTION_BACK:
604 case MENU_ACTION_NONE:
607 menuaction = MENU_ACTION_NONE;
609 assert(active_item < int(items.size()));
615 if (hit_item != -1) {
616 int id = items[hit_item]->id;
617 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)
625 Menu::menu_action(MenuItem* )
629 Menu::draw_item(DrawingContext& context, int index)
631 float menu_height = get_height();
632 float menu_width = get_width();
634 MenuItem& pitem = *(items[index]);
636 Color text_color = default_color;
638 float y_pos = pos_y + 24*index - menu_height/2 + 12;
640 int text_width = int(normal_font->get_text_width(pitem.text));
641 int input_width = int(normal_font->get_text_width(pitem.input) + 10);
644 float left = pos_x - menu_width/2 + 16;
645 float right = pos_x + menu_width/2 - 16;
647 if(pitem.list.size() > 0) {
648 list_width = (int) normal_font->get_text_width(pitem.list[pitem.selected]);
652 x_pos += 24 - menu_width/2 + (text_width + input_width + list_width)/2;
654 if(index == active_item)
657 text_color = active_color;
660 if(active_item == index)
662 float blink = (sinf(real_time * M_PI * 1.0f)/2.0f + 0.5f) * 0.5f + 0.25f;
663 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2 + 10 - 2, y_pos - 12 - 2),
664 Vector(pos_x + menu_width/2 - 10 + 2, y_pos + 12 + 2)),
665 Color(1.0f, 1.0f, 1.0f, blink),
668 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2 + 10, y_pos - 12),
669 Vector(pos_x + menu_width/2 - 10, y_pos + 12)),
670 Color(1.0f, 1.0f, 1.0f, 0.5f),
679 context.draw_text(normal_font, pitem.text,
680 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
681 ALIGN_CENTER, LAYER_GUI, inactive_color);
688 float x = pos_x - menu_width/2;
689 float y = y_pos - 12;
690 /* Draw a horizontal line with a little 3d effect */
691 context.draw_filled_rect(Vector(x, y + 6),
692 Vector(menu_width, 4),
693 Color(0.6f, 0.7f, 1.0f, 1.0f), LAYER_GUI);
694 context.draw_filled_rect(Vector(x, y + 6),
695 Vector(menu_width, 2),
696 Color(1.0f, 1.0f, 1.0f, 1.0f), LAYER_GUI);
701 context.draw_text(big_font, pitem.text,
702 Vector(pos_x, y_pos - int(big_font->get_height()/2)),
703 ALIGN_CENTER, LAYER_GUI, label_color);
708 case MN_CONTROLFIELD:
710 if(pitem.kind == MN_TEXTFIELD || pitem.kind == MN_NUMFIELD)
712 if(active_item == index)
713 context.draw_text(normal_font,
714 pitem.get_input_with_symbol(true),
715 Vector(right, y_pos - int(normal_font->get_height()/2)),
716 ALIGN_RIGHT, LAYER_GUI, field_color);
718 context.draw_text(normal_font,
719 pitem.get_input_with_symbol(false),
720 Vector(right, y_pos - int(normal_font->get_height()/2)),
721 ALIGN_RIGHT, LAYER_GUI, field_color);
724 context.draw_text(normal_font, pitem.input,
725 Vector(right, y_pos - int(normal_font->get_height()/2)),
726 ALIGN_RIGHT, LAYER_GUI, field_color);
728 context.draw_text(normal_font, pitem.text,
729 Vector(left, y_pos - int(normal_font->get_height()/2)),
730 ALIGN_LEFT, LAYER_GUI, text_color);
733 case MN_STRINGSELECT:
735 float roff = arrow_left->get_width();
737 context.draw_text(normal_font, pitem.text,
738 Vector(left, y_pos - int(normal_font->get_height()/2)),
739 ALIGN_LEFT, LAYER_GUI, text_color);
742 context.draw_surface(arrow_left.get(),
743 Vector(right - list_width - roff - roff, y_pos - 8),
745 context.draw_surface(arrow_right.get(),
746 Vector(right - roff, y_pos - 8),
748 context.draw_text(normal_font, pitem.list[pitem.selected],
749 Vector(right - roff, y_pos - int(normal_font->get_height()/2)),
750 ALIGN_RIGHT, LAYER_GUI, text_color);
755 context.draw_text(normal_font, pitem.text,
756 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
757 ALIGN_CENTER, LAYER_GUI, text_color);
758 context.draw_surface(back.get(),
759 Vector(x_pos + text_width/2 + 16, y_pos - 8),
766 context.draw_text(normal_font, pitem.text,
767 Vector(pos_x - menu_width/2 + 16, y_pos - (normal_font->get_height()/2)),
768 ALIGN_LEFT, LAYER_GUI, text_color);
771 context.draw_surface(checkbox_checked.get(),
772 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
775 context.draw_surface(checkbox.get(),
776 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
781 context.draw_text(normal_font, pitem.text,
782 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
783 ALIGN_CENTER, LAYER_GUI, text_color);
787 context.draw_text(normal_font, pitem.text,
788 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
789 ALIGN_CENTER, LAYER_GUI, text_color);
795 Menu::get_width() const
797 /* The width of the menu has to be more than the width of the text
798 with the most characters */
799 float menu_width = 0;
800 for(unsigned int i = 0; i < items.size(); ++i)
802 Font* font = normal_font;
803 if(items[i]->kind == MN_LABEL)
806 float w = font->get_text_width(items[i]->text) +
807 big_font->get_text_width(items[i]->input) + 16;
808 if(items[i]->kind == MN_TOGGLE)
815 return menu_width + 24;
819 Menu::get_height() const
821 return items.size() * 24;
824 /* Draw the current menu. */
826 Menu::draw(DrawingContext& context)
828 if(MouseCursor::current()) {
829 MouseCursor::current()->draw(context);
832 float menu_width = get_width();
833 float menu_height = get_height();
835 if (effect_progress != 1.0f)
839 menu_width = (current_->get_width() * (1.0f - effect_progress));
840 menu_height = (current_->get_height() * (1.0f - effect_progress));
842 else if (Menu::previous)
844 menu_width = (menu_width * effect_progress) + (Menu::previous->get_width() * (1.0f - effect_progress));
845 menu_height = (menu_height * effect_progress) + (Menu::previous->get_height() * (1.0f - effect_progress));
846 //std::cout << effect_progress << " " << this << " " << last_menus.back() << std::endl;
850 menu_width *= effect_progress;
851 menu_height *= effect_progress;
855 /* Draw a transparent background */
856 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2-4, pos_y - menu_height/2 - 10-4),
857 Vector(pos_x + menu_width/2+4, pos_y - menu_height/2 + 10 + menu_height+4)),
858 Color(0.2f, 0.3f, 0.4f, 0.8f),
862 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2, pos_y - menu_height/2 - 10),
863 Vector(pos_x + menu_width/2, pos_y - menu_height/2 + 10 + menu_height)),
864 Color(0.6f, 0.7f, 0.8f, 0.5f),
868 if (!items[active_item]->help.empty())
870 int text_width = (int) normal_font->get_text_width(items[active_item]->help);
871 int text_height = (int) normal_font->get_text_height(items[active_item]->help);
873 Rect text_rect(pos_x - text_width/2 - 8,
874 SCREEN_HEIGHT - 48 - text_height/2 - 4,
875 pos_x + text_width/2 + 8,
876 SCREEN_HEIGHT - 48 + text_height/2 + 4);
878 context.draw_filled_rect(Rect(text_rect.p1 - Vector(4,4),
879 text_rect.p2 + Vector(4,4)),
880 Color(0.2f, 0.3f, 0.4f, 0.8f),
884 context.draw_filled_rect(text_rect,
885 Color(0.6f, 0.7f, 0.8f, 0.5f),
889 context.draw_text(normal_font, items[active_item]->help,
890 Vector(pos_x, SCREEN_HEIGHT - 48 - text_height/2),
891 ALIGN_CENTER, LAYER_GUI);
894 if (effect_progress == 1.0f)
895 for(unsigned int i = 0; i < items.size(); ++i)
897 draw_item(context, i);
902 Menu::get_item_by_id(int id)
904 for(std::vector<MenuItem*>::iterator i = items.begin();
905 i != items.end(); ++i) {
906 MenuItem& item = **i;
912 throw std::runtime_error("MenuItem not found");
916 Menu::get_item_by_id(int id) const
918 for(std::vector<MenuItem*>::const_iterator i = items.begin();
919 i != items.end(); ++i) {
920 const MenuItem& item = **i;
926 throw std::runtime_error("MenuItem not found");
929 int Menu::get_active_item_id()
931 return items[active_item]->id;
935 Menu::is_toggled(int id) const
937 return get_item_by_id(id).toggled;
941 Menu::set_toggled(int id, bool toggled)
943 get_item_by_id(id).toggled = toggled;
947 Menu::get_parent() const
949 if (last_menus.empty())
952 return last_menus.back();
955 /* Check for menu event */
957 Menu::event(const SDL_Event& event)
959 if(effect_progress != 1.0f)
963 case SDL_MOUSEBUTTONDOWN:
965 int x = int(event.motion.x * float(SCREEN_WIDTH)/g_screen->w);
966 int y = int(event.motion.y * float(SCREEN_HEIGHT)/g_screen->h);
968 if(x > pos_x - get_width()/2 &&
969 x < pos_x + get_width()/2 &&
970 y > pos_y - get_height()/2 &&
971 y < pos_y + get_height()/2)
973 menuaction = MENU_ACTION_HIT;
978 case SDL_MOUSEMOTION:
980 float x = event.motion.x * SCREEN_WIDTH/g_screen->w;
981 float y = event.motion.y * SCREEN_HEIGHT/g_screen->h;
983 if(x > pos_x - get_width()/2 &&
984 x < pos_x + get_width()/2 &&
985 y > pos_y - get_height()/2 &&
986 y < pos_y + get_height()/2)
989 = static_cast<int> ((y - (pos_y - get_height()/2)) / 24);
991 /* only change the mouse focus to a selectable item */
992 if ((items[new_active_item]->kind != MN_HL)
993 && (items[new_active_item]->kind != MN_LABEL)
994 && (items[new_active_item]->kind != MN_INACTIVE))
995 active_item = new_active_item;
997 if(MouseCursor::current())
998 MouseCursor::current()->set_state(MC_LINK);
1002 if(MouseCursor::current())
1003 MouseCursor::current()->set_state(MC_NORMAL);
1014 Menu::set_active_item(int id)
1016 for(size_t i = 0; i < items.size(); ++i) {
1017 MenuItem* item = items[i];
1018 if(item->id == id) {