Add ImGui Minimal Console Feature

doc/libf3d/OPTIONS.md

@@ -103,6 +103,7 @@ See the [APIs](#APIs) details below for more info.
 |     ui.scalar_bar     |  bool<br>false<br>render   | Show _scalar bar_ of the coloring by data array.                                                                 |        \-\-bar         |
 |     ui.cheatsheet     |  bool<br>false<br>render   | Show a interactor cheatsheet                                                                                     |           -            |
 |      ui.console       |  bool<br>false<br>render   | Show the console                                                                                                 |           -            |
+|  ui.minimal_console   |  bool<br>false<br>render   | Show the minimal console. Useful to execute a quick command and exit.                                            |           -            |
 |      ui.filename      |  bool<br>false<br>render   | Display the _filename info content_ on top of the window.                                                        |      \-\-filename      |
 |   ui.filename_info    |   string<br>-<br>render    | Content of _filename info_ to display.                                                                           |           -            |
 |     ui.font_file      | path<br>optional<br>render | Use the provided FreeType compatible font file to display text.<br>Can be useful to display non-ASCII filenames. |     \-\-font-file      |

doc/user/INTERACTIONS.md

@@ -73,7 +73,8 @@ Other hotkeys and interactions are available:
 
 - <kbd>H</kbd>: key to toggle the display of a cheat sheet showing all these hotkeys and their statuses.
 - <kbd>CTRL</kbd> + <kbd>Q</kbd>: close the window and quit F3D.
-- <kbd>Esc</kbd>: display/hide the console.
+- <kbd>Esc</kbd>: display the console or hide console/minimal console.
+- <kbd>:</kbd>: display the minimal console
 - <kbd>Space</kbd>: play the animation if any.
 - <kbd>&larr;</kbd>: load the previous file if any and reset the camera.
 - <kbd>&rarr;</kbd>: load the next file if any and reset the camera.

library/options.json

@@ -178,6 +178,10 @@
       "type": "bool",
       "default_value": "false"
     },
+    "minimal_console": {
+      "type": "bool",
+      "default_value": "false"
+    },
     "dropzone": {
       "type": "bool",
       "default_value": "false"

library/src/interactor_impl.cxx

@@ -259,10 +259,17 @@ class interactor_impl::internals
       const char* commandWithArgs = static_cast<const char*>(data);
       self->Interactor.SetCommandBuffer(commandWithArgs);
     }
-    else if (event == vtkF3DConsoleOutputWindow::ShowEvent ||
-      event == vtkF3DConsoleOutputWindow::HideEvent)
+    else if (event == vtkF3DConsoleOutputWindow::ShowEvent)
     {
-      self->Options.ui.console = (event == vtkF3DConsoleOutputWindow::ShowEvent);
+      // Invoked when console badge is clicked
+      self->Options.ui.console = true;
+    }
+    else if (event == vtkF3DConsoleOutputWindow::HideEvent)
+    {
+      // Invoked when esc key is pressed while in minimal console or console display, or when
+      // something is submitted to minimal console
+      self->Options.ui.console = false;
+      self->Options.ui.minimal_console = false;
     }
 
     self->RenderRequested = true;
@@ -1158,6 +1165,7 @@ interactor& interactor_impl::initBindings()
 #if F3D_MODULE_UI
   this->addBinding({mod_t::NONE, "H"}, "toggle ui.cheatsheet", "Others", std::bind(docStr, "Toggle cheatsheet display"));
   this->addBinding({mod_t::NONE, "Escape"}, "toggle ui.console", "Others", std::bind(docStr, "Toggle console display"));
+  this->addBinding({mod_t::ANY, "Colon"}, "toggle ui.minimal_console", "Others", std::bind(docStr, "Toggle minimal console display"));
 #endif
   this->addBinding({mod_t::CTRL, "Q"}, "stop_interactor", "Others", std::bind(docStr, "Stop the interactor"));
   this->addBinding({mod_t::NONE, "Return"}, "reset_camera", "Others", std::bind(docStr, "Reset camera to initial parameters"));

library/src/window_impl.cxx

@@ -399,6 +399,7 @@ void window_impl::UpdateDynamicOptions()
   renderer->ShowMetaData(opt.ui.metadata);
   renderer->ShowCheatSheet(opt.ui.cheatsheet);
   renderer->ShowConsole(opt.ui.console);
+  renderer->ShowMinimalConsole(opt.ui.minimal_console);
   renderer->ShowDropZone(opt.ui.dropzone);
   renderer->SetDropZoneInfo(opt.ui.dropzone_info);
   renderer->ShowArmature(opt.render.armature.enable);

vtkext/private/module/vtkF3DImguiActor.cxx

@@ -499,10 +499,10 @@ void vtkF3DImguiActor::RenderFpsCounter()
 }
 
 //----------------------------------------------------------------------------
-void vtkF3DImguiActor::RenderConsole()
+void vtkF3DImguiActor::RenderConsole(bool minimal)
 {
   vtkF3DImguiConsole* console = vtkF3DImguiConsole::SafeDownCast(vtkOutputWindow::GetInstance());
-  console->ShowConsole();
+  console->ShowConsole(minimal);
 }
 
 //----------------------------------------------------------------------------

vtkext/private/module/vtkF3DImguiActor.h

@@ -84,7 +84,7 @@ class vtkF3DImguiActor : public vtkF3DUIActor
   /**
    * Render the console widget
    */
-  void RenderConsole() override;
+  void RenderConsole(bool) override;
 
   /**
    * Render the console badge

vtkext/private/module/vtkF3DImguiConsole.cxx

@@ -200,18 +200,41 @@ void vtkF3DImguiConsole::DisplayText(const char* text)
 }
 
 //----------------------------------------------------------------------------
-void vtkF3DImguiConsole::ShowConsole()
+void vtkF3DImguiConsole::ShowConsole(bool minimal)
 {
   ImGuiViewport* viewport = ImGui::GetMainViewport();
 
   constexpr float margin = 30.f;
+  constexpr float marginTopRight = 5.f;
+  const float padding = ImGui::GetStyle().WindowPadding.x + ImGui::GetStyle().FramePadding.x;
 
-  this->Pimpl->NewError = false;
-  this->Pimpl->NewWarning = false;
+  // explicitly calculate size of minimal console to avoid extra flashing frame
+  if (minimal)
+  {
+    if (this->Pimpl->NewError || this->Pimpl->NewWarning)
+    {
+      // prevent overlap with console badge in minimal console
+      ImGui::SetNextWindowSize(ImVec2(viewport->WorkSize.x - 2.f * margin -
+          (ImGui::CalcTextSize("!").y + 2.f * padding) - marginTopRight,
+        ImGui::CalcTextSize(">").y + 2.f * padding));
+    }
+    else
+    {
+      ImGui::SetNextWindowSize(
+        ImVec2(viewport->WorkSize.x - 2.f * margin, ImGui::CalcTextSize(">").y + 2.f * padding));
+    }
+  }
+  else
+  {
+    // minimal console shouldn't clear console badge
+    this->Pimpl->NewError = false;
+    this->Pimpl->NewWarning = false;
+
+    ImGui::SetNextWindowSize(
+      ImVec2(viewport->WorkSize.x - 2.f * margin, viewport->WorkSize.y - 2.f * margin));
+  }
 
   ImGui::SetNextWindowPos(ImVec2(margin, margin));
-  ImGui::SetNextWindowSize(
-    ImVec2(viewport->WorkSize.x - 2.f * margin, viewport->WorkSize.y - 2.f * margin));
   ImGui::SetNextWindowBgAlpha(0.9f);
 
   ImGuiWindowFlags winFlags = ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_NoSavedSettings |
@@ -228,58 +251,62 @@ void vtkF3DImguiConsole::ShowConsole()
 
   ImGui::Begin("Console", nullptr, winFlags);
 
-  // Log window
-  const float reservedHeight = ImGui::GetStyle().ItemSpacing.y + ImGui::GetFrameHeightWithSpacing();
-  if (ImGui::BeginChild(
-        "LogRegion", ImVec2(0, -reservedHeight), 0, ImGuiWindowFlags_HorizontalScrollbar))
+  // Log window, will only show if not in minimal mode
+  if (!minimal)
   {
-    ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(4, 1)); // Tighten spacing
-    for (const auto& [severity, msg] : this->Pimpl->Logs)
+    const float reservedHeight =
+      ImGui::GetStyle().ItemSpacing.y + ImGui::GetFrameHeightWithSpacing();
+    if (ImGui::BeginChild(
+          "LogRegion", ImVec2(0, -reservedHeight), 0, ImGuiWindowFlags_HorizontalScrollbar))
     {
-      bool hasColor = true;
-
-      if (this->GetUseColoring())
+      ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(4, 1)); // Tighten spacing
+      for (const auto& [severity, msg] : this->Pimpl->Logs)
       {
-        switch (severity)
+        bool hasColor = true;
+
+        if (this->GetUseColoring())
+        {
+          switch (severity)
+          {
+            case Internals::LogType::Error:
+              ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 0.0f, 0.0f, 1.0f));
+              break;
+            case Internals::LogType::Warning:
+              ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 1.0f, 0.0f, 1.0f));
+              break;
+            case Internals::LogType::Typed:
+              ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(0.0f, 1.0f, 1.0f, 1.0f));
+              break;
+            case Internals::LogType::Completion:
+              ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(0.6f, 1.0f, 0.6f, 1.0f));
+              break;
+            default:
+              hasColor = false;
+          }
+        }
+        else
         {
-          case Internals::LogType::Error:
-            ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 0.0f, 0.0f, 1.0f));
-            break;
-          case Internals::LogType::Warning:
-            ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(1.0f, 1.0f, 0.0f, 1.0f));
-            break;
-          case Internals::LogType::Typed:
-            ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(0.0f, 1.0f, 1.0f, 1.0f));
-            break;
-          case Internals::LogType::Completion:
-            ImGui::PushStyleColor(ImGuiCol_Text, ImVec4(0.6f, 1.0f, 0.6f, 1.0f));
-            break;
-          default:
-            hasColor = false;
+          hasColor = false;
+        }
+
+        ImGui::TextUnformatted(msg.c_str());
+        if (hasColor)
+        {
+          ImGui::PopStyleColor();
         }
-      }
-      else
-      {
-        hasColor = false;
       }
 
-      ImGui::TextUnformatted(msg.c_str());
-      if (hasColor)
+      if (ImGui::GetScrollY() >= ImGui::GetScrollMaxY())
       {
-        ImGui::PopStyleColor();
+        ImGui::SetScrollHereY(1.0f);
       }
-    }
 
-    if (ImGui::GetScrollY() >= ImGui::GetScrollMaxY())
-    {
-      ImGui::SetScrollHereY(1.0f);
+      ImGui::PopStyleVar();
     }
+    ImGui::EndChild();
 
-    ImGui::PopStyleVar();
+    ImGui::Separator();
   }
-  ImGui::EndChild();
-
-  ImGui::Separator();
 
   // input
   ImGuiInputTextFlags inputFlags = ImGuiInputTextFlags_EnterReturnsTrue |
@@ -324,6 +351,12 @@ void vtkF3DImguiConsole::ShowConsole()
   {
     // No need to show completions after command is run
     this->Pimpl->ClearCompletions();
+
+    // exit console immediately after running command if in minimal mode
+    if (minimal)
+    {
+      this->InvokeEvent(vtkF3DImguiConsole::HideEvent);
+    }
   }
 
   ImGui::End();
@@ -337,16 +370,17 @@ void vtkF3DImguiConsole::ShowBadge()
   if (this->Pimpl->NewError || this->Pimpl->NewWarning)
   {
     constexpr float marginTopRight = 5.f;
+    const float padding = ImGui::GetStyle().WindowPadding.x + ImGui::GetStyle().FramePadding.x;
     ImVec2 winSize = ImGui::CalcTextSize("!");
-    winSize.x += 2.f * (ImGui::GetStyle().WindowPadding.x + ImGui::GetStyle().FramePadding.x);
-    winSize.y += 2.f * (ImGui::GetStyle().WindowPadding.y + ImGui::GetStyle().FramePadding.y);
+    winSize.x += 2.f * padding;
+    winSize.y += 2.f * padding;
 
     ImGui::SetNextWindowPos(
       ImVec2(viewport->WorkSize.x - winSize.x - marginTopRight, marginTopRight));
     ImGui::SetNextWindowSize(winSize);
 
     ImGuiWindowFlags winFlags = ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_NoSavedSettings |
-      ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoMove;
+      ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoMove;
 
     ImGui::Begin("ConsoleAlert", nullptr, winFlags);
 

vtkext/private/module/vtkF3DImguiConsole.h

@@ -37,7 +37,7 @@ class vtkF3DImguiConsole : public vtkF3DConsoleOutputWindow
   /**
    * Show console window
    */
-  void ShowConsole();
+  void ShowConsole(bool);
 
   /**
    * Show console badge

vtkext/private/module/vtkF3DRenderer.cxx

@@ -1536,6 +1536,17 @@ void vtkF3DRenderer::ShowConsole(bool show)
   }
 }
 
+//----------------------------------------------------------------------------
+void vtkF3DRenderer::ShowMinimalConsole(bool show)
+{
+  if (this->MinimalConsoleVisible != show)
+  {
+    this->MinimalConsoleVisible = show;
+    this->UIActor->SetMinimalConsoleVisibility(show);
+    this->CheatSheetConfigured = false;
+  }
+}
+
 //----------------------------------------------------------------------------
 void vtkF3DRenderer::ConfigureCheatSheet(const std::vector<vtkF3DUIActor::CheatSheetGroup>& info)
 {

vtkext/private/module/vtkF3DRenderer.h

@@ -59,6 +59,7 @@ class vtkF3DRenderer : public vtkOpenGLRenderer
   void ShowFilename(bool show);
   void ShowCheatSheet(bool show);
   void ShowConsole(bool show);
+  void ShowMinimalConsole(bool show);
   void ShowDropZone(bool show);
   void ShowHDRISkybox(bool show);
   void ShowArmature(bool show);
@@ -525,6 +526,7 @@ class vtkF3DRenderer : public vtkOpenGLRenderer
   bool MetaDataVisible = false;
   bool CheatSheetVisible = false;
   bool ConsoleVisible = false;
+  bool MinimalConsoleVisible = false;
   bool DropZoneVisible = false;
   bool HDRISkyboxVisible = false;
   bool ArmatureVisible = false;

vtkext/private/module/vtkF3DUIActor.cxx

@@ -60,6 +60,12 @@ void vtkF3DUIActor::SetConsoleVisibility(bool show)
   this->ConsoleVisible = show;
 }
 
+//----------------------------------------------------------------------------
+void vtkF3DUIActor::SetMinimalConsoleVisibility(bool show)
+{
+  this->MinimalConsoleVisible = show;
+}
+
 //----------------------------------------------------------------------------
 void vtkF3DUIActor::SetConsoleBadgeEnabled(bool enabled)
 {
@@ -154,11 +160,17 @@ int vtkF3DUIActor::RenderOverlay(vtkViewport* vp)
     this->RenderFpsCounter();
   }
 
+  // Only one console can be visible at a time, console has priority over minimal console
   if (this->ConsoleVisible)
   {
-    this->RenderConsole();
+    this->RenderConsole(false);
   }
-  else if (this->ConsoleBadgeEnabled)
+  else if (this->MinimalConsoleVisible)
+  {
+    this->RenderConsole(true);
+  }
+
+  if (this->ConsoleBadgeEnabled)
   {
     this->RenderConsoleBadge();
   }

vtkext/private/module/vtkF3DUIActor.h

@@ -78,6 +78,13 @@ class vtkF3DUIActor : public vtkProp
    */
   void SetConsoleVisibility(bool show);
 
+  /**
+   * Set the minimal console visibility
+   * Console visibility has priority over minimal console visibility
+   * False by default
+   */
+  void SetMinimalConsoleVisibility(bool show);
+
   /**
    * Set the console badge enabled status
    * False by default
@@ -181,7 +188,14 @@ class vtkF3DUIActor : public vtkProp
   /**
    * Render the console widget
    */
-  virtual void RenderConsole()
+  virtual void RenderConsole(bool)
+  {
+  }
+
+  /**
+   * Render the minimal console widget
+   */
+  virtual void RenderMinimalConsole()
   {
   }
 
@@ -205,6 +219,7 @@ class vtkF3DUIActor : public vtkProp
   std::vector<CheatSheetGroup> CheatSheet;
 
   bool ConsoleVisible = false;
+  bool MinimalConsoleVisible = false;
   bool ConsoleBadgeEnabled = false;
 
   bool FpsCounterVisible = false;