add new node widget and improve graph performance

Author: ArnoChenFx

NodeGraphQt/base/graph.py

@@ -88,7 +88,13 @@ class NodeGraph(QtCore.QObject):
     :parameters: :class:`PySide2.QtCore.QMimeData`, :class:`PySide2.QtCore.QPoint`
     :emits: mime data, node graph position
     """
+    session_changed = QtCore.Signal(str)
+    """
+    Signal is triggered when session has been changed.
 
+    :parameters: :str
+    :emits: new session path
+    """
     def __init__(self, parent=None):
         super(NodeGraph, self).__init__(parent)
         self.setObjectName('NodeGraphQt')
@@ -890,6 +896,7 @@ def clear_session(self):
             self._undo_stack.push(NodeRemovedCmd(self, n))
         self._undo_stack.clear()
         self._model.session = None
+        self.session_changed.emit("")
 
     def _serialize(self, nodes):
         """
@@ -1028,6 +1035,9 @@ def save_session(self, file_path):
         with open(file_path, 'w') as file_out:
             json.dump(serliazed_data, file_out, indent=2, separators=(',', ':'))
 
+        self._model.session = file_path
+        self.session_changed.emit(file_path)
+
     def load_session(self, file_path):
         """
         Load node graph session layout file.
@@ -1054,6 +1064,7 @@ def load_session(self, file_path):
         self._deserialize(layout_data)
         self._undo_stack.clear()
         self._model.session = file_path
+        self.session_changed.emit(file_path)
 
     def copy_nodes(self, nodes=None):
         """
@@ -1204,3 +1215,9 @@ def save_dialog(self, current_dir=None, ext=None):
             str: selected file path.
         """
         return self._viewer.save_dialog(current_dir, ext)
+
+    def use_opengl(self):
+        """
+        use opengl to draw the graph
+        """
+        self._viewer.use_opengl()

NodeGraphQt/base/node.py

@@ -14,7 +14,8 @@
 from NodeGraphQt.widgets.node_widgets import (NodeComboBox,
                                               NodeLineEdit,
                                               NodeFloatEdit,
-                                              NodeCheckBox)
+                                              NodeCheckBox,
+                                              NodeFilePath)
 
 
 class classproperty(object):
@@ -532,6 +533,30 @@ def add_text_input(self, name, label='', text='', tab=None):
         widget.value_changed.connect(lambda k, v: self.set_property(k, v))
         self.view.add_widget(widget)
 
+    def add_file_input(self, name, label='', text='', tab=None, ext="*"):
+        """
+        Creates a custom property with the :meth:`NodeObject.create_property`
+        function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
+        into the node.
+
+        Note:
+            The embedded widget is wired up to the :meth:`NodeObject.set_property`
+            function use this function to to update the widget.
+
+        Args:
+            name (str): name for the custom property.
+            label (str): label to be displayed.
+            text (str): pre filled text.
+            tab (str): name of the widget tab to display in.
+            ext (str): file ext
+        """
+        self.create_property(
+            name, text, widget_type=NODE_PROP_QLINEEDIT, tab=tab)
+        widget = NodeFilePath(self.view, name, label, text,ext)
+        widget.value_changed.connect(lambda k, v: self.set_property(k, v))
+        widget._node = self
+        self.view.add_widget(widget)
+
     def add_float_input(self, name, label='', value=0.0, tab=None):
         """
         Creates a custom property with the :meth:`NodeObject.create_property`

NodeGraphQt/base/utils.py

@@ -35,7 +35,7 @@ def setup_context_menu(graph):
     file_menu.add_command('Open...', _open_session, QtGui.QKeySequence.Open)
     file_menu.add_command('Save...', _save_session, QtGui.QKeySequence.Save)
     file_menu.add_command('Save As...', _save_session_as, 'Ctrl+Shift+s')
-    file_menu.add_command('Clear', _clear_session)
+    file_menu.add_command('New', _new_session)
 
     file_menu.add_separator()
 
@@ -150,9 +150,9 @@ def _save_session_as(graph):
         graph.save_session(file_path)
 
 
-def _clear_session(graph):
+def _new_session(graph):
     """
-    Prompts a warning dialog to clear the node graph session.
+    Prompts a warning dialog to new a node graph session.
 
     Args:
         graph (NodeGraphQt.NodeGraph): node graph.

NodeGraphQt/constants.py

@@ -2,6 +2,7 @@
 # -*- coding: utf-8 -*-
 import os
 from .pkg_info import __version__
+from NodeGraphQt import QtWidgets
 
 #: Current version of the NodeGraphQt framework.
 VERSION = __version__
@@ -91,3 +92,12 @@
 Z_VAL_NODE = 1
 Z_VAL_PORT = 2
 Z_VAL_NODE_WIDGET = 3
+
+
+# === ITEM CACHE MODE ===
+
+# QGraphicsItem.NoCache
+# QGraphicsItem.ItemCoordinateCache
+# QGraphicsItem.DeviceCoordinateCache
+
+ITEM_CACHE_MODE = QtWidgets.QGraphicsItem.DeviceCoordinateCache

NodeGraphQt/qgraphics/node_abstract.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 from NodeGraphQt import QtCore, QtWidgets
 
-from NodeGraphQt.constants import Z_VAL_NODE, NODE_WIDTH, NODE_HEIGHT
+from NodeGraphQt.constants import Z_VAL_NODE, NODE_WIDTH, NODE_HEIGHT, ITEM_CACHE_MODE
 
 
 class AbstractNodeItem(QtWidgets.QGraphicsItem):
@@ -26,6 +26,8 @@ def __init__(self, name='node', parent=None):
         self._width = NODE_WIDTH
         self._height = NODE_HEIGHT
 
+        self.setCacheMode(ITEM_CACHE_MODE)
+
     def __repr__(self):
         return '{}.{}(\'{}\')'.format(
             self.__module__, self.__class__.__name__, self.name)

NodeGraphQt/qgraphics/node_base.py

@@ -5,12 +5,12 @@
                                    NODE_WIDTH, NODE_HEIGHT,
                                    NODE_ICON_SIZE, ICON_NODE_BASE,
                                    NODE_SEL_COLOR, NODE_SEL_BORDER_COLOR,
-                                   PORT_FALLOFF, Z_VAL_NODE, Z_VAL_NODE_WIDGET)
+                                   PORT_FALLOFF, Z_VAL_NODE, Z_VAL_NODE_WIDGET,
+                                   ITEM_CACHE_MODE)
 from NodeGraphQt.errors import NodeWidgetError
 from NodeGraphQt.qgraphics.node_abstract import AbstractNodeItem
 from NodeGraphQt.qgraphics.port import PortItem
 
-
 class XDisabledItem(QtWidgets.QGraphicsItem):
     """
     Node disabled overlay item.
@@ -40,7 +40,9 @@ def paint(self, painter, option, widget):
                 used to describe the parameters needed to draw.
             widget (QtWidgets.QWidget): not used.
         """
+
         painter.save()
+        painter.setClipRect(option.exposedRect)
 
         margin = 20
         rect = self.boundingRect()
@@ -131,6 +133,12 @@ def __init__(self, name='node', parent=None):
         self._input_items = {}
         self._output_items = {}
         self._widgets = {}
+        self._proxy_mode = False
+        self._porxy_mode_threshold = 70
+
+    # def paint(self, painter, option, widget,force=False):
+    #     if self.auto_switch_mode() or force:
+    #         self._paint(self, painter, option, widget)
 
     def paint(self, painter, option, widget):
         """
@@ -142,6 +150,8 @@ def paint(self, painter, option, widget):
                 used to describe the parameters needed to draw.
             widget (QtWidgets.QWidget): not used.
         """
+        self.auto_switch_mode()
+
         painter.save()
         bg_border = 1.0
         rect = QtCore.QRectF(0.5 - (bg_border / 2),
@@ -155,6 +165,7 @@ def paint(self, painter, option, widget):
         path.addRoundedRect(rect, radius, radius)
 
         rect = self.boundingRect()
+
         bg_color = QtGui.QColor(*self.color)
         painter.setBrush(bg_color)
         painter.setPen(QtCore.Qt.NoPen)
@@ -392,7 +403,7 @@ def arrange_widgets(self, v_offset=0.0):
     def arrange_ports(self, v_offset=0.0):
         """
         Arrange input, output ports in the node layout.
-    
+
         Args:
             v_offset (float): port vertical offset.
         """
@@ -468,6 +479,7 @@ def draw_node(self):
         self.arrange_ports(v_offset=height + (height / 2))
         # arrange node widgets
         self.arrange_widgets(v_offset=height / 2)
+        self.update()
 
     def post_init(self, viewer=None, pos=None):
         """
@@ -484,6 +496,42 @@ def post_init(self, viewer=None, pos=None):
         if pos:
             self.xy_pos = pos
 
+    def auto_switch_mode(self):
+        if ITEM_CACHE_MODE is QtWidgets.QGraphicsItem.ItemCoordinateCache:
+            return
+        rect= self.sceneBoundingRect()
+        l = self.viewer().mapToGlobal(self.viewer().mapFromScene(rect.topLeft()))
+        r = self.viewer().mapToGlobal(self.viewer().mapFromScene( rect.topRight()))
+        # with is the node with in screen
+        width = r.x()-l.x()
+
+        self.set_proxy_mode(width < self._porxy_mode_threshold)
+
+    def set_proxy_mode(self,mode):
+        if mode is self._proxy_mode:
+            return
+
+        self._proxy_mode = mode
+
+        visible = not mode
+
+        for w in self._widgets.values():
+            w.widget.setVisible(visible)
+        for port, text in self._input_items.items():
+            port.setVisible(visible)
+            text.setVisible(visible)
+            for pipe in port.connected_pipes:
+                pipe.setVisible(visible)
+
+        for port, text in self._output_items.items():
+            port.setVisible(visible)
+            text.setVisible(visible)
+            for pipe in port.connected_pipes:
+                pipe.setVisible(visible)
+
+        self._text_item.setVisible(visible)
+        self._icon_item.setVisible(visible)
+
     @property
     def icon(self):
         return self._properties['icon']
@@ -500,6 +548,8 @@ def icon(self, path=None):
         if self.scene():
             self.post_init()
 
+        self.update()
+
     @AbstractNodeItem.width.setter
     def width(self, width=0.0):
         w, h = self.calc_size()
@@ -533,17 +583,20 @@ def name(self, name=''):
         self._text_item.setPlainText(name)
         if self.scene():
             self.draw_node()
+        self.update()
 
     @AbstractNodeItem.color.setter
     def color(self, color=(100, 100, 100, 255)):
         AbstractNodeItem.color.fset(self, color)
         if self.scene():
             self.scene().update()
+        self.update()
 
     @AbstractNodeItem.text_color.setter
     def text_color(self, color=(100, 100, 100, 255)):
         AbstractNodeItem.text_color.fset(self, color)
         self._set_text_color(color)
+        self.update()
 
     @property
     def inputs(self):
@@ -566,7 +619,7 @@ def add_input(self, name='input', multi_port=False, display_name=True):
         Args:
             name (str): name for the port.
             multi_port (bool): allow multiple connections.
-            display_name (bool): display the port name. 
+            display_name (bool): display the port name.
 
         Returns:
             PortItem: input item widget
@@ -580,6 +633,7 @@ def add_input(self, name='input', multi_port=False, display_name=True):
         text.font().setPointSize(8)
         text.setFont(text.font())
         text.setVisible(display_name)
+        text.setCacheMode(ITEM_CACHE_MODE)
         self._input_items[port] = text
         if self.scene():
             self.post_init()
@@ -604,6 +658,7 @@ def add_output(self, name='output', multi_port=False, display_name=True):
         text.font().setPointSize(8)
         text.setFont(text.font())
         text.setVisible(display_name)
+        text.setCacheMode(ITEM_CACHE_MODE)
         self._output_items[port] = text
         if self.scene():
             self.post_init()

NodeGraphQt/qgraphics/pipe.py

@@ -7,8 +7,8 @@
     PIPE_HIGHLIGHT_COLOR, PIPE_DISABLED_COLOR,
     PIPE_STYLE_DASHED, PIPE_STYLE_DEFAULT, PIPE_STYLE_DOTTED,
     PIPE_LAYOUT_STRAIGHT, PIPE_WIDTH, IN_PORT, OUT_PORT, Z_VAL_PIPE,
-    Z_VAL_NODE_WIDGET,
-    PIPE_LAYOUT_ANGLE, PIPE_LAYOUT_CURVED)
+    Z_VAL_NODE_WIDGET,PIPE_LAYOUT_ANGLE,
+    PIPE_LAYOUT_CURVED,ITEM_CACHE_MODE)
 from NodeGraphQt.qgraphics.port import PortItem
 
 PIPE_STYLES = {
@@ -39,6 +39,7 @@ def __init__(self, input_port=None, output_port=None):
         self._arrow.append(QtCore.QPointF(-size, size))
         self._arrow.append(QtCore.QPointF(0.0, -size * 1.5))
         self._arrow.append(QtCore.QPointF(size, size))
+        self.setCacheMode(ITEM_CACHE_MODE)
 
     def __repr__(self):
         in_name = self._input_port.name if self._input_port else ''

NodeGraphQt/qgraphics/port.py

@@ -11,7 +11,8 @@
     PORT_HOVER_BORDER_COLOR,
     PORT_ACTIVE_COLOR,
     PORT_ACTIVE_BORDER_COLOR,
-    Z_VAL_PORT)
+    Z_VAL_PORT,
+    ITEM_CACHE_MODE)
 
 
 class PortItem(QtWidgets.QGraphicsItem):
@@ -37,6 +38,8 @@ def __init__(self, parent=None):
         self._port_type = None
         self._multi_connection = False
 
+        self.setCacheMode(ITEM_CACHE_MODE)
+
     def __str__(self):
         return '{}.PortItem("{}")'.format(self.__module__, self.name)
 
@@ -201,6 +204,7 @@ def color(self):
     @color.setter
     def color(self, color=(0, 0, 0, 255)):
         self._color = color
+        self.update()
 
     @property
     def border_color(self):