add option to overwrite icons search path

update application screen shot
remove name label in properties widget
expose function to expand/collapse the properties area
promote paremter to start widget with expanded properties

Author: jonassorgenfrei

docs/img/flowpipe-editor.png

@@ -4,28 +4,36 @@
 from flowpipe import Graph, Node
 from Qt import QtGui, QtWidgets
 
+from flowpipe_editor import flowpipe_editor_widget
 from flowpipe_editor.flowpipe_editor_widget import FlowpipeEditorWidget
 
 BASE_PATH = Path(__file__).parent.parent.resolve()
 
+# example to overwrite the icons path for
+flowpipe_editor_widget.ICONS_PATH = Path(
+    Path(flowpipe_editor_widget.__file__).parent.resolve(),
+    "icons",
+)
+
+
 @Node(outputs=["camera_file"], metadata={"interpreter": "3dequalizer"})
 def CreateCamera():
-    """Creates a shot camera.
-    """
+    """Creates a shot camera."""
     return {"camera_file": "/abs/camera.abc"}
 
+
 @Node(outputs=["scene_file"], metadata={"interpreter": "maya"})
 def MayaSceneGeneration(camera_file):
-    """Creates a Maya scene file for rendering.
-    """
+    """Creates a Maya scene file for rendering."""
     return {"scene_file": "/usd/scene.usd"}
 
+
 @Node(outputs=["renderings"], metadata={"interpreter": "houdini"})
 def HoudiniRender(frames, scene_file):
-    """Creates a Houdini scene file for rendering.
-    """
+    """Creates a Houdini scene file for rendering."""
     return {"renderings": "/renderings/file.%04d.exr"}
 
+
 @Node(outputs=["images"])
 def CheckImages(images):
     """Check if the images are valid and return them."""
@@ -58,17 +66,17 @@ def UpdateDatabase(id_, images):
 
 if __name__ == "__main__":
     graph = Graph(name="Rendering")
-    frames, batch_size=30, 30
+    frames, batch_size = 30, 30
     slapcomp = CreateSlapComp(graph=graph, template="nuke_template.nk")
     update_database = UpdateDatabase(graph=graph, id_=123456)
 
-    camera_creation = CreateCamera(graph=graph)    
-    scene_creation = MayaSceneGeneration(graph=graph)    
-    
+    camera_creation = CreateCamera(graph=graph)
+    scene_creation = MayaSceneGeneration(graph=graph)
+
     camera_creation.outputs["camera_file"].connect(
         scene_creation.inputs["camera_file"]
     )
-    
+
     for i in range(0, frames, batch_size):
         houdini_render = HoudiniRender(
             name="HoudiniRender{0}-{1}".format(i, i + batch_size),
@@ -106,13 +114,19 @@ def UpdateDatabase(id_, images):
 
     # Display the graph
     app = QtWidgets.QApplication(sys.argv)
-    app.setWindowIcon(QtGui.QIcon(str(Path(BASE_PATH, 'flowpipe_editor', 'icons', 'flowpipe.png'))))
+    app.setWindowIcon(
+        QtGui.QIcon(
+            str(Path(BASE_PATH, "flowpipe_editor", "icons", "flowpipe.png"))
+        )
+    )
 
     window = QtWidgets.QWidget()
     window.setWindowTitle("Flowpipe-Editor VFX Rendering Example")
     window.resize(1100, 800)
 
-    flowpipe_editor_widget = FlowpipeEditorWidget(parent=window)
+    flowpipe_editor_widget = FlowpipeEditorWidget(
+        expanded_properties=False, parent=window
+    )
     flowpipe_editor_widget.load_graph(graph)
     layout = QtWidgets.QVBoxLayout()
     layout.setContentsMargins(0, 0, 0, 0)
@@ -121,4 +135,4 @@ def UpdateDatabase(id_, images):
 
     window.show()
 
-    sys.exit(app.exec())
+    sys.exit(app.exec())

examples/vfx_rendering.py

@@ -14,6 +14,7 @@
 )
 
 BASE_PATH = Path(__file__).parent.resolve()
+ICONS_PATH = Path(BASE_PATH, "icons")
 
 
 class FlowpipeNode(BaseNode):
@@ -31,10 +32,16 @@ def __init__(self, **kwargs):
 class FlowpipeEditorWidget(QtWidgets.QWidget):
     """Flowpipe editor widget for visualize flowpipe graphs."""
 
-    def __init__(self, parent: QtWidgets.QWidget = None):
+    def __init__(
+        self,
+        expanded_properties: bool = False,
+        parent: QtWidgets.QWidget = None,
+    ):
         """Initialize the Flowpipe editor widget.
 
         Args:
+            expanded_properties (bool, optional): Whether to expand the properties
+                                                    bin initially. Defaults to False.
             parent (QtWidgets.QWidget, optional): Parent Qt Widget. Defaults to None.
         """
         super().__init__(parent)
@@ -64,15 +71,13 @@ def __init__(self, parent: QtWidgets.QWidget = None):
         self.splitter.addWidget(properties_bin)
 
         # hide initially
-        self.splitter.setSizes([1, 0])
-
-        # example show the node properties bin widget when a node is double-clicked.
-        def display_properties_bin():
-            if self.splitter.sizes()[1] == 0:
-                self.splitter.setSizes([700, 10])
+        if not expanded_properties:
+            self.collapse_properties_bin()
+        else:
+            self.expand_properties_bin()
 
         # wire function to "node_double_clicked" signal.
-        self.graph.node_selected.connect(display_properties_bin)
+        self.graph.node_selected.connect(self.expand_properties_bin)
 
         # get the main context menu.
         context_menu = self.graph.get_context_menu("graph")
@@ -85,6 +90,15 @@ def display_properties_bin():
         layout_menu.add_command("Vertical", self.layout_graph_up, "Shift+2")
         apply_dark_theme(self)
 
+    def collapse_properties_bin(self):
+        """Collapse the properties bin to show node properties."""
+        self.splitter.setSizes([1, 0])
+
+    def expand_properties_bin(self):
+        """Expand the properties bin to show node properties."""
+        if self.splitter.sizes()[1] == 0:
+            self.splitter.setSizes([700, 10])
+
     def layout_graph_down(self):
         """
         Auto layout the nodes down stream.
@@ -119,13 +133,15 @@ def _add_node(self, fp_node, point):
 
         # set icon based on interpreter
         if interpreter:
-            icon_path = Path(BASE_PATH, "icons", f"{interpreter}.png")
+            icon_path = Path(ICONS_PATH, f"{interpreter}.png")
             if icon_path.exists():
                 qt_node.set_icon(str(icon_path))
             elif interpreter:
-                qt_node.set_icon(str(Path(BASE_PATH, "icons", "python.png")))
+                qt_node.set_icon(
+                    str(Path(Path(BASE_PATH, "icons"), "python.png"))
+                )
         else:
-            qt_node.set_icon(str(Path(BASE_PATH, "icons", "python.png")))
+            qt_node.set_icon(str(Path(Path(BASE_PATH, "icons"), "python.png")))
 
         for input_ in fp_node.all_inputs().values():
             qt_node.add_input(input_.name)

flowpipe_editor/flowpipe_editor_widget.py

@@ -90,7 +90,6 @@ def __init__(self, parent=None, node=None):
         name_layout = QtWidgets.QHBoxLayout()
         name_layout.setContentsMargins(0, 0, 0, 0)
         name_layout.addWidget(icon_label)
-        name_layout.addWidget(QtWidgets.QLabel("name"))
         name_layout.addWidget(self.name_wgt)
         name_layout.addWidget(close_btn)
         layout = QtWidgets.QVBoxLayout(self)