Merge pull request #7 from ROGsamurai/develop

Gui window rework (HarbourMasters#4307)
ROGsamurai · Sep 10, 2024 · 21082c4 · 21082c4
2 parents 74155ac + b5037a0
commit 21082c4
Show file tree

Hide file tree

Showing 22 changed files with 748 additions and 801 deletions.
diff --git a/soh/soh/Enhancements/audio/AudioEditor.cpp b/soh/soh/Enhancements/audio/AudioEditor.cpp
@@ -424,12 +424,6 @@ void AudioEditor::InitElement() {
 void AudioEditor::DrawElement() {
  AudioCollection::Instance->InitializeShufflePool();
 
- ImGui::SetNextWindowSize(ImVec2(820, 630), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Audio Editor", &mIsVisible)) {
- ImGui::End();
- return;
- }
-
  float buttonSegments = ImGui::GetContentRegionAvail().x / 4;
  if (ImGui::Button("Randomize All Groups", ImVec2(buttonSegments, 30.0f))) {
  AudioEditor_RandomizeAll();
@@ -700,7 +694,6 @@ void AudioEditor::DrawElement() {
 
  ImGui::EndTabBar();
  }
- ImGui::End();
 }
 
 std::vector<SeqType> allTypes = { SEQ_BGM_WORLD, SEQ_BGM_EVENT, SEQ_BGM_BATTLE, SEQ_OCARINA, SEQ_FANFARE, SEQ_INSTRUMENT, SEQ_SFX, SEQ_VOICE };

diff --git a/soh/soh/Enhancements/controls/InputViewer.cpp b/soh/soh/Enhancements/controls/InputViewer.cpp
diff --git a/soh/soh/Enhancements/controls/InputViewer.h b/soh/soh/Enhancements/controls/InputViewer.h
@@ -21,6 +21,7 @@ class InputViewer : public Ship::GuiWindow {
 public:
  using GuiWindow::GuiWindow;
 
+ void Draw() override;
  void InitElement() override {};
  void DrawElement() override;
  void UpdateElement() override {};

diff --git a/soh/soh/Enhancements/cosmetics/CosmeticsEditor.cpp b/soh/soh/Enhancements/cosmetics/CosmeticsEditor.cpp
@@ -1687,12 +1687,6 @@ static const char* colorSchemes[2] = {
 };
 
 void CosmeticsEditorWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(550, 520), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Cosmetics Editor", &mIsVisible)) {
- ImGui::End();
- return;
- }
-
  ImGui::Text("Color Scheme");
  ImGui::SameLine();
  UIWidgets::EnhancementCombobox(CVAR_COSMETIC("DefaultColorScheme"), colorSchemes, COLORSCHEME_N64);
@@ -1811,7 +1805,6 @@ void CosmeticsEditorWindow::DrawElement() {
  }
  ImGui::EndTabBar();
  }
- ImGui::End();
 }
 
 void RegisterOnLoadGameHook() {

diff --git a/soh/soh/Enhancements/debugger/MessageViewer.cpp b/soh/soh/Enhancements/debugger/MessageViewer.cpp
@@ -20,11 +20,6 @@ void MessageViewer::InitElement() {
 }
 
 void MessageViewer::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Custom Message Debugger", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
  ImGui::Text("Table ID");
  ImGui::SameLine();
  ImGui::InputText("##TableID", mTableIdBuf, MAX_STRING_SIZE, ImGuiInputTextFlags_CallbackCharFilter, UIWidgets::TextFilters::FilterAlphaNum);
@@ -74,7 +69,6 @@ void MessageViewer::DrawElement() {
  if (ImGui::Button("Display Message##CustomMessage")) {
  mDisplayCustomMessageClicked = true;
  }
- ImGui::End();
  // ReSharper restore CppDFAUnreachableCode
 }
 

diff --git a/soh/soh/Enhancements/debugger/actorViewer.cpp b/soh/soh/Enhancements/debugger/actorViewer.cpp
@@ -925,12 +925,6 @@ void ActorViewer_AddTagForAllActors() {
 }
 
 void ActorViewerWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Actor Viewer", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
-
  static Actor* display;
  static Actor empty{};
  static Actor* fetch = NULL;
@@ -1239,8 +1233,6 @@ void ActorViewerWindow::DrawElement() {
  actors.clear();
  }
  }
-
- ImGui::End();
 }
 
 void ActorViewerWindow::InitElement() {

diff --git a/soh/soh/Enhancements/debugger/colViewer.cpp b/soh/soh/Enhancements/debugger/colViewer.cpp
@@ -53,11 +53,6 @@ static std::vector<Vtx> sphereVtx;
 
 // Draws the ImGui window for the collision viewer
 void ColViewerWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Collision Viewer", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
  UIWidgets::EnhancementCheckbox("Enabled", CVAR_DEVELOPER_TOOLS("ColViewer.Enabled"));
 
  UIWidgets::LabeledRightAlignedEnhancementCombobox("Scene", CVAR_DEVELOPER_TOOLS("ColViewer.Scene"), ColRenderSettingNames, COLVIEW_DISABLED);
@@ -95,8 +90,6 @@ void ColViewerWindow::DrawElement() {
  } else {
  UIWidgets::InsertHelpHoverText(colorHelpText);
  }
-
- ImGui::End();
 }
 
 // Calculates the normal for a triangle at the 3 specified points

diff --git a/soh/soh/Enhancements/debugger/debugSaveEditor.cpp b/soh/soh/Enhancements/debugger/debugSaveEditor.cpp
@@ -1753,12 +1753,6 @@ void DrawPlayerTab() {
 }
 
 void SaveEditorWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Save Editor", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
-
  if (ImGui::BeginTabBar("SaveContextTabBar", ImGuiTabBarFlags_NoCloseWithMiddleMouseButton)) {
  if (ImGui::BeginTabItem("Info")) {
  DrawInfoTab();
@@ -1792,8 +1786,6 @@ void SaveEditorWindow::DrawElement() {
 
  ImGui::EndTabBar();
  }
-
- ImGui::End();
 }
 
 void SaveEditorWindow::InitElement() {

diff --git a/soh/soh/Enhancements/debugger/dlViewer.cpp b/soh/soh/Enhancements/debugger/dlViewer.cpp
@@ -90,12 +90,6 @@ void PerformDisplayListSearch() {
 }
 
 void DLViewerWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Display List Viewer", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
-
  // Debounce the search field as listing otr files is expensive
  if (ImGui::InputText("Search Display Lists", searchString, ARRAY_COUNT(searchString))) {
  doSearch = true;
@@ -122,7 +116,6 @@ void DLViewerWindow::DrawElement() {
  }
 
  if (activeDisplayList == "") {
- ImGui::End();
  return;
  }
 
@@ -131,7 +124,6 @@ void DLViewerWindow::DrawElement() {
 
  if (res->GetInitData()->Type != static_cast<uint32_t>(LUS::ResourceType::DisplayList)) {
  ImGui::Text("Resource type is not a Display List. Please choose another.");
- ImGui::End();
  return;
  }
 
@@ -325,11 +317,8 @@ void DLViewerWindow::DrawElement() {
  }
  } catch (const std::exception& e) {
  ImGui::Text("Error displaying DL instructions.");
- ImGui::End();
  return;
  }
-
- ImGui::End();
 }
 
 void DLViewerWindow::InitElement() {

diff --git a/soh/soh/Enhancements/debugger/valueViewer.cpp b/soh/soh/Enhancements/debugger/valueViewer.cpp
@@ -102,12 +102,6 @@ extern "C" void ValueViewer_Draw(GfxPrint* printer) {
 }
 
 void ValueViewerWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(520, 600), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Value Viewer", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
-
  UIWidgets::PaddedEnhancementCheckbox("Enable Printing", CVAR_DEVELOPER_TOOLS("ValueViewerEnablePrinting"));
 
  ImGui::BeginGroup();
@@ -212,8 +206,6 @@ void ValueViewerWindow::DrawElement() {
  }
  ImGui::EndGroup();
  }
-
- ImGui::End();
 }
 
 void ValueViewerWindow::InitElement() {

diff --git a/soh/soh/Enhancements/gameplaystats.cpp b/soh/soh/Enhancements/gameplaystats.cpp
@@ -625,12 +625,6 @@ void DrawGameplayStatsOptionsTab() {
 }
 
 void GameplayStatsWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(480, 550), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Gameplay Stats", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
-
  DrawGameplayStatsHeader();
 
  if (ImGui::BeginTabBar("Stats", ImGuiTabBarFlags_NoCloseWithMiddleMouseButton)) {
@@ -654,8 +648,6 @@ void GameplayStatsWindow::DrawElement() {
  }
 
  ImGui::Text("Note: Gameplay stats are saved to the current file and will be\nlost if you quit without saving.");
-
- ImGui::End();
 }
 void InitStats(bool isDebug) {
  gSaveContext.sohStats.heartPieces = isDebug ? 8 : 0;

diff --git a/soh/soh/Enhancements/randomizer/randomizer.cpp b/soh/soh/Enhancements/randomizer/randomizer.cpp
@@ -3137,13 +3137,6 @@ void RandomizerSettingsWindow::DrawElement() {
 
  static int maxKeyringCount;
  static bool disableGFKeyring = false;
-
- ImGui::SetNextWindowSize(ImVec2(920, 600), ImGuiCond_FirstUseEver);
- if (!ImGui::Begin("Randomizer Editor", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
-
  bool disableEditingRandoSettings = CVarGetInteger(CVAR_GENERAL("RandoGenerating"), 0) || CVarGetInteger(CVAR_GENERAL("OnFileSelectNameEntry"), 0);
  if (disableEditingRandoSettings) {
  UIWidgets::DisableComponent(ImGui::GetStyle().Alpha * 0.5f);
@@ -5284,7 +5277,6 @@ void RandomizerSettingsWindow::DrawElement() {
  if (disableEditingRandoSettings) {
  UIWidgets::ReEnableComponent("");
  }
- ImGui::End();
 }
 
 CustomMessage Randomizer::GetWarpSongMessage(u16 textId, bool mysterious) {

diff --git a/soh/soh/Enhancements/randomizer/randomizer_check_tracker.cpp b/soh/soh/Enhancements/randomizer/randomizer_check_tracker.cpp
@@ -867,9 +867,16 @@ void UpdateCheck(uint32_t check, RandomizerCheckTrackerData data) {
  UpdateOrdering(area);
 }
 
-void CheckTrackerWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(400, 540), ImGuiCond_FirstUseEver);
+void CheckTrackerWindow::Draw() {
+ if (!IsVisible()) {
+ return;
+ }
+ DrawElement();
+ // Sync up the IsVisible flag if it was changed by ImGui
+ SyncVisibilityConsoleVariable();
+}
 
+void CheckTrackerWindow::DrawElement() {
  if (CVarGetInteger(CVAR_TRACKER_CHECK("WindowType"), TRACKER_WINDOW_WINDOW) == TRACKER_WINDOW_FLOATING) {
  if (CVarGetInteger(CVAR_TRACKER_CHECK("ShowOnlyPaused"), 0) && (gPlayState == nullptr || gPlayState->pauseCtx.state == 0)) {
  return;
@@ -880,14 +887,16 @@ void CheckTrackerWindow::DrawElement() {
  int comboButton2Mask = buttons[CVarGetInteger(CVAR_TRACKER_CHECK("ComboButton2"), TRACKER_COMBO_BUTTON_R)];
  OSContPad* trackerButtonsPressed = Ship::Context::GetInstance()->GetControlDeck()->GetPads();
  bool comboButtonsHeld = trackerButtonsPressed != nullptr &&
-  trackerButtonsPressed[0].button & comboButton1Mask &&
-  trackerButtonsPressed[0].button & comboButton2Mask;
+ trackerButtonsPressed[0].button & comboButton1Mask &&
+ trackerButtonsPressed[0].button & comboButton2Mask;
  if (!comboButtonsHeld) {
  return;
  }
  }
  }
 
+ ImGui::SetNextWindowSize(ImVec2(400, 540), ImGuiCond_FirstUseEver);
+
  BeginFloatWindows("Check Tracker", mIsVisible, ImGuiWindowFlags_NoScrollbar);
 
  if (!GameInteractor::IsSaveLoaded() || !initialized) {
@@ -1601,14 +1610,8 @@ static const char* windowType[] = { "Floating", "Window" };
 static const char* displayType[] = { "Always", "Combo Button Hold" };
 static const char* buttonStrings[] = { "A Button", "B Button", "C-Up", "C-Down", "C-Left", "C-Right", "L Button",
  "Z Button", "R Button", "Start", "D-Up", "D-Down", "D-Left", "D-Right" };
-void CheckTrackerSettingsWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(600, 375), ImGuiCond_FirstUseEver);
-
- if (!ImGui::Begin("Check Tracker Settings", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
 
+void CheckTrackerSettingsWindow::DrawElement() {
  ImGui::PushStyleVar(ImGuiStyleVar_CellPadding, { 8.0f, 8.0f });
  ImGui::BeginTable("CheckTrackerSettingsTable", 2, ImGuiTableFlags_BordersH | ImGuiTableFlags_BordersV);
  ImGui::TableSetupColumn("General settings", ImGuiTableColumnFlags_WidthStretch, 200.0f);
@@ -1668,7 +1671,6 @@ void CheckTrackerSettingsWindow::DrawElement() {
 
  ImGui::PopStyleVar(1);
  ImGui::EndTable();
- ImGui::End();
 }
 
 void CheckTrackerWindow::InitElement() {

diff --git a/soh/soh/Enhancements/randomizer/randomizer_check_tracker.h b/soh/soh/Enhancements/randomizer/randomizer_check_tracker.h
@@ -21,6 +21,7 @@ class CheckTrackerSettingsWindow : public Ship::GuiWindow {
 class CheckTrackerWindow : public Ship::GuiWindow {
  public:
  using GuiWindow::GuiWindow;
+ void Draw() override;
  ~CheckTrackerWindow() {};
 
  protected:

diff --git a/soh/soh/Enhancements/randomizer/randomizer_entrance_tracker.cpp b/soh/soh/Enhancements/randomizer/randomizer_entrance_tracker.cpp
@@ -636,15 +636,24 @@ void InitEntranceTrackingData() {
  SortEntranceListByType(destListSortedByType, 1);
 }
 
+void EntranceTrackerWindow::Draw() {
+ if (!IsVisible()) {
+ return;
+ }
+ DrawElement();
+ // Sync up the IsVisible flag if it was changed by ImGui
+ SyncVisibilityConsoleVariable();
+}
+
 void EntranceTrackerWindow::DrawElement() {
+ // Begin tracker settings
  ImGui::SetNextWindowSize(ImVec2(600, 375), ImGuiCond_FirstUseEver);
 
  if (!ImGui::Begin("Entrance Tracker", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
  ImGui::End();
  return;
  }
 
- // Begin tracker settings
  ImGui::SetNextItemOpen(false, ImGuiCond_Once);
  if (ImGui::TreeNode("Tracker Settings")) {
  // Reduce indentation from the tree node for the table

diff --git a/soh/soh/Enhancements/randomizer/randomizer_entrance_tracker.h b/soh/soh/Enhancements/randomizer/randomizer_entrance_tracker.h
@@ -89,6 +89,7 @@ class EntranceTrackerWindow : public Ship::GuiWindow {
  public:
  using GuiWindow::GuiWindow;
 
+ void Draw() override;
  void InitElement() override;
  void DrawElement() override;
  void UpdateElement() override {};

diff --git a/soh/soh/Enhancements/randomizer/randomizer_item_tracker.cpp b/soh/soh/Enhancements/randomizer/randomizer_item_tracker.cpp
@@ -1006,6 +1006,15 @@ void ItemTrackerLoadFile() {
  }
 }
 
+void ItemTrackerWindow::Draw() {
+ if (!IsVisible()) {
+ return;
+ }
+ DrawElement();
+ // Sync up the IsVisible flag if it was changed by ImGui
+ SyncVisibilityConsoleVariable();
+}
+
 void ItemTrackerWindow::DrawElement() {
  UpdateVectors();
 
@@ -1122,13 +1131,6 @@ static const char* displayTypes[3] = { "Hidden", "Main Window", "Separate" };
 static const char* extendedDisplayTypes[4] = { "Hidden", "Main Window", "Misc Window", "Separate" };
 
 void ItemTrackerSettingsWindow::DrawElement() {
- ImGui::SetNextWindowSize(ImVec2(733, 472), ImGuiCond_FirstUseEver);
-
- if (!ImGui::Begin("Item Tracker Settings", &mIsVisible, ImGuiWindowFlags_NoFocusOnAppearing)) {
- ImGui::End();
- return;
- }
-
  ImGui::PushStyleVar(ImGuiStyleVar_CellPadding, { 8.0f, 8.0f });
  ImGui::BeginTable("itemTrackerSettingsTable", 2, ImGuiTableFlags_BordersH | ImGuiTableFlags_BordersV);
  ImGui::TableSetupColumn("General settings", ImGuiTableColumnFlags_WidthStretch, 200.0f);
@@ -1255,8 +1257,6 @@ void ItemTrackerSettingsWindow::DrawElement() {
 
  ImGui::PopStyleVar(1);
  ImGui::EndTable();
-
- ImGui::End();
 }
 
 void ItemTrackerWindow::InitElement() {

diff --git a/soh/soh/Enhancements/randomizer/randomizer_item_tracker.h b/soh/soh/Enhancements/randomizer/randomizer_item_tracker.h
@@ -42,6 +42,7 @@ class ItemTrackerSettingsWindow : public Ship::GuiWindow {
 class ItemTrackerWindow : public Ship::GuiWindow {
  public:
  using GuiWindow::GuiWindow;
+ void Draw() override;
 
 protected:
  void InitElement() override;