[ui][submitter] Add possibility to switch the submitter in the UI

Author: Alxiice

meshroom/submitters/tractorApi/__init__.py

@@ -8,11 +8,8 @@
 
 from meshroom.core.submitter import BaseSubmitter
 
-try:
-    import submitters.tractorApi as tractorApi
-except ImportError:
-    import tractorApi
-    
+import meshroom.submitters.tractorApi.api as tractorApi
+
 
 currentDir = os.path.dirname(os.path.realpath(__file__))
 binDir = os.path.dirname(os.path.dirname(os.path.dirname(currentDir)))

meshroom/submitters/tractorApi.py renamed to meshroom/submitters/tractorApi/api.py

@@ -14,6 +14,7 @@
 
 import meshroom
 from meshroom.core import pluginManager
+from meshroom.core.submitter import BaseSubmitter
 from meshroom.core.taskManager import TaskManager
 from meshroom.common import Property, Variant, Signal, Slot
 
@@ -265,6 +266,7 @@ def __init__(self, inputArgs):
 
         # instantiate Reconstruction object
         self._undoStack = commands.UndoStack(self)
+        self._defaultSubmitterName = os.environ.get('MESHROOM_DEFAULT_SUBMITTER', '')
         self._taskManager = TaskManager(self)
         self._activeProject = Reconstruction(undoStack=self._undoStack, taskManager=self._taskManager, defaultPipeline=args.pipeline, parent=self)
         self._activeProject.setSubmitLabel(args.submitLabel)
@@ -698,7 +700,28 @@ def _getEnvironmentVariableValue(self, key: str, defaultValue: bool) -> bool:
         if val != True and str(val).lower() in ("0", "false", "off"):
             return False
         return True
-
+    
+    def _submittersList(self):
+        """
+        Get the list of available submitters
+        Model provides :
+            name : the name of the submitter
+            isDefault : True if this is the current submitter
+        """
+        submittersList = []
+        for s in meshroom.core.submitters:
+            submitterName = s.name if isinstance(s, BaseSubmitter) else s
+            submittersList.append({
+                "name": submitterName,
+                "isDefault": True if submitterName == self._defaultSubmitterName else False
+            })
+        return submittersList
+    
+    @Slot(str)
+    def setDefaultSubmitter(self, name):
+        logging.warning(f"Submitter is now set to : {name}")
+        self._defaultSubmitterName = name
+    
     activeProjectChanged = Signal()
     activeProject = Property(Variant, lambda self: self._activeProject, notify=activeProjectChanged)
 
@@ -713,3 +736,4 @@ def _getEnvironmentVariableValue(self, key: str, defaultValue: bool) -> bool:
     recentImportedImagesFolders = Property("QVariantList", _recentImportedImagesFolders, notify=recentImportedImagesFoldersChanged)
     default8bitViewerEnabled = Property(bool, _default8bitViewerEnabled, constant=True)
     defaultSequencePlayerEnabled = Property(bool, _defaultSequencePlayerEnabled, constant=True)
+    submittersListModel = Property("QVariantList", _submittersList, constant=True)

meshroom/submitters/tractorSubmitter.py

@@ -585,7 +585,9 @@ def submit(self, nodes: Optional[Union[list[Node], Node]] = None):
         self.save()  # graph must be saved before being submitted
         self._undoStack.clear()  # the undo stack must be cleared
         nodes = [nodes] if not isinstance(nodes, Iterable) and nodes else nodes
-        self._taskManager.submit(self._graph, os.environ.get('MESHROOM_DEFAULT_SUBMITTER', ''), nodes, submitLabel=self.submitLabel)
+        mrDefaultSubmitter = os.environ.get('MESHROOM_DEFAULT_SUBMITTER', '')
+        chosenSubmitter = self.parent()._defaultSubmitterName or mrDefaultSubmitter
+        self._taskManager.submit(self._graph, chosenSubmitter, nodes, submitLabel=self.submitLabel)
 
     def updateGraphComputingStatus(self):
         # update graph computing status

meshroom/ui/app.py

@@ -928,6 +928,22 @@ Page {
                     onTriggered: _reconstruction.stopExecution()
                     enabled: _reconstruction ? _reconstruction.computingLocally : false
                 }
+                MenuSeparator {}
+                Menu {
+                    id: submitterSelectionMenu
+                    title: "Submitter selection"
+                    enabled: submitterItems.model !== undefined && submitterItems.model.length > 0
+                    Repeater {
+                        id: submitterItems
+                        model: MeshroomApp.submittersListModel
+                        RadioButton {
+                            text: modelData["name"]
+                            checked: modelData["isDefault"]
+                            // checked: MeshroomApp.submittersListModel[0]["name"] == modelData["name"]
+                            onClicked: MeshroomApp.setDefaultSubmitter(modelData["name"])
+                        }
+                    }
+                }
             }
             Menu {
                 title: "Help"