updated docs & BaseNodeCircle updates.

Author: jchanvfx

NodeGraphQt/nodes/base_node_circle.py

@@ -4,6 +4,41 @@
 
 
 class BaseNodeCircle(BaseNode):
+    """
+    `Implemented in` ``v0.5.2``
+
+    The ``NodeGraphQt.BaseNodeCircle`` is pretty much the same class as the
+    :class:`NodeGraphQt.BaseNode` except with a different design.
+
+    **Inherited from:** :class:`NodeGraphQt.BaseNode`
+
+    .. image:: ../_images/node_circle.png
+        :width: 250px
+
+    example snippet:
+
+    .. code-block:: python
+        :linenos:
+
+        from NodeGraphQt import BaseNodeCircle
+
+        class ExampleNode(BaseNodeCircle):
+
+            # unique node identifier domain.
+            __identifier__ = 'io.jchanvfx.github'
+
+            # initial default node name.
+            NODE_NAME = 'My Node'
+
+            def __init__(self):
+                super(ExampleNode, self).__init__()
+
+                # create an input port.
+                self.add_input('in')
+
+                # create an output port.
+                self.add_output('out')
+    """
 
     NODE_NAME = 'Circle Node'
 

NodeGraphQt/qgraphics/node_circle.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 from Qt import QtCore, QtGui, QtWidgets
 
-from NodeGraphQt.constants import NodeEnum, PortEnum
+from NodeGraphQt.constants import NodeEnum
 from NodeGraphQt.qgraphics.node_base import NodeItem
 
 
@@ -21,8 +21,12 @@ def _paint_horizontal(self, painter, option, widget):
         painter.save()
 
         text_rect = self._text_item.boundingRect()
+        text_width = text_rect.width()
+        if text_width < 20.0:
+            text_width = 20.0
+
         text_rect = QtCore.QRectF(
-            self.boundingRect().center().x() - (text_rect.width() / 2),
+            self.boundingRect().center().x() - (text_width / 2),
             self.boundingRect().center().y() - (text_rect.height() / 2),
             text_rect.width(),
             text_rect.height()
@@ -49,7 +53,7 @@ def _paint_horizontal(self, painter, option, widget):
                 if p_text.isVisible():
                     pt_width = p_text.boundingRect().width() * 1.2
                 else:
-                    pt_width = p.boundingRect().width() / 2
+                    pt_width = p.boundingRect().width() / 4
                 pt1 = QtCore.QPointF(
                     p.pos().x() + (p.boundingRect().width() / 2) + pt_width,
                     p.pos().y() + (p.boundingRect().height() / 2)
@@ -66,14 +70,14 @@ def _paint_horizontal(self, painter, option, widget):
                 if p_text.isVisible():
                     pt_width = p_text.boundingRect().width() * 1.2
                 else:
-                    pt_width = p.boundingRect().width() / 2
+                    pt_width = p.boundingRect().width() / 4
                 pt1 = QtCore.QPointF(
                     p.pos().x() + (p.boundingRect().width() / 2) - pt_width,
                     p.pos().y() + (p.boundingRect().height() / 2)
                 )
                 path = QtGui.QPainterPath()
                 path.moveTo(pt1)
-                path.lineTo(QtCore.QPointF(pt1.x() - 4.0, pt1.y()))
+                path.lineTo(QtCore.QPointF(pt1.x() - 2.0, pt1.y()))
                 path.lineTo(rect.center())
                 painter.drawPath(path)
 
@@ -120,21 +124,12 @@ def _paint_horizontal(self, painter, option, widget):
 
     def _paint_vertical(self, painter, option, widget):
         painter.save()
-
-        text_rect = self._text_item.boundingRect()
-        text_rect = QtCore.QRectF(
-            self.boundingRect().center().x() - (text_rect.width() / 2),
-            self.boundingRect().center().y() - (text_rect.height() / 2),
-            text_rect.width(),
-            text_rect.height()
-        )
-
-        padding = 10.0
+        rect = self.boundingRect()
+        width = min(rect.width(), rect.height()) / 1.8
         rect = QtCore.QRectF(
-            text_rect.center().x() - (text_rect.width() / 2) - (padding / 2),
-            text_rect.center().y() - (text_rect.width() / 2) - (padding / 2),
-            text_rect.width() + padding,
-            text_rect.width() + padding
+            rect.center().x() - (width / 2),
+            rect.center().y() - (width / 2),
+            width, width
         )
 
         # draw port lines.
@@ -152,7 +147,7 @@ def _paint_vertical(self, painter, option, widget):
                 )
                 path = QtGui.QPainterPath()
                 path.moveTo(pt1)
-                path.lineTo(QtCore.QPointF(pt1.x(), pt1.y()))
+                path.moveTo(QtCore.QPointF(pt1.x(), pt1.y()))
                 path.lineTo(rect.center())
                 painter.drawPath(path)
 
@@ -192,21 +187,6 @@ def _paint_vertical(self, painter, option, widget):
         painter.setPen(QtGui.QPen(border_color, border_width))
         painter.drawEllipse(rect)
 
-        # node name background.
-        text_rect = self._text_item.boundingRect()
-        text_rect = QtCore.QRectF(
-            rect.center().x() - (text_rect.width() / 2),
-            rect.center().y() - (text_rect.height() / 2),
-            text_rect.width(),
-            text_rect.height()
-        )
-        if self.selected:
-            painter.setBrush(QtGui.QColor(*NodeEnum.SELECTED_COLOR.value))
-        else:
-            painter.setBrush(QtGui.QColor(0, 0, 0, 80))
-        painter.setPen(QtCore.Qt.NoPen)
-        painter.drawRoundedRect(text_rect, 8.0, 8.0)
-
         painter.restore()
 
     def _align_icon_horizontal(self, h_offset, v_offset):
@@ -216,7 +196,11 @@ def _align_icon_horizontal(self, h_offset, v_offset):
         self._icon_item.setPos(x + h_offset, y + v_offset)
 
     def _align_icon_vertical(self, h_offset, v_offset):
-        self._align_icon_horizontal(h_offset, v_offset)
+        rect = self.boundingRect()
+        icon_rect = self._icon_item.boundingRect()
+        x = rect.left() - icon_rect.width() + (rect.width() / 4)
+        y = rect.center().y() - (icon_rect.height() / 2)
+        self._icon_item.setPos(x + h_offset, y + v_offset)
 
     def _align_label_horizontal(self, h_offset, v_offset):
         rect = self.boundingRect()
@@ -226,7 +210,11 @@ def _align_label_horizontal(self, h_offset, v_offset):
         self._text_item.setPos(x + h_offset, y + v_offset)
 
     def _align_label_vertical(self, h_offset, v_offset):
-        self._align_label_horizontal(h_offset, v_offset)
+        rect = self.boundingRect()
+        text_rect = self._text_item.boundingRect()
+        x = rect.right() - (rect.width() / 3)
+        y = rect.center().y() - (text_rect.height() / 2)
+        self._text_item.setPos(x + h_offset, y + v_offset)
 
     def _draw_node_horizontal(self):
         add_width = self.text_item.boundingRect().width() * 1.5
@@ -260,17 +248,14 @@ def _draw_node_horizontal(self):
         self.update()
 
     def _draw_node_vertical(self):
-        add_width = self.text_item.boundingRect().width() * 1.5
-        add_height = self.text_item.boundingRect().width() / 2
-
         # hide the port text items in vertical layout.
         for port, text in self._input_items.items():
             text.setVisible(False)
         for port, text in self._output_items.items():
             text.setVisible(False)
 
         # setup initial base size.
-        self._set_base_size(add_w=add_width, add_h=add_height)
+        self._set_base_size(add_w=50, add_h=50)
         # set text color when node is initialized.
         self._set_text_color(self.text_color)
         # set the tooltip

docs/_images/node_circle.png

@@ -4,3 +4,10 @@ BaseNode
 .. autoclass:: NodeGraphQt.BaseNode
     :members:
     :exclude-members: update_model, set_layout_direction
+
+BaseNode (Circle)
+#################
+
+.. autoclass:: NodeGraphQt.BaseNodeCircle
+    :members:
+    :exclude-members: update_model, set_layout_direction

docs/nodes/BaseNode.rst

@@ -55,9 +55,9 @@
     # create node and set a custom icon.
     n_basic_b = graph.create_node(
         'nodes.basic.BasicNodeB', name='custom icon')
-    this_path = os.path.dirname(os.path.abspath(__file__))
-    icon = os.path.join(this_path, 'examples', 'star.png')
-    n_basic_b.set_icon(icon)
+    n_basic_b.set_icon(
+        os.path.join(os.path.dirname(os.path.abspath(__file__)), 'star.png')
+    )
 
     # create node with the custom port shapes.
     n_custom_ports = graph.create_node(

examples/basic_example.py

@@ -64,6 +64,7 @@ class CircleNode(BaseNodeCircle):
 
     def __init__(self):
         super(CircleNode, self).__init__()
+        self.set_color(10, 24, 38)
 
         # create node inputs
         self.add_input('in 1')