Create button for copy console logs to clipboard

wergilX · wergilX · commit 080f0780c003 · 2025-11-29T12:41:17.000+01:00
diff --git a/.github/actions/clip-install-dep/action.yml b/.github/actions/clip-install-dep/action.yml
@@ -0,0 +1,76 @@
+name: "Install clip Dependency"
+description: "Install clip Dependency using cache when possible"
+inputs:
+  cpu:
+    description: "CPU architecture to build for"
+    required: false
+    default: "x86_64"
+  version:
+    description: "Version of clip to build"
+    required: true
+  global_cache_index:
+    description: "Global cache index"
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Check required inputs
+      shell: bash
+      run: |
+        [[ "${{ inputs.version }}" ]] || { echo "version input is empty" ; exit 1; }
+        [[ "${{ inputs.global_cache_index }}" ]] || { echo "global_cache_index input is empty" ; exit 1; }
+
+    - name: Cache clip
+      id: cache-clip
+      uses: actions/cache/restore@v4
+      with:
+        path: dependencies/clip_install
+        key: clip-${{inputs.version}}-${{runner.os}}-${{inputs.cpu}}-${{inputs.global_cache_index}}-0
+
+    - name: Checkout clip
+      if: steps.cache-clip.outputs.cache-hit != 'true'
+      uses: actions/checkout@v4
+      with:
+        repository: dacap/clip
+        path: "./dependencies/clip"
+        ref: ${{inputs.version}}
+
+    - name: Setup clip
+      if: steps.cache-clip.outputs.cache-hit != 'true'
+      working-directory: ${{github.workspace}}/dependencies
+      shell: bash
+      run: |
+        mkdir clip_build
+        mkdir clip_install
+
+    - name: Configure clip
+      if: steps.cache-clip.outputs.cache-hit != 'true'
+      working-directory: ${{github.workspace}}/dependencies/clip_build
+      shell: bash
+      run: >
+        cmake ../clip
+        -DBUILD_SHARED_LIBS=ON
+        -DCMAKE_BUILD_TYPE=Release
+        -DCMAKE_INSTALL_PREFIX:PATH=../clip_install
+        -DCMAKE_PREFIX_PATH:PATH=../install/
+        ${{ runner.os == 'macOS' && '-DCMAKE_OSX_DEPLOYMENT_TARGET=12.0 -DCMAKE_MACOSX_RPATH=ON' || null }}
+        ${{ runner.os == 'Windows' && '-Ax64 -DCMAKE_POLICY_DEFAULT_CMP0091=NEW -DCMAKE_MSVC_RUNTIME_LIBRARY=MultiThreadedDLL' || null }}
+
+    - name: Build clip
+      if: steps.cache-clip.outputs.cache-hit != 'true'
+      working-directory: ${{github.workspace}}/dependencies/clip_build
+      shell: bash
+      run: cmake --build . --parallel 2 --target install --config Release
+
+    - name: Copy to install directory (F3D compatibility)
+      working-directory: ${{github.workspace}}/dependencies/clip_install
+      shell: bash
+      run: cp -r ./* ../install/
+
+    - name: Save clip cache
+      if: steps.cache-clip.outputs.cache-hit != 'true'
+      uses: actions/cache/save@v4
+      with:
+        key: ${{ steps.cache-clip.outputs.cache-primary-key }}
+        path: dependencies/clip_install
diff --git a/.github/actions/f3d-dependencies/action.yml b/.github/actions/f3d-dependencies/action.yml
@@ -116,3 +116,11 @@ runs:
         cpu: ${{inputs.cpu}}
         version: ${{inputs.webp_version}}
         global_cache_index: ${{inputs.global_cache_index}}
+
+    - name: Install clip dependency
+      if: inputs.clip_version != ''
+      uses: ./source/.github/actions/clip-install-dep
+      with:
+        cpu: ${{inputs.cpu}}
+        version: ${{inputs.clip_version}}
+        global_cache_index: ${{inputs.global_cache_index}}
diff --git a/.github/actions/generic-ci/action.yml b/.github/actions/generic-ci/action.yml
@@ -80,6 +80,9 @@ inputs:
   webp_version:
     description: "Version of webp to build"
     required: true
+  clip_version:
+    description: "Version of clip to build"
+    required: true
   zlib_version:
     description: "Version of zlib to build"
     required: true
@@ -120,6 +123,7 @@ runs:
         tbb_version: ${{inputs.tbb_version}}
         usd_version: ${{inputs.usd_version}}
         webp_version: ${{inputs.webp_version}}
+        clip_version: ${{inputs.clip_version}}
         zlib_version: ${{inputs.zlib_version}}
         global_cache_index: ${{inputs.global_cache_index}}
 
@@ -224,6 +228,7 @@ runs:
         -DF3D_MACOS_BUNDLE=${{ inputs.bundle_label == 'bundle' && 'ON' || 'OFF' }}
         -DF3D_MODULE_EXR=${{ inputs.optional_deps_label == 'optional-deps' && 'ON' || 'OFF' }}
         -DF3D_MODULE_WEBP=${{ inputs.optional_deps_label == 'optional-deps' && 'ON' || 'OFF' }}
+        -DF3D_MODULE_CLIP=${{ inputs.optional_deps_label == 'optional-deps' && 'ON' || 'OFF' }}
         -DF3D_MODULE_RAYTRACING=${{ inputs.ospray_version != '' && 'ON' || 'OFF' }}
         -DF3D_MODULE_UI=${{ inputs.optional_deps_label == 'optional-deps' && 'ON' || 'OFF' }}
         -DF3D_MODULE_DMON=${{ inputs.optional_deps_label == 'optional-deps' && 'ON' || 'OFF' }}
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -101,6 +101,7 @@ option(F3D_MODULE_WEBP "WebP images module" OFF)
 option(F3D_MODULE_UI "ImGui widgets module" ON)
 option(F3D_MODULE_DMON "dmon (watch) module" ON)
 option(F3D_MODULE_TINYFILEDIALOGS "tinyfiledialogs module" ON)
+option(F3D_MODULE_CLIP "clip (board) module" ON)
 
 # Use externals
 option(F3D_USE_EXTERNAL_CXXOPTS "Use external cxxopts dependency" OFF)
@@ -322,6 +323,7 @@ f3d_report_variable(F3D_MODULE_EXR)
 f3d_report_variable(F3D_MODULE_RAYTRACING)
 f3d_report_variable(F3D_MODULE_UI)
 f3d_report_variable(F3D_MODULE_WEBP)
+f3d_report_variable(F3D_MODULE_CLIP)
 f3d_report_variable(F3D_PLUGIN_BUILD_ALEMBIC)
 f3d_report_variable(F3D_PLUGIN_BUILD_ASSIMP)
 f3d_report_variable(F3D_PLUGIN_BUILD_DRACO)
diff --git a/testing/baselines/TestInteractionConsoleAutoComplete.png b/testing/baselines/TestInteractionConsoleAutoComplete.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:ba90b6fe8378e0e7713c941f9088514ed4571bbd263b395a10d6bd1194a9a36d
-size 6253
+oid sha256:02d669540218e9f82a09c61328fdc566bc138062ef05796bd20d869787812bba
+size 7377
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteCamera.png b/testing/baselines/TestInteractionConsoleAutoCompleteCamera.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:269835844616655ef05a637222e4f73a5dfdd32440fa56dc2f37b1eb059fe780
-size 8730
+oid sha256:87a11507a7569dc42ebf59d68881ece0a0c5fb7e664e470230cc2f90624e2674
+size 9831
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteCandidates.png b/testing/baselines/TestInteractionConsoleAutoCompleteCandidates.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:f256f345b1fa8283239625d046fb1bc96d0e010928e0be075f7ef3969f3cb780
-size 10099
+oid sha256:ec335d5df7a2e0d3d033083aea0be15d378329d0739be106d51f18efffa926f1
+size 11166
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteColoring.png b/testing/baselines/TestInteractionConsoleAutoCompleteColoring.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:ce18b7cbe4f4875dd2eab782bb5a3920a42a57e9e509f6838a19a1f506aa3595
-size 17140
+oid sha256:69f02540f6227f2659b02e9bc4d682af43c9bc130ce49e7c76104d6afc0febf6
+size 18199
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteHelp.png b/testing/baselines/TestInteractionConsoleAutoCompleteHelp.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:78b8df51989956082b2799549063e83fdb42eea960cd5c06ab6354ea0317b2da
-size 8730
+oid sha256:23bec20be9171bf67bb587185e59567f52fa42d0e0954f7b661848b8bf16e7cd
+size 9771
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteHide.png b/testing/baselines/TestInteractionConsoleAutoCompleteHide.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:eae8378c369f4c4fee53dc205c96e70c24f8d5da789e76709782684370e67b0f
-size 3860
+oid sha256:0e986e76328706fb35e51b269e3ec80c7c5fe37e113ae06ec01bc285a5fb539f
+size 5002
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteNoMatch.png b/testing/baselines/TestInteractionConsoleAutoCompleteNoMatch.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:d6f6dab8a60f8d1740068ea2f477fded8e4779eafdd2e30d619268ee5df6b9d5
-size 2037
+oid sha256:9a6529612a23020430cdbb3ebef5df172e8d080dad103bab6932dca84b357189
+size 3258
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteOptions.png b/testing/baselines/TestInteractionConsoleAutoCompleteOptions.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6efce73ca69abba8681d8dd07c8b47d853181c4c7139950c60dcdf7d48418e08
-size 7466
+oid sha256:ef63c594ccffa05ca078d7ad5c9feb77d5f1472e981aab6b1947c4fab6d05b67
+size 9342
diff --git a/testing/baselines/TestInteractionConsoleAutoCompleteReaderOptions.png b/testing/baselines/TestInteractionConsoleAutoCompleteReaderOptions.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:56cf9c87dd900e83f2a7c831ebf62bccd39d15b4e167056ddd3d1541058aed49
-size 11017
+oid sha256:e4a8917178a14cd910cea5616a7cdb0496ea72f4802ca24e1e602bc5f2951b79
+size 12037
diff --git a/testing/baselines/TestInteractionConsoleClear.png b/testing/baselines/TestInteractionConsoleClear.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:3125bcebe064a6754f9b85a29640bd03d0863f1a1fb7b5b56c80c155eef181df
-size 19527
+oid sha256:3123e86bfdeb0ef3a5d66e124c77f488fa6e08837992eb5553d98979513deea1
+size 20660
diff --git a/testing/baselines/TestInteractionConsoleEmptyCommand.png b/testing/baselines/TestInteractionConsoleEmptyCommand.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6202b5b590b3315b6f33d98fead7e6607aefc50aba76df6d6554577659ac6036
-size 5081
+oid sha256:b55d45abcf8cb29d6ba60b99137e562404fcacc1a939946b3a5107e25dbeb50e
+size 6251
diff --git a/testing/baselines/TestInteractionConsoleHistory.png b/testing/baselines/TestInteractionConsoleHistory.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:a12b4e708a2e9824c2bb62b32ba780a8c8a5d9108a35456e26955a523ecee49f
-size 11010
+oid sha256:0c20f29c7fca150de42eb97d074fdad07f3d691301bd7649324b1f02ed72f372
+size 12091
diff --git a/testing/baselines/TestInteractionConsoleHistoryEmpty.png b/testing/baselines/TestInteractionConsoleHistoryEmpty.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:eae8378c369f4c4fee53dc205c96e70c24f8d5da789e76709782684370e67b0f
-size 3860
+oid sha256:0e986e76328706fb35e51b269e3ec80c7c5fe37e113ae06ec01bc285a5fb539f
+size 5002
diff --git a/testing/baselines/TestInteractionConsoleHistoryHide.png b/testing/baselines/TestInteractionConsoleHistoryHide.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:cf0f35d9b745073aa351703d160314d459f894f0b0121ff9a76ebbe5561772d7
-size 9801
+oid sha256:a058656526c64e6732e341798833a45004e31d13b2ca88b2a4c587a369f367ed
+size 10935
diff --git a/testing/baselines/TestInteractionConsoleInvalidCommand.png b/testing/baselines/TestInteractionConsoleInvalidCommand.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:34f902745a9015682e493695de45e30923faf7d9a428500b55b448b1fefeda69
-size 9284
+oid sha256:21b57b22f3cb10d4540531b88d215ec3b245cdbdaed2f8cfa49f9ba3fe445056
+size 10369
diff --git a/testing/baselines/TestInteractionConsoleInvalidOption.png b/testing/baselines/TestInteractionConsoleInvalidOption.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:fd1a087261c862aafb757e855e1df080a6907ce4740a2946bf7fb876a975046b
-size 11030
+oid sha256:453ee04803d8cb99780d27895f77cdcad30cadd96cc138b782b2545c02024291
+size 12121
diff --git a/testing/baselines/TestInteractionConsoleOpen.png b/testing/baselines/TestInteractionConsoleOpen.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6202b5b590b3315b6f33d98fead7e6607aefc50aba76df6d6554577659ac6036
-size 5081
+oid sha256:b55d45abcf8cb29d6ba60b99137e562404fcacc1a939946b3a5107e25dbeb50e
+size 6251
diff --git a/testing/baselines/TestInteractionConsoleOpenWarningClick.png b/testing/baselines/TestInteractionConsoleOpenWarningClick.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:2b8822ddd430c90e0b17bcab7b05a42ab84ea4d8ddee81def75d59738c737ca6
-size 8900
+oid sha256:6b50da5de487d8b6b8a8facf979b8d70c1078a1c034f77907daeb8ee91d22333
+size 9996
diff --git a/testing/baselines/TestInteractionConsoleOpenWarningKeyboard.png b/testing/baselines/TestInteractionConsoleOpenWarningKeyboard.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:2b8822ddd430c90e0b17bcab7b05a42ab84ea4d8ddee81def75d59738c737ca6
-size 8900
+oid sha256:6b50da5de487d8b6b8a8facf979b8d70c1078a1c034f77907daeb8ee91d22333
+size 9996
diff --git a/testing/baselines/TestInteractionConsoleOverCheatSheet.png b/testing/baselines/TestInteractionConsoleOverCheatSheet.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6202b5b590b3315b6f33d98fead7e6607aefc50aba76df6d6554577659ac6036
-size 5081
+oid sha256:b55d45abcf8cb29d6ba60b99137e562404fcacc1a939946b3a5107e25dbeb50e
+size 6251
diff --git a/testing/baselines/TestInteractionConsoleScrollbar.png b/testing/baselines/TestInteractionConsoleScrollbar.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:69b1dd21fc218caf1e0834cd8765645b154dee03898ff8043c80a579fa5a4ee2
-size 9409
+oid sha256:a484a749c281cf4e4bd84a0f0d8deaa1e36abebcd1153743afcd4d1bed6b6a53
+size 10419
diff --git a/testing/baselines/TestInteractionConsoleTypingSceneInfo.png b/testing/baselines/TestInteractionConsoleTypingSceneInfo.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:302d8aaf9c390d9a491f3e33131a71274c218107222456ad1f4b2cade70ba2d8
-size 24788
+oid sha256:2dd1e183e894b690b19ff4112849d302a78009e1a4af510fbc9f6f30fe493520
+size 25820
diff --git a/testing/baselines/TestInteractionMinimalConsoleOpen.png b/testing/baselines/TestInteractionMinimalConsoleOpen.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:d95b483995536ebe9057b70703283b29d5e59eb3a9adacc5800127a68f9507e1
-size 5100
+oid sha256:2509525611e932b03a4825f4cd2650f9b7b55dac40ec4264d3d1d591aca8877b
+size 5101
diff --git a/testing/baselines/TestInteractionMinimalConsoleOverCheatSheet.png b/testing/baselines/TestInteractionMinimalConsoleOverCheatSheet.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:e1033a1b0bcf06399789ba225fb12585fbc6ffdca523e8572eb6fdd33c9fc4ca
-size 5097
+oid sha256:2509525611e932b03a4825f4cd2650f9b7b55dac40ec4264d3d1d591aca8877b
+size 5101
diff --git a/testing/baselines/TestInteractionMinimalConsoleOverCheatSheetAndFilename.png b/testing/baselines/TestInteractionMinimalConsoleOverCheatSheetAndFilename.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:e1033a1b0bcf06399789ba225fb12585fbc6ffdca523e8572eb6fdd33c9fc4ca
-size 5097
+oid sha256:2509525611e932b03a4825f4cd2650f9b7b55dac40ec4264d3d1d591aca8877b
+size 5101
diff --git a/testing/baselines/TestInteractionMinimalConsoleResize.png b/testing/baselines/TestInteractionMinimalConsoleResize.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:bc5cb1db20d8bf41d5852f5e84e14bcdb8b212f73353cb81b83b39762972c181
-size 5306
+oid sha256:220277e32806d0381dfc379342205f5bcec673eb8ae69d1e37ac5457352b7019
+size 5310
diff --git a/testing/baselines/TestSDKConsole.png b/testing/baselines/TestSDKConsole.png
@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:6e6e28bc61b57349e35651d43a24bc581940b5f47512eaf11de99793d757a37d
-size 6276
+oid sha256:c70eaee5f1d21ea4bf4c60e458aa2bed742cf704d67f8d9b81b0c950c66bf005
+size 7383
diff --git a/vtkext/private/module/CMakeLists.txt b/vtkext/private/module/CMakeLists.txt
@@ -120,6 +120,10 @@ if(F3D_MODULE_WEBP)
   list(APPEND classes vtkF3DWebPReader)
 endif()
 
+if(F3D_MODULE_CLIP)
+  find_package(clip REQUIRED)
+endif()
+
 if(F3D_MODULE_UI AND NOT F3D_USE_EXTERNAL_IMGUI)
   list(APPEND sources
     "${F3D_SOURCE_DIR}/external/imgui/imgui.cpp"
@@ -151,6 +155,11 @@ if(F3D_MODULE_WEBP)
   vtk_module_link(f3d::vtkextPrivate PRIVATE WebP::webp)
 endif()
 
+if(F3D_MODULE_CLIP)
+  vtk_module_definitions(f3d::vtkextPrivate PRIVATE F3D_MODULE_CLIP)
+  vtk_module_link(f3d::vtkextPrivate PRIVATE clip::clip)
+endif()
+
 # imgui
 if (F3D_MODULE_UI)
   vtk_module_definitions(f3d::vtkextPrivate PRIVATE F3D_MODULE_UI)
diff --git a/vtkext/private/module/vtkF3DImguiActor.cxx b/vtkext/private/module/vtkF3DImguiActor.cxx
@@ -31,6 +31,10 @@
 #include <vtk_glew.h>
 #endif
 
+#ifdef F3D_MODULE_CLIP
+#include <clip.h>
+#endif
+
 #include <imgui.h>
 #include <numeric>
 #include <optional>
@@ -81,6 +85,22 @@ struct vtkF3DImguiActor::Internals
       // Store our identifier
       io.Fonts->SetTexID((ImTextureID)this->FontTexture.Get());
 
+      // Setup copy/paste callbacks
+#ifdef F3D_MODULE_CLIP
+      static std::string imgui_clipboard_storage;
+      io.ClipboardUserData = &imgui_clipboard_storage;
+      io.SetClipboardTextFn = [](void* user_data, const char* text) { clip::set_text(text); };
+      io.GetClipboardTextFn = [](void* user_data) -> const char*
+      {
+        auto storage = static_cast<std::string*>(user_data);
+        if (!clip::get_text(*storage))
+        {
+          storage->clear();
+        }
+        return storage->c_str();
+      };
+#endif
+
       // Create VBO
       this->VertexBuffer = vtkSmartPointer<vtkOpenGLBufferObject>::New();
 
diff --git a/vtkext/private/module/vtkF3DImguiConsole.cxx b/vtkext/private/module/vtkF3DImguiConsole.cxx
@@ -360,6 +360,30 @@ void vtkF3DImguiConsole::ShowConsole(bool minimal)
     }
   }
 
+#ifdef F3D_MODULE_CLIP
+  if (!minimal)
+  {
+    ImGui::SetCursorPos(ImVec2{ windowWidth - ImGui::CalcTextSize("Copy").x - padding * 2,
+      viewport->WorkSize.y - ImGui::CalcTextSize("Copy").y * 5 });
+    ImGui::BeginChild("Copy button");
+    const auto [r, g, b] = F3DStyle::GetF3DGrey();
+    ImGui::PushStyleColor(ImGuiCol_Button, ImVec4(r, g, b, 1.0f));
+    ImGui::PushStyleColor(ImGuiCol_ButtonHovered, ImVec4(r, g, b, 0.8f));
+
+    if (ImGui::Button("Copy"))
+    {
+      std::ostringstream oss;
+      for (const auto& [severity, msg] : this->Pimpl->Logs)
+      {
+        oss << msg << '\n';
+      }
+      ImGui::SetClipboardText(oss.str().c_str());
+    }
+    ImGui::PopStyleColor(2);
+    ImGui::EndChild();
+  }
+#endif
+
   ImGui::End();
 }
 
