Label frame definition workflow as deprecated (#951)

ComputationalBiomechanicsLab · Nov 14, 2024 · 715d665 · 715d665
1 parent 3f311f7
commit 715d665
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,10 @@ on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## [Upcoming Release]
 
+- Workflow links on the splash screen were reordered slightly.
+- The "Frame Definition" workflow is now labelled as deprecated, because we anticipate
+  that it isn't used very much. If you think otherwise, then post a comment on issue
+  #951.
 - The documentation now contains an explanation for how to install OSC on MacOSes
   that have a newer, more draconian, gatekeeper (#942).
 - Fixed a typo where tutorial 5 referred to a "femur CT scan" when the content was

diff --git a/src/OpenSimCreator/UI/Shared/MainMenu.cpp b/src/OpenSimCreator/UI/Shared/MainMenu.cpp
@@ -195,7 +195,7 @@ void osc::MainMenuFileTab::onDraw(IModelStatePair* maybeModel)
         auto tab = std::make_unique<mi::MeshImporterTab>(*m_Parent);
         App::post_event<OpenTabEvent>(*m_Parent, std::move(tab));
     }
-    if (ui::draw_menu_item(OSC_ICON_MAGIC " Preview Experimental Data (" OSC_ICON_MAGIC " experimental)")) {
+    if (ui::draw_menu_item(OSC_ICON_MAGIC " Preview Experimental Data")) {
         auto tab = std::make_unique<PreviewExperimentalDataTab>(*m_Parent);
         App::post_event<OpenTabEvent>(*m_Parent, std::move(tab));
     }

diff --git a/src/OpenSimCreator/UI/SplashTab.cpp b/src/OpenSimCreator/UI/SplashTab.cpp
@@ -265,28 +265,32 @@ class osc::SplashTab::Impl final : public TabPrivate {
 
     void drawWorkflowsMenuSectionContent()
     {
-        if (ui::draw_menu_item(OSC_ICON_ARROWS_ALT " Frame Definition")) {
-            auto tab = std::make_unique<FrameDefinitionTab>(*parent());
-            App::post_event<OpenTabEvent>(*parent(), std::move(tab));
-        }
         if (ui::draw_menu_item(OSC_ICON_FILE_IMPORT " Mesh Importer")) {
             auto tab = std::make_unique<mi::MeshImporterTab>(*parent());
             App::post_event<OpenTabEvent>(*parent(), std::move(tab));
         }
+
+        if (ui::draw_menu_item(OSC_ICON_MAGIC " Preview Experimental Data")) {
+            auto tab = std::make_unique<PreviewExperimentalDataTab>(*parent());
+            App::post_event<OpenTabEvent>(*parent(), std::move(tab));
+        }
         if (ui::draw_menu_item(OSC_ICON_CUBE " Mesh Warping")) {
             auto tab = std::make_unique<MeshWarpingTab>(*parent());
             App::post_event<OpenTabEvent>(*parent(), std::move(tab));
         }
+        App::upd().add_frame_annotation("SplashTab/MeshWarpingMenuItem", ui::get_last_drawn_item_screen_rect());
+
         if (ui::draw_menu_item(OSC_ICON_MAGIC " Model Warping (" OSC_ICON_MAGIC " experimental)")) {
             auto tab = std::make_unique<mow::ModelWarperTab>(*parent());
             App::post_event<OpenTabEvent>(*parent(), std::move(tab));
         }
         App::upd().add_frame_annotation("SplashTab/ModelWarpingMenuItem", ui::get_last_drawn_item_screen_rect());
-        if (ui::draw_menu_item(OSC_ICON_MAGIC " Preview Experimental Data (" OSC_ICON_MAGIC " experimental)")) {
-            auto tab = std::make_unique<PreviewExperimentalDataTab>(*parent());
+
+        if (ui::draw_menu_item(OSC_ICON_ARROWS_ALT " Frame Definition (" OSC_ICON_TRASH " deprecated)")) {
+            auto tab = std::make_unique<FrameDefinitionTab>(*parent());
             App::post_event<OpenTabEvent>(*parent(), std::move(tab));
         }
-        App::upd().add_frame_annotation("SplashTab/MeshWarpingMenuItem", ui::get_last_drawn_item_screen_rect());
+        ui::draw_tooltip_if_item_hovered("Frame Definition Workflow", "This feature is currently scheduled for deprecation. If you think it shouldn't be deprecated, then post a comment on GitHub issue #951.");
     }
 
     void drawRecentlyOpenedFilesMenuSectionContent(int& imguiID)