Dynamic graph layout switching.

Author: jchanvfx

NodeGraphQt/base/commands.py

@@ -121,6 +121,11 @@ def redo(self):
         self.model.nodes[self.node.id] = self.node
         self.viewer.add_node(self.node.view, self.pos)
 
+        # node width & height is calculated when its added to the scene
+        # so we have to update the node model here.
+        self.node.model.width = self.node.view.width
+        self.node.model.height = self.node.view.height
+
 
 class NodeRemovedCmd(QtWidgets.QUndoCommand):
     """

NodeGraphQt/base/graph.py

@@ -17,11 +17,9 @@
 from NodeGraphQt.base.node import NodeObject
 from NodeGraphQt.base.port import Port
 from NodeGraphQt.constants import (
-    NODE_LAYOUT_DIRECTION,
-    NODE_LAYOUT_HORIZONTAL,
-    NODE_LAYOUT_VERTICAL,
     URI_SCHEME,
     URN_SCHEME,
+    LayoutDirectionEnum,
     PipeLayoutEnum,
     PortTypeEnum,
     ViewerEnum
@@ -789,9 +787,20 @@ def set_pipe_style(self, style=PipeLayoutEnum.CURVED.value):
         style = style if 0 <= style <= pipe_max else PipeLayoutEnum.CURVED.value
         self._viewer.set_pipe_layout(style)
 
+    def layout_direction(self):
+        """
+        Return the current node graph layout direction.
+
+        Returns:
+            int: layout direction.
+        """
+        return self.model.layout_direction
+
     def set_layout_direction(self, direction):
         """
         Sets the node graph layout direction to horizontal or vertical.
+        This function will also override the layout direction on all
+        nodes in the current node graph.
 
         Note:
             By default node graph direction is set to "NODE_LAYOUT_HORIZONTAL".
@@ -804,9 +813,12 @@ def set_layout_direction(self, direction):
         Args:
             direction (int): layout direction.
         """
-        direction_types = [NODE_LAYOUT_HORIZONTAL, NODE_LAYOUT_VERTICAL]
+        direction_types = [e.value for e in LayoutDirectionEnum]
         if direction not in direction_types:
-            direction = NODE_LAYOUT_HORIZONTAL
+            direction = LayoutDirectionEnum.HORIZONTAL.value
+        self._model.layout_direction = direction
+        for node in self.all_nodes():
+            node.set_layout_direction(direction)
         self._viewer.set_layout_direction(direction)
 
     def fit_to_selection(self):
@@ -945,6 +957,9 @@ def format_color(clr):
             if pos:
                 node.model.pos = [float(pos[0]), float(pos[1])]
 
+            # initial node direction layout.
+            node.model.layout_direction = self.layout_direction()
+
             node.update()
 
             if push_undo:
@@ -987,6 +1002,11 @@ def add_node(self, node, pos=None, selected=True, push_undo=True):
         node.NODE_NAME = self.get_unique_name(node.NODE_NAME)
         node.model._graph_model = self.model
         node.model.name = node.NODE_NAME
+
+        # initial node direction layout.
+        node.model.layout_direction = self.layout_direction()
+
+        # update method must be called before it's been added to the viewer.
         node.update()
 
         if push_undo:
@@ -1697,7 +1717,7 @@ def auto_layout_nodes(self, nodes=None, down_stream=True, start_nodes=None):
 
         node_layout_direction = self._viewer.get_layout_direction()
 
-        if node_layout_direction is NODE_LAYOUT_HORIZONTAL:
+        if node_layout_direction is LayoutDirectionEnum.HORIZONTAL.value:
             current_x = 0
             node_height = 120
             for rank in sorted(range(len(rank_map)), reverse=not down_stream):
@@ -1712,7 +1732,7 @@ def auto_layout_nodes(self, nodes=None, down_stream=True, start_nodes=None):
                     current_y += dy * 0.5 + 10
 
                 current_x += max_width * 0.5 + 100
-        elif node_layout_direction is NODE_LAYOUT_VERTICAL:
+        elif node_layout_direction is LayoutDirectionEnum.VERTICAL.value:
             current_y = 0
             node_width = 250
             for rank in sorted(range(len(rank_map)), reverse=not down_stream):
@@ -1992,9 +2012,9 @@ def _build_port_nodes(self):
                 input_nodes[port.name()] = input_node
                 self.add_node(input_node, selected=False, push_undo=False)
                 x, y = input_node.pos()
-                if node_layout_direction is NODE_LAYOUT_HORIZONTAL:
+                if node_layout_direction is LayoutDirectionEnum.HORIZONTAL.value:
                     x -= 100
-                elif node_layout_direction is NODE_LAYOUT_VERTICAL:
+                elif node_layout_direction is LayoutDirectionEnum.VERTICAL.value:
                     y -= 100
                 input_node.set_property('pos', [x, y], push_undo=False)
 
@@ -2010,9 +2030,9 @@ def _build_port_nodes(self):
                 output_nodes[port.name()] = output_node
                 self.add_node(output_node, selected=False, push_undo=False)
                 x, y = output_node.pos()
-                if node_layout_direction is NODE_LAYOUT_HORIZONTAL:
+                if node_layout_direction is LayoutDirectionEnum.HORIZONTAL.value:
                     x += 100
-                elif node_layout_direction is NODE_LAYOUT_VERTICAL:
+                elif node_layout_direction is LayoutDirectionEnum.VERTICAL.value:
                     y += 100
                 output_node.set_property('pos', [x, y], push_undo=False)
 

NodeGraphQt/base/graph_actions.py

@@ -8,11 +8,11 @@ def build_context_menu(graph):
         graph (NodeGraphQt.NodeGraph): node graph controller.
     """
     from Qt import QtGui, QtCore
-    graph_menu = graph.get_context_menu('graph')
+    context_menu = graph.get_context_menu('graph')
 
     # "File" menu.
     # --------------------------------------------------------------------------
-    file_menu = graph_menu.add_menu('&File')
+    file_menu = context_menu.add_menu('&File')
 
     file_menu.add_command('Open...', _open_session, QtGui.QKeySequence.Open)
     file_menu.add_command('Import...', _import_session)
@@ -22,7 +22,7 @@ def build_context_menu(graph):
 
     # "Edit" menu.
     # --------------------------------------------------------------------------
-    edit_menu = graph_menu.add_menu('&Edit')
+    edit_menu = context_menu.add_menu('&Edit')
 
     edit_menu.add_separator()
     edit_menu.add_command('Clear Undo History', _clear_undo)
@@ -49,20 +49,24 @@ def build_context_menu(graph):
     edit_menu.add_command('Zoom Out', _zoom_out, '-')
     edit_menu.add_command('Reset Zoom', _reset_zoom, 'H')
 
-    edit_menu.add_separator()
+    context_menu.add_separator()
 
-    # "Grid Mode" submenu.
+    # "Node" menu.
     # --------------------------------------------------------------------------
-    bg_menu = edit_menu.add_menu('&Grid Mode')
+    graph_menu = context_menu.add_menu('&Graph')
+
+    bg_menu = graph_menu.add_menu('&Background')
     bg_menu.add_command('None', _bg_grid_none)
     bg_menu.add_command('Lines', _bg_grid_lines)
     bg_menu.add_command('Dots', _bg_grid_dots)
 
-    edit_menu.add_separator()
+    layout_menu = graph_menu.add_menu('&Layout')
+    layout_menu.add_command('Horizontal', _layout_h_mode)
+    layout_menu.add_command('Vertical', _layout_v_mode)
 
     # "Node" menu.
     # --------------------------------------------------------------------------
-    node_menu = graph_menu.add_menu('&Nodes')
+    node_menu = context_menu.add_menu('&Nodes')
     node_menu.add_command('Node Search', _toggle_node_search, 'Tab')
     node_menu.add_separator()
     node_menu.add_command(
@@ -76,7 +80,7 @@ def build_context_menu(graph):
 
     # "Pipe" menu.
     # --------------------------------------------------------------------------
-    pipe_menu = graph_menu.add_menu('&Pipes')
+    pipe_menu = context_menu.add_menu('&Pipes')
     pipe_menu.add_command('Curved', _curved_pipe)
     pipe_menu.add_command('Straight', _straight_pipe)
     pipe_menu.add_command('Angle', _angle_pipe)
@@ -109,6 +113,20 @@ def _reset_zoom(graph):
     graph.reset_zoom()
 
 
+def _layout_h_mode(graph):
+    """
+    Set node graph layout direction to horizontal.
+    """
+    graph.set_layout_direction(0)
+
+
+def _layout_v_mode(graph):
+    """
+    Set node graph layout direction to vertical.
+    """
+    graph.set_layout_direction(1)
+
+
 def _open_session(graph):
     """
     Prompts a file open dialog to load a session.

NodeGraphQt/base/model.py

@@ -3,6 +3,7 @@
 from collections import defaultdict
 
 from NodeGraphQt.constants import (
+    LayoutDirectionEnum,
     NODE_PROP,
     NODE_PROP_QLABEL,
     NODE_PROP_QLINEEDIT,
@@ -73,6 +74,7 @@ def __init__(self):
         self.width = 100.0
         self.height = 80.0
         self.pos = [0.0, 0.0]
+        self.layout_direction = LayoutDirectionEnum.HORIZONTAL.value
 
         # BaseNode attrs.
         self.inputs = {}
@@ -107,6 +109,7 @@ def __init__(self):
             'width': NODE_PROP,
             'height': NODE_PROP,
             'pos': NODE_PROP,
+            'layout_direction': NODE_PROP,
             'inputs': NODE_PROP,
             'outputs': NODE_PROP,
         }
@@ -230,6 +233,7 @@ def to_dict(self):
                     'width': 0.0,
                     'height: 0.0,
                     'pos': (0.0, 0.0),
+                    'layout_direction': 0,
                     'custom': {},
                     'inputs': {
                         <port_name>: {<node_id>: [<port_name>, <port_name>]}
@@ -317,6 +321,7 @@ def __init__(self):
         self.session = ''
         self.acyclic = True
         self.pipe_collision = False
+        self.layout_direction = LayoutDirectionEnum.HORIZONTAL.value
 
     def common_properties(self):
         """

NodeGraphQt/base/node.py

@@ -1,10 +1,7 @@
 #!/usr/bin/python
 from NodeGraphQt.base.commands import PropertyChangedCmd
 from NodeGraphQt.base.model import NodeModel
-from NodeGraphQt.constants import (NODE_PROP,
-                                   NODE_LAYOUT_DIRECTION,
-                                   NODE_LAYOUT_VERTICAL,
-                                   NODE_LAYOUT_HORIZONTAL)
+from NodeGraphQt.constants import NODE_PROP
 
 
 class _ClassProperty(object):
@@ -26,21 +23,16 @@ class NodeObject(object):
         :class:`NodeGraphQt.BackdropNode`
 
     Args:
-        qgraphics_views (dict): Dictionary with the node layout type as the key
-            and a custom graphics item subclassed from the ``AbstractNodeItem``
-            as the value.
+        qgraphics_item (AbstractNodeItem): QGraphicsItem item used for drawing.
 
             .. code-block:: python
 
                 # snippet taken from the NodeGraphQt.BaseNode class.
 
                 class BaseNode(NodeObject):
 
-                    def __init__(self, qgraphics_views=None):
-                        qgraphics_views = qgraphics_views or {
-                            NodeGraphQt.constants.NODE_LAYOUT_HORIZONTAL: NodeItem,
-                            NodeGraphQt.constants.NODE_LAYOUT_VERTICAL: NodeItemVertical
-                        }
+                    def __init__(self, qgraphics_item=None):
+                        qgraphics_item = qgraphics_item or NodeItem
                         super(BaseNode, self).__init__(qgraphics_views)
 
     """
@@ -51,29 +43,27 @@ def __init__(self, qgraphics_views=None):
     # Base node name.
     NODE_NAME = None
 
-    def __init__(self, qgraphics_views=None):
+    def __init__(self, qgraphics_item=None):
+        """
+        Args:
+            qgraphics_item (AbstractNodeItem): QGraphicsItem used for drawing.
+        """
         self._graph = None
         self._model = NodeModel()
         self._model.type_ = self.type_
         self._model.name = self.NODE_NAME
 
-        _NodeItem = None
-        if NODE_LAYOUT_DIRECTION is NODE_LAYOUT_VERTICAL:
-            _NodeItem = qgraphics_views.get(NODE_LAYOUT_VERTICAL)
-        elif NODE_LAYOUT_DIRECTION is NODE_LAYOUT_HORIZONTAL:
-            _NodeItem = qgraphics_views.get(NODE_LAYOUT_HORIZONTAL)
-
+        _NodeItem = qgraphics_item
         if _NodeItem is None:
-            raise ValueError(
-                'qgraphics item for the {} node layout can\'t be None!'.format({
-                    NODE_LAYOUT_VERTICAL: 'vertical',
-                    NODE_LAYOUT_HORIZONTAL: 'horizontal'
-                }[NODE_LAYOUT_DIRECTION]))
+            raise RuntimeError(
+                'No qgraphics item specified for the node object!'
+            )
 
         self._view = _NodeItem()
         self._view.type_ = self.type_
         self._view.name = self.model.name
         self._view.id = self._model.id
+        self._view.layout_direction = self._model.layout_direction
 
     def __repr__(self):
         return '<{}("{}") object at {}>'.format(
@@ -217,6 +207,7 @@ def serialize(self):
                 'width': 0.0,
                 'height: 0.0,
                 'pos': (0.0, 0.0),
+                'layout_direction': 0,
                 'custom': {},
                 }
             }
@@ -469,3 +460,25 @@ def pos(self):
             self.model.pos = self.view.xy_pos
 
         return self.model.pos
+
+    def layout_direction(self):
+        """
+        Returns the current node layout direction.
+
+        Returns:
+            int: node layout direction.
+        """
+        return self.model.layout_direction
+
+    def set_layout_direction(self, value=0):
+        """
+        Sets the node layout direction to either horizontal or vertical.
+
+        Note:
+            This function does not register to the undo stack.
+
+        Args:
+            value (int): layout direction mode.
+        """
+        self.model.layout_direction = value
+        self.view.layout_direction = value

NodeGraphQt/constants.py

@@ -58,15 +58,10 @@ class LayoutDirectionEnum(Enum):
     Node graph nodes layout direction:
     :py:mod:`NodeGraphQt.constants.ViewerLayoutEnum`
     """
-    #: layout nodes top to bottom.
-    VERTICAL = 0
     #: layout nodes left to right.
-    HORIZONTAL = 1
-
-
-#: Variable for setting the node layout direction.
-# NODE_LAYOUT_DIRECTION = LayoutDirectionEnum.VERTICAL.value
-NODE_LAYOUT_DIRECTION = LayoutDirectionEnum.HORIZONTAL.value
+    HORIZONTAL = 0
+    #: layout nodes top to bottom.
+    VERTICAL = 1
 
 
 # =================================== VIEWER ===================================