Add "label" as an internal attribute

Setting the "label" internal attribute allows to give a custom label to replace the node's default label.
alicevision · Aug 1, 2022 · 5fa9626 · 5fa9626
1 parent 7d2e9ed
commit 5fa9626
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/meshroom/core/attribute.py b/meshroom/core/attribute.py
@@ -165,6 +165,10 @@ def _set_value(self, value):
         # TODO: only update the graph if this attribute participates to a UID
         if self.isInput:
             self.requestGraphUpdate()
+            # TODO: only call update of the node if the attribute is internal
+            # Internal attributes are set as inputs
+            self.requestNodeUpdate()
+
         self.valueChanged.emit()
 
     def upgradeValue(self, exportedValue):
@@ -178,6 +182,12 @@ def requestGraphUpdate(self):
             self.node.graph.markNodesDirty(self.node)
             self.node.graph.update()
 
+    def requestNodeUpdate(self):
+        # Update specific node information that do not affect the rest of the graph
+        # (like internal attributes)
+        if self.node:
+            self.node.updateInternalAttributes()
+
     @property
     def isOutput(self):
         return self._isOutput

diff --git a/meshroom/core/desc.py b/meshroom/core/desc.py
@@ -438,6 +438,13 @@ class Node(object):
             value="",
             semantic="multiline",
             uid=[0],
+        ),
+        StringParam(
+            name="label",
+            label="Label",
+            description="Custom label to replace the node's default label.",
+            value="",
+            uid=[0],
         )
     ]
     inputs = []

diff --git a/meshroom/core/node.py b/meshroom/core/node.py
@@ -518,6 +518,8 @@ def getLabel(self):
         Returns:
             str: the high-level label of this node
         """
+        if self._internalAttributes.get("label").value.strip():
+            return self._internalAttributes.get("label").value.strip()
         return self.nameToLabel(self._name)
 
     @Slot(str, result=str)
@@ -819,6 +821,9 @@ def updateInternals(self, cacheDir=None):
         if self.internalFolder != folder:
             self.internalFolderChanged.emit()
 
+    def updateInternalAttributes(self):
+        self.internalAttributesChanged.emit()
+
     @property
     def internalFolder(self):
         return self._internalFolder.format(**self._cmdVars)
@@ -1052,6 +1057,7 @@ def canBeCanceled(self):
     y = Property(float, lambda self: self._position.y, notify=positionChanged)
     attributes = Property(BaseObject, getAttributes, constant=True)
     internalAttributes = Property(BaseObject, getInternalAttributes, constant=True)
+    internalAttributesChanged = Signal()
     internalFolderChanged = Signal()
     internalFolder = Property(str, internalFolder.fget, notify=internalFolderChanged)
     depthChanged = Signal()

diff --git a/meshroom/ui/qml/GraphEditor/Node.qml b/meshroom/ui/qml/GraphEditor/Node.qml
@@ -69,6 +69,10 @@ Item {
             root.x = root.node.x
             root.y = root.node.y
         }
+
+        onInternalAttributesChanged: {
+            nodeLabel.text = node ? node.label : ""
+        }
     }
 
     // Whether an attribute can be displayed as an attribute pin on the node
@@ -179,6 +183,7 @@ Item {
 
                         // Node Name
                         Label {
+                            id: nodeLabel
                             Layout.fillWidth: true
                             text: node ? node.label : ""
                             padding: 4