Rewrite and migrate `V` menu to ImGui #55503

mqrause · 2022-02-19T06:32:07Z

Summary

Infrastructure "Rewrite and migrate V menu to ImGui"

Purpose of change

Migrate to ImGui and increase maintainability and expandability.

Describe the solution

Completely remake everything using ImGui.
Structurally this is heavily reliant on code I wrote when I started this before ImGui two years ago. It might be a good idea to refactor some of that, but for now I mostly want to get it functional.

Describe alternatives you've considered

There is no alternative (except for implementation details).

Testing

Press V and play around with it.

Additional context

Currently wip. Some basic functionality is implemented, so interested people can check it out and give feedback. The terrain/furniture tab won't be a part of the final version of this PR but is going to be added in another one.

lgtm-com · 2022-02-20T14:02:40Z

This pull request introduces 3 alerts when merging 0bf3591 into f889ed9 - view on LGTM.com

new alerts:

3 for Empty branch of conditional

lgtm-com · 2022-02-21T08:32:43Z

This pull request introduces 3 alerts when merging cb976c3 into d055515 - view on LGTM.com

new alerts:

2 for Constant return type on member
1 for Empty branch of conditional

lgtm-com · 2022-02-21T15:47:43Z

This pull request introduces 1 alert when merging 8c02583 into 158205f - view on LGTM.com

new alerts:

1 for Empty branch of conditional

lgtm-com · 2022-08-16T10:18:13Z

This pull request introduces 1 alert when merging 2b47cda into 07d8e66 - view on LGTM.com

new alerts:

1 for Comparison result is always the same

lgtm-com · 2022-08-16T14:28:34Z

This pull request introduces 1 alert when merging 45e8b1e into 07d8e66 - view on LGTM.com

new alerts:

1 for Comparison result is always the same

stale · 2022-09-21T03:14:31Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. Please do not 'bump' or comment on this issue unless you are actively working on it. Stale issues, and stale issues that are closed are still considered.

Zireael07 · 2022-12-06T11:52:03Z

Do we have a 'salvageable' label for PRs?

mqrause · 2022-12-06T11:55:44Z

I think I just need to ask a maintainer to reopen it when I continue working on it.

github-actions · 2023-01-05T13:08:29Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. Please do not bump or comment on this issue unless you are actively working on it. Stale issues, and stale issues that are closed are still considered.

db48x

I‌ know that you’re not finished yet, but I like what you’re doing and want to help you get it right. Here are a few comments about things that I‌ noticed as I‌ read the code.

db48x · 2024-09-06T17:28:35Z

src/surroundings_menu.cpp

+                std::string text;
+                if( it->entities.size() > 1 ) {
+                    text = string_format( "[%d/%d] (%d) ", it->get_selected_index() + 1, it->entities.size(),
+                                          it->totalcount );
+                }
+
+                const int count = it->get_selected_count();
+                if( count > 1 ) {
+                    text += string_format( "%d ", count );
+                }
+
+                text += itm->display_name( count );
+                nc_color color = it->get_selected_entity()->color_in_inventory();
+                cataimgui::draw_colored_text( text, color );


Instead of allocating a string and appending a bunch of things to it (which can cause reallocation) before finally drawing the string, it would be better to simply call ImGui::Text, ImGui::TextUnformatted, or cataimgui::draw_colored_text for each element individually. You can arrange multiple items on the same line by calling ImGui::SameLine(0, 0). Remember that all of this happens on every frame, so it’s best to avoid allocation.

db48x · 2024-09-06T17:29:54Z

src/surroundings_menu.cpp

+                const Character &you = get_player_character();
+                const bool inattentive = you.has_trait( trait_INATTENTIVE );
+                bool sees = mon->sees( you ) && !inattentive;
+                cataimgui::draw_colored_text( sees ? "!" : " ", c_yellow );


When possible, prefer to just call ImGui::TextColored instead, as it does less work than cataimuig::draw_colored_text.

db48x · 2024-09-06T17:30:57Z

src/surroundings_menu.cpp

+                if( bar_width < bar_max_width ) {
+                    hp_text += "<color_c_white>";
+                    for( int i = bar_max_width - bar_width; i > 0; i-- ) {
+                        hp_text += ".";


Better to just call ImGui::TextUnformatted in a loop than to repeatedly append to a string.

db48x · 2024-09-06T17:32:51Z

src/surroundings_menu.cpp

+                cataimgui::draw_colored_text( att_text, att_color );
+
+                ImGui::TableNextColumn();
+                std::string dist_text = get_distance_string( tripoint_rel_ms(), *it->get_selected_pos() );


Is it possible for the distance or HP of the monster to change between frames here? I believe the game is paused while in this view, so they cannot. It would be really great then if you could store the formatted distance string and HP bar on the map_entity so that you only have to compute them once.

I‌ assume the same applies to all entity types, so I‌ won't call them out individually

db48x · 2024-09-06T17:43:57Z

src/surroundings_menu.cpp

+    switch( selected_tab ) {
+        case surroundings_menu_tab_enum::items:
+            item_data.selected_entry->select_next();
+            break;
+        case surroundings_menu_tab_enum::monsters:
+            monster_data.selected_entry->select_next();
+            break;
+        case surroundings_menu_tab_enum::terfurn:
+            terfurn_data.selected_entry->select_next();
+            break;
+        default:
+            debugmsg( "invalid tab selected" );
+    }


This and every other method here seem very verbose and duplicative. Perhaps something like this would be better:

tab_data list; switch( selected_tab ) { case surroundings_menu_tab_enum::items: list = item_data; break; case surroundings_menu_tab_enum::monsters: list = monster_data; break; case surroundings_menu_tab_enum::terfurn: list = terfurn_data; break; default: debugmsg( "invalid tab selected" ); } list.selected_entry->select_next();

They could be shortened further by putting the switch into a common method, perhaps called get_currently_selected_list. Then it would just be:

get_currently_selected_list().selected_entry->select_next();

mqrause · 2024-09-06T17:59:26Z

Yeah, it's still very WIP, but that's good feedback!

github-actions bot added json-styled JSON lint passed, label assigned by github actions astyled astyled PR, label is assigned by github actions labels Feb 19, 2022

mqrause force-pushed the vmenu_rewrite branch 7 times, most recently from b7854a4 to 121194d Compare February 19, 2022 07:57

NetSysFire added <Enhancement / Feature> New features, or enhancements on existing [C++] Changes (can be) made in C++. Previously named `Code` Info / User Interface Game - player communication, menus, etc. labels Feb 19, 2022

mqrause force-pushed the vmenu_rewrite branch from 121194d to b52ac09 Compare February 19, 2022 19:48

github-actions bot added the BasicBuildPassed This PR builds correctly, label assigned by github actions label Feb 19, 2022

mqrause force-pushed the vmenu_rewrite branch 2 times, most recently from 05357ce to 0bf3591 Compare February 20, 2022 10:12

github-actions bot removed the BasicBuildPassed This PR builds correctly, label assigned by github actions label Feb 20, 2022

mqrause force-pushed the vmenu_rewrite branch from 0bf3591 to cb976c3 Compare February 21, 2022 04:25

mqrause force-pushed the vmenu_rewrite branch from cb976c3 to 218a9a1 Compare February 21, 2022 08:46

github-actions bot added the BasicBuildPassed This PR builds correctly, label assigned by github actions label Feb 21, 2022

mqrause force-pushed the vmenu_rewrite branch 2 times, most recently from d39553d to 8c02583 Compare February 21, 2022 10:49

mqrause force-pushed the vmenu_rewrite branch 2 times, most recently from 590cff8 to 9e5eeb2 Compare February 25, 2022 15:02

github-actions bot removed the BasicBuildPassed This PR builds correctly, label assigned by github actions label Feb 25, 2022

mqrause force-pushed the vmenu_rewrite branch 2 times, most recently from 4618af9 to a73ed64 Compare February 25, 2022 19:13

github-actions bot removed the BasicBuildPassed This PR builds correctly, label assigned by github actions label Aug 16, 2022

mqrause force-pushed the vmenu_rewrite branch 2 times, most recently from d1771c6 to 2b47cda Compare August 16, 2022 07:18

github-actions bot added the BasicBuildPassed This PR builds correctly, label assigned by github actions label Aug 16, 2022

mqrause force-pushed the vmenu_rewrite branch from 2b47cda to 45e8b1e Compare August 16, 2022 11:33

github-actions bot removed the BasicBuildPassed This PR builds correctly, label assigned by github actions label Aug 16, 2022

stale bot added the stale Closed for lack of activity, but still valid. label Sep 21, 2022

github-actions bot closed this Dec 6, 2022

Night-Pryanik reopened this Dec 6, 2022

github-actions bot removed the stale Closed for lack of activity, but still valid. label Dec 6, 2022

github-actions bot added the stale Closed for lack of activity, but still valid. label Jan 5, 2023

Night-Pryanik added (P5 - Long-term) Long-term WIP, may stay on the list for a while. and removed stale Closed for lack of activity, but still valid. labels Jan 5, 2023

mqrause changed the title ~~[CR] Rewrite and expand the V menu~~ Rewrite and migrate V menu to ImGui Mar 11, 2024

mqrause force-pushed the vmenu_rewrite branch from 45e8b1e to de4d48d Compare March 11, 2024 09:41

mqrause mentioned this pull request Mar 13, 2024

Update ImGui window positions on every resize #72353

Merged

This was referenced May 1, 2024

Show NEW! in List Items menu #73400

Merged

Imgui iteminfo #73456

Merged

RenechCDDA mentioned this pull request May 4, 2024

Replace the old UI method for displaying various information in the right-side window of the game with a new implementation using imgui. #73497

Closed

rewrite V menu

d71a221

mqrause force-pushed the vmenu_rewrite branch from de4d48d to d71a221 Compare September 3, 2024 11:03

db48x suggested changes Sep 6, 2024

View reviewed changes

mqrause mentioned this pull request Sep 9, 2024

Migrate extended description (x->e) to imgui #76308

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite and migrate `V` menu to ImGui #55503

Rewrite and migrate `V` menu to ImGui #55503

mqrause commented Feb 19, 2022 •

edited

Loading

lgtm-com bot commented Feb 20, 2022

lgtm-com bot commented Feb 21, 2022

lgtm-com bot commented Feb 21, 2022

lgtm-com bot commented Aug 16, 2022

lgtm-com bot commented Aug 16, 2022

stale bot commented Sep 21, 2022

Zireael07 commented Dec 6, 2022

mqrause commented Dec 6, 2022

github-actions bot commented Jan 5, 2023

db48x left a comment

db48x Sep 6, 2024

db48x Sep 6, 2024

db48x Sep 6, 2024

db48x Sep 6, 2024

db48x Sep 6, 2024

mqrause commented Sep 6, 2024

Rewrite and migrate V menu to ImGui #55503

Are you sure you want to change the base?

Rewrite and migrate V menu to ImGui #55503

Conversation

mqrause commented Feb 19, 2022 • edited Loading

Summary

Purpose of change

Describe the solution

Describe alternatives you've considered

Testing

Additional context

lgtm-com bot commented Feb 20, 2022

lgtm-com bot commented Feb 21, 2022

lgtm-com bot commented Feb 21, 2022

lgtm-com bot commented Aug 16, 2022

lgtm-com bot commented Aug 16, 2022

stale bot commented Sep 21, 2022

Zireael07 commented Dec 6, 2022

mqrause commented Dec 6, 2022

github-actions bot commented Jan 5, 2023

db48x left a comment

Choose a reason for hiding this comment

db48x Sep 6, 2024

Choose a reason for hiding this comment

db48x Sep 6, 2024

Choose a reason for hiding this comment

db48x Sep 6, 2024

Choose a reason for hiding this comment

db48x Sep 6, 2024

Choose a reason for hiding this comment

db48x Sep 6, 2024

Choose a reason for hiding this comment

mqrause commented Sep 6, 2024

Rewrite and migrate `V` menu to ImGui #55503

Rewrite and migrate `V` menu to ImGui #55503

mqrause commented Feb 19, 2022 •

edited

Loading