api: Add QML extension system to register external QML files

Author: Alxiice

meshroom/api/__init__.py

@@ -10,3 +10,7 @@
     register_menu,
     get_registered_menu
 )
+
+from meshroom.api.qml import (
+    registerQmlSource
+)

meshroom/api/qml.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+
+from meshroom.ui.extensions import QmlExtensions
+
+
+def registerQmlSource(folder: str, name: str, major: int = 1, minor: int = 0):
+    QmlExtensions.registerQmlModule(folder, name, major, minor)

meshroom/ui/app.py

@@ -34,6 +34,7 @@
 from meshroom.ui.scene import Scene
 from meshroom.ui.utils import QmlInstantEngine
 from meshroom.ui import commands
+from meshroom.ui.extensions import QmlExtensions
 
 
 class FileStatus(Enum):
@@ -287,6 +288,8 @@ def __init__(self, inputArgs):
         pyside6QmlPath = os.path.join(os.path.dirname(QtCore.__file__), "Qt", "qml")
         if os.path.isdir(pyside6QmlPath):
             self.engine.addImportPath(pyside6QmlPath)
+        # Add registered QML extensions
+        QmlExtensions.registerSources(self.engine)
 
         # Expose the menu manager
         self.engine.rootContext().setContextProperty("MeshroomMenuManager", MeshroomMenuManager(parent=self))

meshroom/ui/extensions.py

@@ -0,0 +1,37 @@
+#!/usr/bin/env python
+
+import logging
+from pathlib import Path
+
+from meshroom.ui.utils import QmlInstantEngine
+
+
+
+class QmlExtensions:
+    """ This object manages QML Extensions.
+    Using this we can register additional sources.
+    """
+
+    _sources = []
+
+    @classmethod
+    def registerQmlModule(cls, folder: str, name: str, major: int = 1, minor: int = 0):
+        if not (Path(folder) / "qmldir").exists():
+            logging.error(f"Failed to register a QML module : no 'qmldir' file found on inside '{folder}'.")
+            return
+        cls._sources.append({
+            "folder": folder,
+            "module": name,
+            "major": major,
+            "minor": minor,
+        })
+        logging.debug(
+            f"Registered QML source: module='{name}' ({major}.{minor}) from '{folder}'"
+        )
+
+    @classmethod
+    def registerSources(cls, engine: QmlInstantEngine):
+        for src in cls._sources:
+            qmlFolder = src["folder"]
+            engine.addFilesFromDirectory(qmlFolder, recursive=True)
+            engine.addImportPath(qmlFolder)