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) :
183 MenuItem::change_text(const std::string& text_)
189 MenuItem::change_input(const std::string& text_)
195 MenuItem::set_help(const std::string& help_text)
197 std::string overflow;
198 help = normal_font->wrap_to_width(help_text, 600, &overflow);
199 while (!overflow.empty())
202 help += normal_font->wrap_to_width(overflow, 600, &overflow);
206 std::string MenuItem::get_input_with_symbol(bool active_item)
209 input_flickering = true;
211 input_flickering = ((int) (real_time / FLICK_CURSOR_TIME)) % 2;
216 snprintf(str, sizeof(str), "%s ",input.c_str());
218 snprintf(str, sizeof(str), "%s_",input.c_str());
220 std::string string = str;
227 all_menus.remove(this);
229 for(std::vector<MenuItem*>::iterator i = items.begin();
230 i != items.end(); ++i)
236 if (previous == this)
260 all_menus.push_back(this);
263 menuaction = MENU_ACTION_NONE;
264 delete_character = 0;
265 mn_input_char = '\0';
267 pos_x = SCREEN_WIDTH/2;
268 pos_y = SCREEN_HEIGHT/2;
272 effect_progress = 0.0f;
273 effect_start_time = 0.0f;
275 checkbox.reset(new Surface("images/engine/menu/checkbox-unchecked.png"));
276 checkbox_checked.reset(new Surface("images/engine/menu/checkbox-checked.png"));
277 back.reset(new Surface("images/engine/menu/arrow-back.png"));
278 arrow_left.reset(new Surface("images/engine/menu/arrow-left.png"));
279 arrow_right.reset(new Surface("images/engine/menu/arrow-right.png"));
283 Menu::set_pos(float x, float y, float rw, float rh)
285 pos_x = x + get_width() * rw;
286 pos_y = y + get_height() * rh;
289 /* Add an item to a menu */
291 Menu::additem(MenuItem* item)
293 items.push_back(item);
295 /* If a new menu is being built, the active item shouldn't be set to
296 * something that isn't selectable. Set the active_item to the first
297 * selectable item added.
299 if (active_item == -1
300 && item->kind != MN_HL
301 && item->kind != MN_LABEL
302 && item->kind != MN_INACTIVE) {
303 active_item = items.size() - 1;
310 MenuItem* item = new MenuItem(MN_HL);
316 Menu::add_label(const std::string& text)
318 MenuItem* item = new MenuItem(MN_LABEL);
325 Menu::add_controlfield(int id, const std::string& text,
326 const std::string& mapping)
328 MenuItem* item = new MenuItem(MN_CONTROLFIELD, id);
329 item->change_text(text);
330 item->change_input(mapping);
336 Menu::add_entry(int id, const std::string& text)
338 MenuItem* item = new MenuItem(MN_ACTION, id);
345 Menu::add_inactive(int id, const std::string& text)
347 MenuItem* item = new MenuItem(MN_INACTIVE, id);
354 Menu::add_toggle(int id, const std::string& text, bool toogled)
356 MenuItem* item = new MenuItem(MN_TOGGLE, id);
358 item->toggled = toogled;
364 Menu::add_string_select(int id, const std::string& text)
366 MenuItem* item = new MenuItem(MN_STRINGSELECT, id);
373 Menu::add_back(const std::string& text)
375 MenuItem* item = new MenuItem(MN_BACK);
382 Menu::add_submenu(const std::string& text, Menu* submenu, int id)
384 MenuItem* item = new MenuItem(MN_GOTO, id);
386 item->target_menu = submenu;
394 for(std::vector<MenuItem*>::iterator i = items.begin();
395 i != items.end(); ++i) {
402 /* Process actions done on the menu */
406 int menu_height = (int) get_height();
407 if (menu_height > SCREEN_HEIGHT)
409 int scroll_offset = (menu_height - SCREEN_HEIGHT) / 2 + 32;
410 pos_y = SCREEN_HEIGHT/2 - scroll_offset * ((float(active_item) / (items.size()-1)) - 0.5f) * 2.0f;
413 effect_progress = (real_time - effect_start_time) * 6.0f;
415 if(effect_progress >= 1.0f) {
416 effect_progress = 1.0f;
423 else if (effect_progress <= 0.0f) {
424 effect_progress = 0.0f;
427 /** check main input controller... */
428 if(g_main_controller->pressed(Controller::UP)) {
429 menuaction = MENU_ACTION_UP;
430 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
432 if(g_main_controller->hold(Controller::UP) &&
433 menu_repeat_time != 0 && real_time > menu_repeat_time) {
434 menuaction = MENU_ACTION_UP;
435 menu_repeat_time = real_time + MENU_REPEAT_RATE;
438 if(g_main_controller->pressed(Controller::DOWN)) {
439 menuaction = MENU_ACTION_DOWN;
440 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
442 if(g_main_controller->hold(Controller::DOWN) &&
443 menu_repeat_time != 0 && real_time > menu_repeat_time) {
444 menuaction = MENU_ACTION_DOWN;
445 menu_repeat_time = real_time + MENU_REPEAT_RATE;
448 if(g_main_controller->pressed(Controller::LEFT)) {
449 menuaction = MENU_ACTION_LEFT;
450 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
452 if(g_main_controller->hold(Controller::LEFT) &&
453 menu_repeat_time != 0 && real_time > menu_repeat_time) {
454 menuaction = MENU_ACTION_LEFT;
455 menu_repeat_time = real_time + MENU_REPEAT_RATE;
458 if(g_main_controller->pressed(Controller::RIGHT)) {
459 menuaction = MENU_ACTION_RIGHT;
460 menu_repeat_time = real_time + MENU_REPEAT_INITIAL;
462 if(g_main_controller->hold(Controller::RIGHT) &&
463 menu_repeat_time != 0 && real_time > menu_repeat_time) {
464 menuaction = MENU_ACTION_RIGHT;
465 menu_repeat_time = real_time + MENU_REPEAT_RATE;
468 if(g_main_controller->pressed(Controller::ACTION)
469 || g_main_controller->pressed(Controller::MENU_SELECT)) {
470 menuaction = MENU_ACTION_HIT;
472 if(g_main_controller->pressed(Controller::PAUSE_MENU)) {
473 menuaction = MENU_ACTION_BACK;
477 if(items.size() == 0)
480 int last_active_item = active_item;
487 active_item = int(items.size())-1;
488 } while ((items[active_item]->kind == MN_HL
489 || items[active_item]->kind == MN_LABEL
490 || items[active_item]->kind == MN_INACTIVE)
491 && (active_item != last_active_item));
495 case MENU_ACTION_DOWN:
497 if(active_item < int(items.size())-1 )
501 } while ((items[active_item]->kind == MN_HL
502 || items[active_item]->kind == MN_LABEL
503 || items[active_item]->kind == MN_INACTIVE)
504 && (active_item != last_active_item));
508 case MENU_ACTION_LEFT:
509 if(items[active_item]->kind == MN_STRINGSELECT) {
510 if(items[active_item]->selected > 0)
511 items[active_item]->selected--;
513 items[active_item]->selected = items[active_item]->list.size()-1;
515 menu_action(items[active_item]);
519 case MENU_ACTION_RIGHT:
520 if(items[active_item]->kind == MN_STRINGSELECT) {
521 if(items[active_item]->selected+1 < items[active_item]->list.size())
522 items[active_item]->selected++;
524 items[active_item]->selected = 0;
526 menu_action(items[active_item]);
530 case MENU_ACTION_HIT: {
531 hit_item = active_item;
532 switch (items[active_item]->kind) {
534 assert(items[active_item]->target_menu != 0);
535 Menu::push_current(items[active_item]->target_menu);
539 items[active_item]->toggled = !items[active_item]->toggled;
540 menu_action(items[active_item]);
543 case MN_CONTROLFIELD:
544 menu_action(items[active_item]);
548 menu_action(items[active_item]);
551 case MN_STRINGSELECT:
552 if(items[active_item]->selected+1 < items[active_item]->list.size())
553 items[active_item]->selected++;
555 items[active_item]->selected = 0;
557 menu_action(items[active_item]);
562 menuaction = MENU_ACTION_DOWN;
575 case MENU_ACTION_REMOVE:
576 if(items[active_item]->kind == MN_TEXTFIELD
577 || items[active_item]->kind == MN_NUMFIELD)
579 if(!items[active_item]->input.empty())
581 int i = items[active_item]->input.size();
583 while(delete_character > 0) /* remove characters */
585 items[active_item]->input.resize(i-1);
592 case MENU_ACTION_INPUT:
593 if(items[active_item]->kind == MN_TEXTFIELD
594 || (items[active_item]->kind == MN_NUMFIELD
595 && mn_input_char >= '0' && mn_input_char <= '9'))
597 items[active_item]->input.push_back(mn_input_char);
601 case MENU_ACTION_BACK:
605 case MENU_ACTION_NONE:
608 menuaction = MENU_ACTION_NONE;
610 assert(active_item < int(items.size()));
616 if (hit_item != -1) {
617 int id = items[hit_item]->id;
618 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)
626 Menu::menu_action(MenuItem* )
630 Menu::draw_item(DrawingContext& context, int index)
632 float menu_height = get_height();
633 float menu_width = get_width();
635 MenuItem& pitem = *(items[index]);
637 Color text_color = default_color;
639 float y_pos = pos_y + 24*index - menu_height/2 + 12;
641 int text_width = int(normal_font->get_text_width(pitem.text));
642 int input_width = int(normal_font->get_text_width(pitem.input) + 10);
645 float left = pos_x - menu_width/2 + 16;
646 float right = pos_x + menu_width/2 - 16;
648 if(pitem.list.size() > 0) {
649 list_width = (int) normal_font->get_text_width(pitem.list[pitem.selected]);
653 x_pos += 24 - menu_width/2 + (text_width + input_width + list_width)/2;
655 if(index == active_item)
658 text_color = active_color;
661 if(active_item == index)
663 float blink = (sinf(real_time * M_PI * 1.0f)/2.0f + 0.5f) * 0.5f + 0.25f;
664 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2 + 10 - 2, y_pos - 12 - 2),
665 Vector(pos_x + menu_width/2 - 10 + 2, y_pos + 12 + 2)),
666 Color(1.0f, 1.0f, 1.0f, blink),
669 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2 + 10, y_pos - 12),
670 Vector(pos_x + menu_width/2 - 10, y_pos + 12)),
671 Color(1.0f, 1.0f, 1.0f, 0.5f),
680 context.draw_text(normal_font, pitem.text,
681 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
682 ALIGN_CENTER, LAYER_GUI, inactive_color);
689 float x = pos_x - menu_width/2;
690 float y = y_pos - 12;
691 /* Draw a horizontal line with a little 3d effect */
692 context.draw_filled_rect(Vector(x, y + 6),
693 Vector(menu_width, 4),
694 Color(0.6f, 0.7f, 1.0f, 1.0f), LAYER_GUI);
695 context.draw_filled_rect(Vector(x, y + 6),
696 Vector(menu_width, 2),
697 Color(1.0f, 1.0f, 1.0f, 1.0f), LAYER_GUI);
702 context.draw_text(big_font, pitem.text,
703 Vector(pos_x, y_pos - int(big_font->get_height()/2)),
704 ALIGN_CENTER, LAYER_GUI, label_color);
709 case MN_CONTROLFIELD:
711 if(pitem.kind == MN_TEXTFIELD || pitem.kind == MN_NUMFIELD)
713 if(active_item == index)
714 context.draw_text(normal_font,
715 pitem.get_input_with_symbol(true),
716 Vector(right, y_pos - int(normal_font->get_height()/2)),
717 ALIGN_RIGHT, LAYER_GUI, field_color);
719 context.draw_text(normal_font,
720 pitem.get_input_with_symbol(false),
721 Vector(right, y_pos - int(normal_font->get_height()/2)),
722 ALIGN_RIGHT, LAYER_GUI, field_color);
725 context.draw_text(normal_font, pitem.input,
726 Vector(right, y_pos - int(normal_font->get_height()/2)),
727 ALIGN_RIGHT, LAYER_GUI, field_color);
729 context.draw_text(normal_font, pitem.text,
730 Vector(left, y_pos - int(normal_font->get_height()/2)),
731 ALIGN_LEFT, LAYER_GUI, text_color);
734 case MN_STRINGSELECT:
736 float roff = arrow_left->get_width();
738 context.draw_text(normal_font, pitem.text,
739 Vector(left, y_pos - int(normal_font->get_height()/2)),
740 ALIGN_LEFT, LAYER_GUI, text_color);
743 context.draw_surface(arrow_left.get(),
744 Vector(right - list_width - roff - roff, y_pos - 8),
746 context.draw_surface(arrow_right.get(),
747 Vector(right - roff, y_pos - 8),
749 context.draw_text(normal_font, pitem.list[pitem.selected],
750 Vector(right - roff, y_pos - int(normal_font->get_height()/2)),
751 ALIGN_RIGHT, LAYER_GUI, text_color);
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);
759 context.draw_surface(back.get(),
760 Vector(x_pos + text_width/2 + 16, y_pos - 8),
767 context.draw_text(normal_font, pitem.text,
768 Vector(pos_x - menu_width/2 + 16, y_pos - (normal_font->get_height()/2)),
769 ALIGN_LEFT, LAYER_GUI, text_color);
772 context.draw_surface(checkbox_checked.get(),
773 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
776 context.draw_surface(checkbox.get(),
777 Vector(x_pos + (menu_width/2-16) - checkbox->get_width(), y_pos - 8),
782 context.draw_text(normal_font, pitem.text,
783 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
784 ALIGN_CENTER, LAYER_GUI, text_color);
788 context.draw_text(normal_font, pitem.text,
789 Vector(pos_x, y_pos - int(normal_font->get_height()/2)),
790 ALIGN_CENTER, LAYER_GUI, text_color);
796 Menu::get_width() const
798 /* The width of the menu has to be more than the width of the text
799 with the most characters */
800 float menu_width = 0;
801 for(unsigned int i = 0; i < items.size(); ++i)
803 Font* font = normal_font;
804 if(items[i]->kind == MN_LABEL)
807 float w = font->get_text_width(items[i]->text) +
808 big_font->get_text_width(items[i]->input) + 16;
809 if(items[i]->kind == MN_TOGGLE)
816 return menu_width + 24;
820 Menu::get_height() const
822 return items.size() * 24;
825 /* Draw the current menu. */
827 Menu::draw(DrawingContext& context)
829 if(MouseCursor::current()) {
830 MouseCursor::current()->draw(context);
833 float menu_width = get_width();
834 float menu_height = get_height();
836 if (effect_progress != 1.0f)
840 menu_width = (current_->get_width() * (1.0f - effect_progress));
841 menu_height = (current_->get_height() * (1.0f - effect_progress));
843 else if (Menu::previous)
845 menu_width = (menu_width * effect_progress) + (Menu::previous->get_width() * (1.0f - effect_progress));
846 menu_height = (menu_height * effect_progress) + (Menu::previous->get_height() * (1.0f - effect_progress));
847 //std::cout << effect_progress << " " << this << " " << last_menus.back() << std::endl;
851 menu_width *= effect_progress;
852 menu_height *= effect_progress;
856 /* Draw a transparent background */
857 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2-4, pos_y - menu_height/2 - 10-4),
858 Vector(pos_x + menu_width/2+4, pos_y - menu_height/2 + 10 + menu_height+4)),
859 Color(0.2f, 0.3f, 0.4f, 0.8f),
863 context.draw_filled_rect(Rect(Vector(pos_x - menu_width/2, pos_y - menu_height/2 - 10),
864 Vector(pos_x + menu_width/2, pos_y - menu_height/2 + 10 + menu_height)),
865 Color(0.6f, 0.7f, 0.8f, 0.5f),
869 if (!items[active_item]->help.empty())
871 int text_width = (int) normal_font->get_text_width(items[active_item]->help);
872 int text_height = (int) normal_font->get_text_height(items[active_item]->help);
874 Rect text_rect(pos_x - text_width/2 - 8,
875 SCREEN_HEIGHT - 48 - text_height/2 - 4,
876 pos_x + text_width/2 + 8,
877 SCREEN_HEIGHT - 48 + text_height/2 + 4);
879 context.draw_filled_rect(Rect(text_rect.p1 - Vector(4,4),
880 text_rect.p2 + Vector(4,4)),
881 Color(0.2f, 0.3f, 0.4f, 0.8f),
885 context.draw_filled_rect(text_rect,
886 Color(0.6f, 0.7f, 0.8f, 0.5f),
890 context.draw_text(normal_font, items[active_item]->help,
891 Vector(pos_x, SCREEN_HEIGHT - 48 - text_height/2),
892 ALIGN_CENTER, LAYER_GUI);
895 if (effect_progress == 1.0f)
896 for(unsigned int i = 0; i < items.size(); ++i)
898 draw_item(context, i);
903 Menu::get_item_by_id(int id)
905 for(std::vector<MenuItem*>::iterator i = items.begin();
906 i != items.end(); ++i) {
907 MenuItem& item = **i;
913 throw std::runtime_error("MenuItem not found");
917 Menu::get_item_by_id(int id) const
919 for(std::vector<MenuItem*>::const_iterator i = items.begin();
920 i != items.end(); ++i) {
921 const MenuItem& item = **i;
927 throw std::runtime_error("MenuItem not found");
930 int Menu::get_active_item_id()
932 return items[active_item]->id;
936 Menu::is_toggled(int id) const
938 return get_item_by_id(id).toggled;
942 Menu::set_toggled(int id, bool toggled)
944 get_item_by_id(id).toggled = toggled;
948 Menu::get_parent() const
950 if (last_menus.empty())
953 return last_menus.back();
956 /* Check for menu event */
958 Menu::event(const SDL_Event& event)
960 if(effect_progress != 1.0f)
964 case SDL_MOUSEBUTTONDOWN:
966 int x = int(event.motion.x * float(SCREEN_WIDTH)/g_screen->w);
967 int y = int(event.motion.y * float(SCREEN_HEIGHT)/g_screen->h);
969 if(x > pos_x - get_width()/2 &&
970 x < pos_x + get_width()/2 &&
971 y > pos_y - get_height()/2 &&
972 y < pos_y + get_height()/2)
974 menuaction = MENU_ACTION_HIT;
979 case SDL_MOUSEMOTION:
981 float x = event.motion.x * SCREEN_WIDTH/g_screen->w;
982 float y = event.motion.y * SCREEN_HEIGHT/g_screen->h;
984 if(x > pos_x - get_width()/2 &&
985 x < pos_x + get_width()/2 &&
986 y > pos_y - get_height()/2 &&
987 y < pos_y + get_height()/2)
990 = static_cast<int> ((y - (pos_y - get_height()/2)) / 24);
992 /* only change the mouse focus to a selectable item */
993 if ((items[new_active_item]->kind != MN_HL)
994 && (items[new_active_item]->kind != MN_LABEL)
995 && (items[new_active_item]->kind != MN_INACTIVE))
996 active_item = new_active_item;
998 if(MouseCursor::current())
999 MouseCursor::current()->set_state(MC_LINK);
1003 if(MouseCursor::current())
1004 MouseCursor::current()->set_state(MC_NORMAL);
1015 Menu::set_active_item(int id)
1017 for(size_t i = 0; i < items.size(); ++i) {
1018 MenuItem* item = items[i];
1019 if(item->id == id) {