Merge branch 'master' of https://github.com/jchanvfx/NodeGraphQt

Author: Leandro Inocencio

NodeGraphQt/__init__.py

@@ -74,10 +74,10 @@ def __init__(self):
 """
 
 try:
-    from Qt import QtWidgets, QtGui, QtCore, QtCompat
+    from Qt import QtWidgets, QtGui, QtCore, QtCompat, QtOpenGL
 except ImportError as ie:
     from .vendor.Qt import __version__ as qtpy_ver
-    from .vendor.Qt import QtWidgets, QtGui, QtCore, QtCompat
+    from .vendor.Qt import QtWidgets, QtGui, QtCore, QtCompat ,QtOpenGL
     print('Cannot import "Qt.py" module falling back on '
           '"NodeGraphQt.vendor.Qt ({})"'.format(qtpy_ver))
 

NodeGraphQt/base/commands.py

@@ -51,15 +51,29 @@ def set_node_prop(self, name, value):
             setattr(view, name, value)
 
     def undo(self):
-        if self.old_val != self.new_val:
+        do_undo = False
+        try:
+            if self.old_val != self.new_val:
+                do_undo = True
+        except:
+            do_undo = True
+
+        if do_undo:
             self.set_node_prop(self.name, self.old_val)
 
             # emit property changed signal.
             graph = self.node.graph
             graph.property_changed.emit(self.node, self.name, self.old_val)
 
     def redo(self):
-        if self.old_val != self.new_val:
+        do_redo = False
+        try:
+            if self.old_val != self.new_val:
+                do_redo = True
+        except:
+            do_redo = True
+
+        if do_redo:
             self.set_node_prop(self.name, self.new_val)
 
             # emit property changed signal.

NodeGraphQt/base/graph.py

@@ -3,6 +3,7 @@
 import json
 import os
 import re
+import copy
 
 from NodeGraphQt import QtCore, QtWidgets
 from NodeGraphQt.base.commands import (NodeAddedCmd,
@@ -12,7 +13,7 @@
 from NodeGraphQt.base.factory import NodeFactory
 from NodeGraphQt.base.menu import NodeGraphMenu, NodesMenu
 from NodeGraphQt.base.model import NodeGraphModel
-from NodeGraphQt.base.node import NodeObject
+from NodeGraphQt.base.node import NodeObject, BaseNode
 from NodeGraphQt.base.port import Port
 from NodeGraphQt.constants import (DRAG_DROP_ID,
                                    PIPE_LAYOUT_CURVED,
@@ -88,7 +89,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')
@@ -132,6 +139,10 @@ def _insert_node(self, pipe, node_id, prev_node_pos):
         """
         node = self.get_node_by_id(node_id)
 
+        # exclude the BackdropNode
+        if not isinstance(node, BaseNode):
+            return
+
         disconnected = [(pipe.input_port, pipe.output_port)]
         connected = []
 
@@ -140,7 +151,9 @@ def _insert_node(self, pipe, node_id, prev_node_pos):
                 (pipe.output_port, list(node.inputs().values())[0].view)
             )
         if node.outputs():
-            connected.append((node.output(0).view, pipe.input_port))
+            connected.append(
+                (list(node.outputs().values())[0].view, pipe.input_port)
+            )
 
         self._undo_stack.beginMacro('inserted node')
         self._on_connection_changed(disconnected, connected)
@@ -167,8 +180,13 @@ def _on_property_bin_changed(self, node_id, prop_name, prop_value):
         node = self.get_node_by_id(node_id)
 
         # prevent signals from causing a infinite loop.
+        _exc = [float, int , str, bool, None]
         if node.get_property(prop_name) != prop_value:
-            node.set_property(prop_name, prop_value)
+            if type(node.get_property(prop_name)) in _exc:
+                value = prop_value
+            else:
+                value = copy.deepcopy(prop_value)
+            node.set_property(prop_name, value)
 
     def _on_node_double_clicked(self, node_id):
         """
@@ -884,6 +902,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):
         """
@@ -1022,6 +1041,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.
@@ -1048,6 +1070,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):
         """
@@ -1198,3 +1221,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/menu.py

@@ -161,24 +161,32 @@ class NodesMenu(NodeGraphMenu):
         nodes_menu = node_graph.get_context_menu('nodes')
     """
 
-    def add_command(self, name, func=None, node_type=None):
+    def add_command(self, name, func=None, node_type=None, node_class=None):
         """
         Re-implemented to add a command to the specified node type menu.
 
         Args:
             name (str): command name.
             func (function): command function eg. "func(``graph``, ``node``)".
             node_type (str): specified node type for the command.
+            node_class (class): specified node class for the command.
 
         Returns:
             NodeGraphQt.NodeGraphCommand: the appended command.
         """
-        if not node_type:
-            raise NodeMenuError('Node type not specified!')
+        if not node_type and not node_class:
+            raise NodeMenuError('Node type or Node class not specified!')
+        if node_class:
+            node_type = node_class.__name__
 
         node_menu = self.qmenu.get_menu(node_type)
         if not node_menu:
             node_menu = BaseMenu(node_type, self.qmenu)
+
+            if node_class:
+                node_menu.node_class = node_class
+                node_menu.graph = self._graph
+
             self.qmenu.addMenu(node_menu)
 
         if not self.qmenu.isEnabled():
@@ -190,6 +198,14 @@ def add_command(self, name, func=None, node_type=None):
             action.setShortcutVisibleInContextMenu(True)
         if func:
             action.executed.connect(func)
+
+        if node_class:
+            node_menus = self.qmenu.get_menus(node_class)
+            if node_menu in node_menus:
+                node_menus.remove(node_menu)
+            for menu in node_menus:
+                menu.addAction(action)
+
         qaction = node_menu.addAction(action)
         return NodeGraphCommand(self._graph, qaction)
 

NodeGraphQt/base/model.py

@@ -232,7 +232,19 @@ def to_dict(self):
             node_dict['outputs'] = outputs
 
         custom_props = node_dict.pop('_custom_prop', {})
+
         if custom_props:
+            # exclude the data which can not be serialized (like numpy array)
+            to_remove = []
+            types = [float, str, int, list, dict, bool, None, complex, tuple]
+            for k, v in custom_props.items():
+                if type(v) not in types:
+                    try:
+                        json.dumps(v)
+                    except:
+                        to_remove.append(k)
+            [custom_props.pop(k) for k in to_remove]
+
             node_dict['custom'] = custom_props
 
         exclude = ['_graph_model',

NodeGraphQt/base/node.py

@@ -7,14 +7,19 @@
                                    NODE_PROP_QTEXTEDIT,
                                    NODE_PROP_QCOMBO,
                                    NODE_PROP_QCHECKBOX,
+                                   NODE_PROP_FILE,
+                                   NODE_PROP_FLOAT,
+                                   NODE_PROP_INT,
                                    IN_PORT, OUT_PORT)
 from NodeGraphQt.errors import PortRegistrationError
 from NodeGraphQt.qgraphics.node_backdrop import BackdropNodeItem
 from NodeGraphQt.qgraphics.node_base import NodeItem
 from NodeGraphQt.widgets.node_widgets import (NodeComboBox,
                                               NodeLineEdit,
                                               NodeFloatEdit,
-                                              NodeCheckBox)
+                                              NodeIntEdit,
+                                              NodeCheckBox,
+                                              NodeFilePath)
 
 
 class classproperty(object):
@@ -293,8 +298,11 @@ def set_property(self, name, value):
         """
 
         # prevent signals from causing a infinite loop.
-        if self.get_property(name) == value:
-            return
+        try:
+            if self.get_property(name) == value:
+                return
+        except:
+            pass
 
         if self.graph and name == 'name':
             value = self.graph.get_unique_name(value)
@@ -507,7 +515,7 @@ def add_combo_menu(self, name, label='', items=None, tab=None):
         widget.value_changed.connect(lambda k, v: self.set_property(k, v))
         self.view.add_widget(widget)
 
-    def add_text_input(self, name, label='', text='', tab=None):
+    def add_text_input(self, name, label='', text='', tab=None, multi_line=False):
         """
         Creates a custom property with the :meth:`NodeObject.create_property`
         function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
@@ -522,14 +530,40 @@ def add_text_input(self, name, label='', text='', tab=None):
             label (str): label to be displayed.
             text (str): pre filled text.
             tab (str): name of the widget tab to display in.
+            multi_line (bool): if create multi line property.
         """
+        wid_type = NODE_PROP_QTEXTEDIT if multi_line else NODE_PROP_QLINEEDIT
+
         self.create_property(
-            name, text, widget_type=NODE_PROP_QLINEEDIT, tab=tab)
+            name, text, widget_type=wid_type, tab=tab)
         widget = NodeLineEdit(self.view, name, label, text)
         widget.value_changed.connect(lambda k, v: self.set_property(k, v))
         self.view.add_widget(widget)
 
-    def add_float_input(self, name, label='', value=0.0, tab=None):
+    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_FILE, tab=tab)
+        widget = NodeFilePath(self.view, name, label, text,ext)
+        widget.value_changed.connect(lambda k, v: self.set_property(k, v))
+        self.view.add_widget(widget)
+
+    def add_float_input(self, name, label='', value=0.0, range=None, tab=None):
         """
         Creates a custom property with the :meth:`NodeObject.create_property`
         function and embeds a :class:`PySide2.QtWidgets.QLineEdit` widget
@@ -543,14 +577,38 @@ def add_float_input(self, name, label='', value=0.0, tab=None):
             name (str): name for the custom property.
             label (str): label to be displayed.
             value (float): pre filled value.
+            range (tuple): slider range
             tab (str): name of the widget tab to display in.
         """
         self.create_property(
-            name, value, widget_type=NODE_PROP_QLINEEDIT, tab=tab)
+            name, value, widget_type=NODE_PROP_FLOAT, range=range, tab=tab)
         widget = NodeFloatEdit(self.view, name, label, value)
         widget.value_changed.connect(lambda k, v: self.set_property(k, v))
         self.view.add_widget(widget)
 
+    def add_int_input(self, name, label='', value=0, range=None, tab=None):
+        """
+        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.
+            value (int): pre filled value.
+            range (tuple): slider range
+            tab (str): name of the widget tab to display in.
+        """
+        self.create_property(
+            name, value, widget_type=NODE_PROP_INT, range=range, tab=tab)
+        widget = NodeIntEdit(self.view, name, label, value)
+        widget.value_changed.connect(lambda k, v: self.set_property(k, v))
+        self.view.add_widget(widget)
+
     def add_checkbox(self, name, label='', text='', state=False, tab=None):
         """
         Creates a custom property with the :meth:`NodeObject.create_property`

NodeGraphQt/base/port.py

@@ -204,3 +204,19 @@ def disconnect_from(self, port=None):
         # emit "port_disconnected" signal from the parent graph.
         ports = {p.type_(): p for p in [self, port]}
         graph.port_disconnected.emit(ports[IN_PORT], ports[OUT_PORT])
+
+    @property
+    def color(self):
+        return self.__view.color
+
+    @color.setter
+    def color(self, color=(0, 0, 0, 255)):
+        self.__view.color = color
+
+    @property
+    def border_color(self):
+        return self.__view.border_color
+
+    @border_color.setter
+    def border_color(self, color=(0, 0, 0, 255)):
+        self.__view.border_color = color

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 Session', _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.