Cli reader options

application/F3DOptionsTools.cxx

@@ -65,6 +65,7 @@ static inline const std::array<CLIGroup, 8> CLIOptions = {{
       { "no-background", "", "No background when render to file", "<bool>", "1" },
       { "help", "h", "Print help", "", "" }, { "version", "", "Print version details", "", "" },
       { "list-readers", "", "Print the list of readers", "", "" },
+      {"force-reader", "", "Enforce a specific reader", "<reader>", "1"},
       { "list-bindings", "", "Print the list of interaction bindings and exits, ignored with `--no-render`, only considers the first file group.", "", "" },
       { "config", "", "Specify the configuration file to use. absolute/relative path or filename/filestem to search in configuration file locations", "<filePath/filename/fileStem>", "" },
       { "no-config", "", "Do not read the configuration file", "<bool>", "1" },

application/F3DOptionsTools.h

@@ -80,6 +80,7 @@ static inline const std::map<std::string_view, std::string_view> LibOptionsNames
   { "animation-autoplay", "scene.animation.autoplay" },
   { "animation-index", "scene.animation.index" },
   { "animation-speed-factor", "scene.animation.speed_factor" },
+  { "force-reader", "scene.force_reader" },
   { "font-file", "ui.font_file" },
   { "point-sprites", "model.point_sprites.enable" },
   { "point-sprites-type", "model.point_sprites.type" },

doc/user/OPTIONS.md

@@ -14,6 +14,7 @@ Options|Type<br>Default|Description
 -h, \-\-help||Print *help* and exit. Ignore `--verbose`.
 \-\-version||Show *version* information and exit. Ignore `--verbose`.
 \-\-list-readers||List available *readers* and exit. Ignore `--verbose`.
+\-\-reader=\<reader\>|string<br>-|Enforce a specific reader.
 \-\-list-bindings||List available *bindings* and exit. Ignore `--verbose`.
 \-\-list-rendering-backends||List available *rendering backends* and exit. Ignore `--verbose`.
 \-\-config=\<config file path/name/stem\>|string<br>config|Specify the [configuration file](CONFIGURATION_FILE.md) to use. Supports absolute/relative path but also filename/filestem to search for in standard configuration file locations.

library/options.json

@@ -25,6 +25,9 @@
       "orthographic": {
         "type": "bool"
       }
+    },
+    "force_reader": {
+      "type": "string" 
     }
   },
   "render": {

library/private/factory.h

@@ -17,6 +17,8 @@
 #include "reader.h"
 
 #include <map>
+#include <optional>
+#include <string_view>
 #include <vector>
 
 namespace f3d
@@ -44,7 +46,7 @@ class factory
   /**
    * Get the reader that can read the given file, nullptr if none
    */
-  reader* getReader(const std::string& fileName);
+  reader* getReader(const std::string& fileName, std::optional<std::string_view> forceReader);
 
   /**
    * Get the list of the registered plugins

library/src/factory.cxx.in

@@ -40,7 +40,7 @@ factory::plugin_initializer_t factory::getStaticInitializer(const std::string& p
 }
 
 //----------------------------------------------------------------------------
-reader* factory::getReader(const std::string& fileName)
+reader* factory::getReader(const std::string& fileName, std::optional<std::string_view> forceReader)
 {
   int bestScore = -1;
   reader* bestReader = nullptr;
@@ -49,7 +49,11 @@ reader* factory::getReader(const std::string& fileName)
   {
     for (auto r : p->getReaders())
     {
-      if (r->getScore() > bestScore && r->canRead(fileName))
+      if (forceReader.has_value() && r->getName() == *forceReader)
+      {
+        return r->canRead(fileName) ? r.get() : nullptr;
+      }
+      if (r->canRead(fileName) && r->getScore() > bestScore)
       {
         bestScore = r->getScore();
         bestReader = r.get();
@@ -99,4 +103,4 @@ bool factory::registerOnce(plugin* plug)
   }
   return false;
 }
-}
+}

library/src/scene_impl.cxx

@@ -4,13 +4,15 @@
 #include "interactor_impl.h"
 #include "log.h"
 #include "options.h"
+#include "scene.h"
 #include "window_impl.h"
 
 #include "factory.h"
 #include "vtkF3DGenericImporter.h"
 #include "vtkF3DMemoryMesh.h"
 #include "vtkF3DMetaImporter.h"
 
+#include <optional>
 #include <vtkCallbackCommand.h>
 #include <vtkProgressBarRepresentation.h>
 #include <vtkProgressBarWidget.h>
@@ -232,7 +234,8 @@ scene& scene_impl::add(const std::vector<fs::path>& filePaths)
     }
 
     // Recover the importer for the provided file path
-    f3d::reader* reader = f3d::factory::instance()->getReader(filePath.string());
+    f3d::reader* reader = f3d::factory::instance()->getReader(
+      filePath.string(), this->Internals->Options.scene.force_reader);
     if (reader)
     {
       log::debug(
@@ -314,7 +317,8 @@ scene& scene_impl::clear()
 //----------------------------------------------------------------------------
 bool scene_impl::supports(const fs::path& filePath)
 {
-  return f3d::factory::instance()->getReader(filePath.string()) != nullptr;
+  return f3d::factory::instance()->getReader(
+           filePath.string(), this->Internals->Options.scene.force_reader) != nullptr;
 }
 
 //----------------------------------------------------------------------------

library/testing/CMakeLists.txt

@@ -15,6 +15,7 @@ list(APPEND libf3dSDKTests_list
      TestSDKMultiColoring.cxx
      TestSDKOptions.cxx
      TestSDKOptionsIO.cxx
+     TestSDKReaderSelection.cxx
      TestSDKRenderFinalShader.cxx
      TestSDKUtils.cxx
      TestSDKWindowAuto.cxx

library/testing/TestSDKReaderSelection.cxx

@@ -0,0 +1,45 @@
+#include "PseudoUnitTest.h"
+#include "TestSDKHelpers.h"
+
+#include <engine.h>
+#include <log.h>
+#include <scene.h>
+#include <window.h>
+
+namespace fs = std::filesystem;
+int TestSDKReaderSelection(int argc, char* argv[])
+{
+  PseudoUnitTest test;
+
+  f3d::log::setVerboseLevel(f3d::log::VerboseLevel::DEBUG);
+  f3d::engine::autoloadPlugins();
+
+  // Test file path setup
+  std::string monkey = std::string(argv[1]) + "data/red_translucent_monkey.gltf";
+
+  // Test default reader (no preference)
+  {
+    f3d::engine engine = f3d::engine::create(true);
+    f3d::scene& scene = engine.getScene();
+    test("add with a single path", [&]() { scene.add(fs::path(monkey)); });
+  }
+
+  // Test Draco reader; GLTF is by-default
+  {
+    f3d::engine engine = f3d::engine::create(true);
+    engine.getOptions().scene.force_reader = "GLTFDraco";
+    f3d::scene& scene = engine.getScene();
+    test("Draco reader works", [&]() { scene.add(fs::path(monkey)); });
+    test("Reader is GLTFDraco", engine.getOptions().scene.force_reader == "GLTFDraco");
+  }
+
+  // Test GLTF reader;
+  {
+    f3d::engine engine = f3d::engine::create(true);
+    engine.getOptions().scene.force_reader = "GLTF";
+    f3d::scene& scene = engine.getScene();
+    test("GLTF reader works", [&]() { scene.add(fs::path(monkey)); });
+    test("Reader is GLTF", engine.getOptions().scene.force_reader == "GLTF");
+  }
+  return test.result();
+}