Add ImGui Minimal Console Feature

doc/libf3d/OPTIONS.md

@@ -102,6 +102,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   | Enable minimal console mode. Only latest command output is displayed.                                            |           -            |
 |      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      |

library/options.json

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

library/src/interactor_impl.cxx

@@ -274,6 +274,10 @@ class interactor_impl::internals
     internals* self = static_cast<internals*>(clientData);
     vtkRenderWindowInteractor* rwi = self->Style->GetInteractor();
     std::string interaction = rwi->GetKeySym();
+    if (interaction == "semicolon" && rwi->GetShiftKey() == 1)
+    {
+      interaction = "colon";
+    }
     if (!interaction.empty())
     {
       // Make sure key symbols starts with an upper char (e.g. "space" -> "Space")
@@ -442,7 +446,7 @@ class interactor_impl::internals
     {
       mod = mod_t::CTRL;
     }
-    else if (shift)
+    else if (shift && interaction != "Colon")
     {
       mod = mod_t::SHIFT;
     }
@@ -671,6 +675,16 @@ interactor& interactor_impl::initCommands()
 #endif
     });
 
+  this->addCommand(":q",
+    [&](const std::vector<std::string>& args)
+    {
+      check_args(args, 0, ":q");
+      if (this->Internals->Options.ui.minimal_console)
+      {
+        this->Internals->Options.ui.minimal_console = false;
+      }
+    });
+
   this->addCommand("print",
     [&](const std::vector<std::string>& args)
     {
@@ -1087,6 +1101,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::NONE, "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"));
@@ -1216,7 +1231,6 @@ interactor& interactor_impl::toggleAnimation()
   this->Internals->AnimationManager->ToggleAnimation();
   return *this;
 }
-
 //----------------------------------------------------------------------------
 interactor& interactor_impl::startAnimation()
 {

library/src/window_impl.cxx

@@ -398,6 +398,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/vtkF3DConsoleOutputWindow.h

@@ -23,7 +23,7 @@ class vtkF3DConsoleOutputWindow : public vtkOutputWindow
   {
     TriggerEvent = vtkCommand::UserEvent + 200,
     ShowEvent,
-    HideEvent
+    HideEvent,
   };
 
   /**

vtkext/private/module/vtkF3DImguiActor.cxx

@@ -505,6 +505,13 @@ void vtkF3DImguiActor::RenderConsole()
   console->ShowConsole();
 }
 
+//----------------------------------------------------------------------------
+void vtkF3DImguiActor::RenderMinimalConsole()
+{
+  vtkF3DImguiConsole* console = vtkF3DImguiConsole::SafeDownCast(vtkOutputWindow::GetInstance());
+  console->ShowMinimalConsole();
+}
+
 //----------------------------------------------------------------------------
 void vtkF3DImguiActor::RenderConsoleBadge()
 {

vtkext/private/module/vtkF3DImguiActor.h

@@ -86,6 +86,11 @@ class vtkF3DImguiActor : public vtkF3DUIActor
    */
   void RenderConsole() override;
 
+  /**
+   * Render the minimal console widget
+   */
+  void RenderMinimalConsole() override;
+
   /**
    * Render the console badge
    */

vtkext/private/module/vtkF3DImguiConsole.cxx

@@ -165,6 +165,117 @@ void vtkF3DImguiConsole::ShowConsole()
   ImGui::End();
 }
 
+//----------------------------------------------------------------------------
+void vtkF3DImguiConsole::ShowMinimalConsole()
+{
+  ImGuiViewport* viewport = ImGui::GetMainViewport();
+
+  constexpr float margin = 30.f;
+  const float reservedHeight = ImGui::GetStyle().ItemSpacing.y + ImGui::GetFrameHeightWithSpacing();
+
+  this->Pimpl->NewError = false;
+  this->Pimpl->NewWarning = false;
+
+  ImGui::SetNextWindowPos(ImVec2(margin, margin));
+  if (this->Pimpl->Logs.empty())
+  {
+    ImGui::SetNextWindowSize(ImVec2(viewport->WorkSize.x - 2.f * margin, reservedHeight + margin));
+  }
+  else
+  {
+    const auto& [severity, msg] = this->Pimpl->Logs.back();
+    ImGui::SetNextWindowSize(ImVec2(viewport->WorkSize.x - 2.f * margin,
+      ImGui::CalcTextSize(msg.c_str()).y + reservedHeight + margin));
+  }
+  ImGui::SetNextWindowBgAlpha(0.9f);
+
+  ImGuiWindowFlags winFlags = ImGuiWindowFlags_NoDecoration | ImGuiWindowFlags_NoSavedSettings |
+    ImGuiWindowFlags_NoFocusOnAppearing | ImGuiWindowFlags_NoNav | ImGuiWindowFlags_NoMove;
+
+  ImGui::Begin("Console", nullptr, winFlags);
+
+  // Log window
+  if (ImGui::BeginChild(
+        "LogRegion", ImVec2(0, -reservedHeight), 0, ImGuiWindowFlags_HorizontalScrollbar) &&
+    !this->Pimpl->Logs.empty())
+    !this->Pimpl->Logs.empty())
+  {
+    ImGui::PushStyleVar(ImGuiStyleVar_ItemSpacing, ImVec2(4, 1)); // Tighten spacing
+
+    const auto& [severity, msg] = this->Pimpl->Logs.back();
+    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;
+        default:
+          hasColor = false;
+      }
+    }
+    else
+    {
+      hasColor = false;
+    }
+
+    ImGui::TextUnformatted(msg.c_str());
+    if (hasColor)
+    {
+      ImGui::PopStyleColor();
+    }
+
+    if (ImGui::GetScrollY() >= ImGui::GetScrollMaxY())
+    {
+      ImGui::SetScrollHereY(1.0f);
+    }
+
+    ImGui::PopStyleVar();
+  }
+  ImGui::EndChild();
+
+  ImGui::Separator();
+
+  // input
+  ImGuiInputTextFlags inputFlags =
+    ImGuiInputTextFlags_EnterReturnsTrue | ImGuiInputTextFlags_EscapeClearsAll;
+
+  ImGui::Text("> ");
+  ImGui::SameLine();
+
+  ImGui::PushItemWidth(-1);
+  bool runCommand = ImGui::InputText("##ConsoleInput", this->Pimpl->CurrentInput.data(),
+    sizeof(this->Pimpl->CurrentInput), inputFlags, nullptr, this->Pimpl.get());
+  ImGui::PopItemWidth();
+
+  ImGui::SetItemDefaultFocus();
+
+  // if always forcing the focus, it prevents grabbing the scrollbar
+  if (!ImGui::IsAnyItemActive())
+  {
+    ImGui::SetKeyboardFocusHere(-1);
+  }
+
+  // do not run the command if nothing is in the input text
+  if (runCommand && this->Pimpl->CurrentInput[0] != 0)
+  {
+    this->Pimpl->Logs.emplace_back(std::make_pair(
+      Internals::LogType::Typed, std::string("> ") + this->Pimpl->CurrentInput.data()));
+    this->InvokeEvent(vtkF3DImguiConsole::TriggerEvent, this->Pimpl->CurrentInput.data());
+    this->Pimpl->CurrentInput = {};
+  }
+
+  ImGui::End();
+}
+
 //----------------------------------------------------------------------------
 void vtkF3DImguiConsole::ShowBadge()
 {
@@ -213,4 +324,4 @@ void vtkF3DImguiConsole::Clear()
   this->Pimpl->Logs.clear();
   this->Pimpl->NewError = false;
   this->Pimpl->NewWarning = false;
-}
+}

vtkext/private/module/vtkF3DImguiConsole.h

@@ -38,11 +38,16 @@ class vtkF3DImguiConsole : public vtkF3DConsoleOutputWindow
    */
   void ShowConsole();
 
+  /**
+   * Show minimal console window
+   */ 
+  void ShowMinimalConsole();
+
   /**
    * Show console badge
    */
   void ShowBadge();
-
+  
   /**
    * Clear console
    */

vtkext/private/module/vtkF3DRenderer.cxx

@@ -1518,6 +1518,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

@@ -49,6 +49,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);
@@ -515,6 +516,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)
 {
@@ -158,6 +164,10 @@ int vtkF3DUIActor::RenderOverlay(vtkViewport* vp)
   {
     this->RenderConsole();
   }
+  else if (this->MinimalConsoleVisible)
+  {
+    this->RenderMinimalConsole();
+  }
   else if (this->ConsoleBadgeEnabled)
   {
     this->RenderConsoleBadge();

vtkext/private/module/vtkF3DUIActor.h

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