Hide console badge when rendering offscreen (#1840)

f3d-app · Dec 30, 2024 · 54b365b · 54b365b
1 parent e239a50
commit 54b365b
Show file tree

Hide file tree

Showing 11 changed files with 39 additions and 10 deletions.
diff --git a/application/testing/CMakeLists.txt b/application/testing/CMakeLists.txt
@@ -129,6 +129,7 @@ function(f3d_test)
 
   set(f3d_test_env_vars ${F3D_TEST_ENV})
   list(APPEND f3d_test_env_vars "CTEST_F3D_PROGRESS_BAR=1")
+  list(APPEND f3d_test_env_vars "CTEST_F3D_CONSOLE_BADGE=1")
   if (F3D_TEST_NO_DATA_FORCE_RENDER)
     list(APPEND f3d_test_env_vars "CTEST_F3D_NO_DATA_FORCE_RENDER=1")
   endif ()

diff --git a/library/CMakeLists.txt b/library/CMakeLists.txt
@@ -184,7 +184,8 @@ endif ()
 
 if(F3D_STRICT_BUILD AND MSVC)
   # There are warnings in VTK related to deprecated features in C++17
-  target_compile_definitions(libf3d PRIVATE _SILENCE_ALL_CXX17_DEPRECATION_WARNINGS)
+  # Using std::getenv is also considered unsecured on Windows
+  target_compile_definitions(libf3d PRIVATE _SILENCE_ALL_CXX17_DEPRECATION_WARNINGS _CRT_SECURE_NO_WARNINGS)
 endif()
 
 if(APPLE)

diff --git a/library/src/window_impl.cxx b/library/src/window_impl.cxx
@@ -186,6 +186,9 @@ window_impl::window_impl(const options& options, const std::optional<Type>& type
   this->Internals->Camera = std::make_unique<detail::camera_impl>();
   this->Internals->Camera->SetVTKRenderer(this->Internals->Renderer);
 
+  this->Internals->Renderer->SetConsoleBadgeEnabled(
+    !offscreen || std::getenv("CTEST_F3D_CONSOLE_BADGE"));
+
   this->Initialize();
 
   log::debug("VTK window class type is ", this->Internals->RenWin->GetClassName());

diff --git a/testing/baselines/TestSDKInteractorCallBackDefault.png b/testing/baselines/TestSDKInteractorCallBackDefault.png
diff --git a/testing/baselines/TestSDKInteractorCallBackDefaultAgain.png b/testing/baselines/TestSDKInteractorCallBackDefaultAgain.png
diff --git a/testing/baselines/TestSDKInteractorCallBackModified.png b/testing/baselines/TestSDKInteractorCallBackModified.png
diff --git a/testing/baselines/TestSDKInteractorCallBackModifiedAgain.png b/testing/baselines/TestSDKInteractorCallBackModifiedAgain.png
diff --git a/vtkext/private/module/vtkF3DRenderer.cxx b/vtkext/private/module/vtkF3DRenderer.cxx
@@ -2639,3 +2639,9 @@ void vtkF3DRenderer::SetUIDeltaTime(double time)
 {
   this->UIActor->SetDeltaTime(time);
 }
+
+//----------------------------------------------------------------------------
+void vtkF3DRenderer::SetConsoleBadgeEnabled(bool enabled)
+{
+  this->UIActor->SetConsoleBadgeEnabled(enabled);
+}
diff --git a/vtkext/private/module/vtkF3DRenderer.h b/vtkext/private/module/vtkF3DRenderer.h
@@ -377,6 +377,11 @@ class vtkF3DRenderer : public vtkOpenGLRenderer
    */
   void SetUIDeltaTime(double time);
 
+  /**
+   * Set console badge enabled status
+   */
+  void SetConsoleBadgeEnabled(bool enabled);
+
 private:
   vtkF3DRenderer();
   ~vtkF3DRenderer() override;

diff --git a/vtkext/private/module/vtkF3DUIActor.cxx b/vtkext/private/module/vtkF3DUIActor.cxx
@@ -48,6 +48,12 @@ void vtkF3DUIActor::SetConsoleVisibility(bool show)
   this->ConsoleVisible = show;
 }
 
+//----------------------------------------------------------------------------
+void vtkF3DUIActor::SetConsoleBadgeEnabled(bool enabled)
+{
+  this->ConsoleBadgeEnabled = enabled;
+}
+
 //----------------------------------------------------------------------------
 void vtkF3DUIActor::SetCheatSheet(const std::vector<CheatSheetGroup>& cheatsheet)
 {
@@ -113,7 +119,7 @@ int vtkF3DUIActor::RenderOverlay(vtkViewport* vp)
   {
     this->RenderConsole();
   }
-  else
+  else if (this->ConsoleBadgeEnabled)
   {
     this->RenderConsoleBadge();
   }

diff --git a/vtkext/private/module/vtkF3DUIActor.h b/vtkext/private/module/vtkF3DUIActor.h
@@ -62,6 +62,12 @@ class vtkF3DUIActor : public vtkProp
    */
   void SetConsoleVisibility(bool show);
 
+  /**
+   * Set the console badge enabled status
+   * False by default
+   */
+  void SetConsoleBadgeEnabled(bool enabled);
+
   /**
    * Set the cheatsheet string
    * Empty by default
@@ -150,6 +156,7 @@ class vtkF3DUIActor : public vtkProp
   std::vector<CheatSheetGroup> CheatSheet;
 
   bool ConsoleVisible = false;
+  bool ConsoleBadgeEnabled = false;
 
   bool FpsCounterVisible = false;
   int FpsValue = 0;