node pos bug fix.

Author: jchanvfx

NodeGraphQt/base/commands.py

@@ -41,6 +41,9 @@ def set_node_prop(self, name, value):
 
         # view properties.
         if name in view.properties.keys():
+            # remap "pos" to "xy_pos" node view has pre-existing pos method.
+            if name == 'pos':
+                name = 'xy_pos'
             setattr(view, name, value)
 
     def undo(self):
@@ -69,13 +72,13 @@ def __init__(self, node, pos, prev_pos):
         self.prev_pos = prev_pos
 
     def undo(self):
-        self.node.view.pos = self.prev_pos
+        self.node.view.xy_pos = self.prev_pos
         self.node.model.pos = self.prev_pos
 
     def redo(self):
         if self.pos == self.prev_pos:
             return
-        self.node.view.pos = self.pos
+        self.node.view.xy_pos = self.pos
         self.node.model.pos = self.pos
 
 

NodeGraphQt/base/graph.py

@@ -6,7 +6,6 @@
 from PySide2 import QtCore
 from PySide2.QtWidgets import QUndoStack, QAction, QApplication
 
-from NodeGraphQt.base.actions import setup_context_menu
 from NodeGraphQt.base.commands import (NodeAddedCmd,
                                        NodeRemovedCmd,
                                        NodeMovedCmd,
@@ -338,14 +337,15 @@ def create_node(self, node_type, name=None, selected=True, color=None, pos=None)
             name (str): set name of the node.
             selected (bool): set created node to be selected.
             color (tuple or str): node color (255, 255, 255) or '#FFFFFF'.
-            pos (tuple): set position of the node (x, y).
+            pos (list[int, int]): initial x, y position for the node (default: (0, 0)).
 
         Returns:
             NodeGraphQt.Node: the created instance of the node.
         """
         NodeCls = self._vendor.create_node_instance(node_type)
         if NodeCls:
             node = NodeCls()
+
             node._graph = self
             node.model._graph_model = self.model
 
@@ -360,21 +360,22 @@ def create_node(self, node_type, name=None, selected=True, color=None, pos=None)
                 for pname, pattrs in prop_attrs.items():
                     graph_attrs[node.type][pname].update(pattrs)
 
-            node.update()
-
-            self._undo_stack.beginMacro('created node')
-            self._undo_stack.push(NodeAddedCmd(self, node, pos))
-            if name:
-                node.set_name(name)
-            else:
-                node.set_name(node.NODE_NAME)
+            node.NODE_NAME = self.get_unique_name(name or node.NODE_NAME)
+            node.model.name = node.NODE_NAME
+            node.model.selected = selected
             if color:
                 if isinstance(color, str):
                     color = color[1:] if color[0] is '#' else color
                     color = tuple(int(color[i:i + 2], 16) for i in (0, 2, 4))
-                node.set_color(*color)
-            node.set_selected(selected)
-            self._undo_stack.endMacro()
+                node.model.color = color
+            if pos:
+                node.model.pos = [float(pos[0]), float(pos[1])]
+
+            node.update()
+
+            undo_cmd = NodeAddedCmd(self, node, node.model.pos)
+            undo_cmd.setText('created node')
+            self._undo_stack.push(undo_cmd)
             self.node_created.emit(node)
             return node
         raise Exception('\n\n>> Cannot find node:\t"{}"\n'.format(node_type))

NodeGraphQt/base/model.py

@@ -57,7 +57,7 @@ def __init__(self):
         self.selected = False
         self.width = 100.0
         self.height = 80.0
-        self.pos = (0.0, 0.0)
+        self.pos = [0.0, 0.0]
         self.inputs = {}
         self.outputs = {}
         self._custom_prop = {}
@@ -99,7 +99,7 @@ def add_property(self, name, value, items=None, range=None, widget_type=NODE_PRO
             widget_type (int): widget type flag.
         """
         if name in self.properties.keys():
-            raise AssertionError('"{}" reserved for defaults.'.format(name))
+            raise AssertionError('"{}" reserved for default property.'.format(name))
         if name in self._custom_prop.keys():
             raise AssertionError('"{}" property already exists.'.format(name))
 

NodeGraphQt/base/node.py

@@ -297,36 +297,36 @@ def has_property(self, name):
         """
         return name in self.model.properties.keys()
 
-    def set_x_pos(self, x=0.0):
+    def set_x_pos(self, x):
         """
         Set the node horizontal X position in the node graph.
 
         Args:
-            x (float): node x position:
+            x (float or int): node X position:
         """
         y = self.pos()[1]
-        self.set_pos(x, y)
+        self.set_pos(float(x), y)
 
-    def set_y_pos(self, y=0.0):
+    def set_y_pos(self, y):
         """
         Set the node horizontal Y position in the node graph.
 
         Args:
-            y (float): node x position:
+            y (float or int): node Y position:
         """
 
         x = self.pos()[0]
-        self.set_pos(x, y)
+        self.set_pos(x, float(y))
 
-    def set_pos(self, x=0.0, y=0.0):
+    def set_pos(self, x, y):
         """
         Set the node X and Y position in the node graph.
 
         Args:
-            x (float): node X position.
-            y (float): node Y position.
+            x (float or int): node X position.
+            y (float or int): node Y position.
         """
-        self.set_property('pos', (x, y))
+        self.set_property('pos', [float(x), float(y)])
 
     def x_pos(self):
         """
@@ -351,10 +351,10 @@ def pos(self):
         Get the node XY position in the node graph.
 
         Returns:
-            tuple(float, float): x, y position.
+            list[float, float]: x, y position.
         """
-        if self.view.pos and self.view.pos != self.model.pos:
-            self.model.pos = self.view.pos
+        if self.view.xy_pos and self.view.xy_pos != self.model.pos:
+            self.model.pos = self.view.xy_pos
 
         return self.model.pos
 

NodeGraphQt/widgets/node_abstract.py

@@ -143,11 +143,11 @@ def selected(self, selected=False):
         self.setSelected(selected)
 
     @property
-    def pos(self):
-        return float(self.scenePos().x()), float(self.scenePos().y())
+    def xy_pos(self):
+        return [float(self.scenePos().x()), float(self.scenePos().y())]
 
-    @pos.setter
-    def pos(self, pos=None):
+    @xy_pos.setter
+    def xy_pos(self, pos=None):
         pos = pos or [0.0, 0.0]
         self.setPos(pos[0], pos[1])
 
@@ -170,7 +170,7 @@ def properties(self):
         """
         props = {'width': self.width,
                  'height': self.height,
-                 'pos':  self.pos}
+                 'pos':  self.xy_pos}
         props.update(self._properties)
         return props
 
@@ -198,7 +198,9 @@ def from_dict(self, node_dict):
         Args:
             node_dict (dict): serialized node dict.
         """
-        node_attrs = list(self._properties.keys()) + ['width', 'height']
+        node_attrs = list(self._properties.keys()) + ['width', 'height', 'pos']
         for name, value in node_dict.items():
             if name in node_attrs:
+                if name == 'pos':
+                    name = 'xy_pos'
                 setattr(self, name, value)

NodeGraphQt/widgets/node_backdrop.py

@@ -207,7 +207,7 @@ def auto_resize(self, nodes=None):
         if nodes:
             padding = 40
             nodes_rect = self._combined_rect(nodes)
-            self.pos = [nodes_rect.x() - padding, nodes_rect.y() - padding]
+            self.xy_pos = [nodes_rect.x() - padding, nodes_rect.y() - padding]
             self._sizer.set_pos(nodes_rect.width() + (padding * 2),
                                 nodes_rect.height() + (padding * 2))
             return
@@ -230,11 +230,11 @@ def pre_init(self, viewer, pos=None):
             group = scene.createItemGroup(nodes)
             rect = group.boundingRect()
             scene.destroyItemGroup(group)
-            self.pos = [rect.x() - padding, rect.y() - padding]
+            self.xy_pos = [rect.x() - padding, rect.y() - padding]
             self._sizer.set_pos(rect.width() + (padding * 2),
                                 rect.height() + (padding * 2))
         else:
-            self.pos = pos
+            self.xy_pos = pos
 
     @property
     def minimum_size(self):

NodeGraphQt/widgets/node_base.py

@@ -480,19 +480,14 @@ def post_init(self, viewer=None, pos=None):
             viewer (NodeGraphQt.widgets.viewer.NodeViewer): not used
             pos (tuple): cursor position.
         """
-        # set initial node position.
-        if pos:
-            self.setPos(pos[0], pos[1])
-
         # setup initial base size.
         self._set_base_size()
         # set text color when node is initialized.
         self._set_text_color(self.text_color)
         # set the tooltip
         self._tooltip_disable(self.disabled)
 
-        # setup node layout
-        # =================
+        # --- setup node layout ---
 
         # arrange label text
         self.arrange_label()
@@ -510,6 +505,10 @@ def post_init(self, viewer=None, pos=None):
         self.arrange_ports(padding_y=35.0)
         self.offset_ports(0.0, 15.0)
 
+        # set initial node position.
+        if pos:
+            self.xy_pos = pos
+
     @property
     def icon(self):
         return self._properties['icon']

NodeGraphQt/widgets/viewer.py

@@ -166,7 +166,9 @@ def mousePressEvent(self, event):
                 node.selected = not node.selected
 
         # update the recorded node positions.
-        self._node_positions.update({n: n.pos for n in self.selected_nodes()})
+        self._node_positions.update(
+            {n: n.xy_pos for n in self.selected_nodes()}
+        )
 
         # show selection selection marquee
         if self.LMB_state and not items:
@@ -197,7 +199,9 @@ def mouseReleaseEvent(self, event):
 
         # find position changed nodes and emit signal.
         moved_nodes = {
-            n: pos for n, pos in self._node_positions.items() if n.pos != pos}
+            n: xy_pos for n, xy_pos in self._node_positions.items()
+            if n.xy_pos != xy_pos
+        }
         if moved_nodes:
             self.moved_nodes.emit(moved_nodes)
 
@@ -313,7 +317,7 @@ def sceneMousePressEvent(self, event):
 
                 # record the node positions at selection time.
                 for n in node_items:
-                    self._node_positions[n] = n.pos
+                    self._node_positions[n] = n.xy_pos
 
                 # emit selected node id with LMB.
                 if event.button() == QtCore.Qt.LeftButton:

docs/_images/example_result.png

@@ -54,7 +54,12 @@ see also: :ref:`Menu & Commands`
 Example
 =======
 
-A basic example snippet.
+Here's a basic example for creating two nodes and connecting them together.
+
+.. image:: _images/example_result.png
+    :width: 60%
+
+example code:
 
 .. code-block:: python
     :linenos:
@@ -101,7 +106,7 @@ A basic example snippet.
 
         # create two nodes.
         node_a = graph.create_node('com.chantasticvfx.FooNode', name='node A')
-        node_b = graph.create_node('com.chantasticvfx.FooNode', name='node B')
+        node_b = graph.create_node('com.chantasticvfx.FooNode', name='node B', pos=(300, 50))
 
         # connect node_a to node_b
         node_a.set_output(0, node_b.input(2))