Updated PIPE constant vars to enums.

jchanvfx · jchanvfx · commit 66dfe986bd07 · 2022-05-23T18:23:47.000+12:00
diff --git a/NodeGraphQt/base/graph.py b/NodeGraphQt/base/graph.py
@@ -5,7 +5,7 @@
 import os
 import re
 
-from Qt import QtCore, QtWidgets, QtGui
+from Qt import QtCore, QtWidgets
 
 from NodeGraphQt.base.commands import (NodeAddedCmd,
                                        NodeRemovedCmd,
@@ -18,7 +18,7 @@
 from NodeGraphQt.base.port import Port
 from NodeGraphQt.constants import (
     NODE_LAYOUT_DIRECTION, NODE_LAYOUT_HORIZONTAL, NODE_LAYOUT_VERTICAL,
-    PIPE_LAYOUT_CURVED, PIPE_LAYOUT_STRAIGHT, PIPE_LAYOUT_ANGLE,
+    PIPE_LAYOUT,
     URI_SCHEME, URN_SCHEME,
     IN_PORT, OUT_PORT,
     VIEWER_GRID_LINES
@@ -752,7 +752,7 @@ def set_pipe_collision(self, mode=True):
         self._model.pipe_collision = mode
         self._viewer.pipe_collision = mode
 
-    def set_pipe_style(self, style=PIPE_LAYOUT_CURVED):
+    def set_pipe_style(self, style=PIPE_LAYOUT.CURVED.value):
         """
         Set node graph pipes to be drawn as straight, curved or angled.
 
@@ -764,17 +764,17 @@ def set_pipe_style(self, style=PIPE_LAYOUT_CURVED):
 
             Pipe Layout Styles:
 
-            * :attr:`NodeGraphQt.constants.PIPE_LAYOUT_CURVED`
-            * :attr:`NodeGraphQt.constants.PIPE_LAYOUT_STRAIGHT`
-            * :attr:`NodeGraphQt.constants.PIPE_LAYOUT_ANGLE`
+            * :attr:`NodeGraphQt.constants.PIPE_LAYOUT.CURVED.value`
+            * :attr:`NodeGraphQt.constants.PIPE_LAYOUT.STRAIGHT.value`
+            * :attr:`NodeGraphQt.constants.PIPE_LAYOUT.ANGLE.value`
 
         Args:
             style (int): pipe layout style.
         """
-        pipe_max = max([PIPE_LAYOUT_CURVED,
-                        PIPE_LAYOUT_STRAIGHT,
-                        PIPE_LAYOUT_ANGLE])
-        style = style if 0 <= style <= pipe_max else PIPE_LAYOUT_CURVED
+        pipe_max = max([PIPE_LAYOUT.CURVED.value,
+                        PIPE_LAYOUT.STRAIGHT.value,
+                        PIPE_LAYOUT.ANGLE.value])
+        style = style if 0 <= style <= pipe_max else PIPE_LAYOUT.CURVED.value
         self._viewer.set_pipe_layout(style)
 
     def fit_to_selection(self):
diff --git a/NodeGraphQt/constants.py b/NodeGraphQt/constants.py
@@ -3,6 +3,7 @@
 import os
 
 from Qt import QtWidgets
+from enum import Enum
 
 from .pkg_info import __version__
 
@@ -11,28 +12,59 @@
 the whole ``NodeGraphQt`` library.
 """
 
+# =================================== GLOBAL ===================================
+
 #: Current version of the NodeGraphQt framework.
 VERSION = __version__
 
-# === PIPE ===
-
-PIPE_WIDTH = 1.2
-PIPE_STYLE_DEFAULT = 0
-PIPE_STYLE_DASHED = 1
-PIPE_STYLE_DOTTED = 2
-PIPE_DEFAULT_COLOR = (175, 95, 30, 255)
-PIPE_DISABLED_COLOR = (190, 20, 20, 255)
-PIPE_ACTIVE_COLOR = (70, 255, 220, 255)
-PIPE_HIGHLIGHT_COLOR = (232, 184, 13, 255)
-PIPE_SLICER_COLOR = (255, 50, 75)
-#: Style to draw the connection pipes as straight lines.
-PIPE_LAYOUT_STRAIGHT = 0
-#: Style to draw the connection pipes as curved lines.
-PIPE_LAYOUT_CURVED = 1
-#: Style to draw the connection pipes as angled lines.
-PIPE_LAYOUT_ANGLE = 2
-
-# === PORT ===
+# ==================================== PIPE ====================================
+
+
+class PIPE_STYLING(Enum):
+    """
+    Pipe Constant.
+    """
+    #: pipe width.
+    WIDTH = 1.2
+    #: default color.
+    COLOR = (175, 95, 30, 255)
+    #: pipe color to a node when it's disabled.
+    DISABLED_COLOR = (190, 20, 20, 255)
+    #: color when the pipe is selected or mouse hovered.
+    ACTIVE_COLOR = (70, 255, 220, 255)
+    #: pipe color to a node when it's selected.
+    HIGHLIGHT_COLOR = (232, 184, 13, 255)
+    #: draw connection as a line.
+    DRAW_TYPE_DEFAULT = 0
+    #: draw connection as dashed lines.
+    DRAW_TYPE_DASHED = 1
+    #: draw connection as a dotted line.
+    DRAW_TYPE_DOTTED = 2
+
+
+class PIPE_SLICER_STYLING(Enum):
+    """
+    Slicer Pipe Constant.
+    """
+    #: pipe width.
+    WIDTH = 1.5
+    #: default color.
+    COLOR = (255, 50, 75)
+
+
+class PIPE_LAYOUT(Enum):
+    """
+    Pipe layout constant.
+    """
+    #: draw the connection pipes as straight lines.
+    STRAIGHT = 0
+    #: draw the connection pipes as curved lines.
+    CURVED = 1
+    #: draw the connection pipes as angled lines.
+    ANGLE = 2
+
+
+# ==================================== PORT ====================================
 
 #: Connection type for input ports.
 IN_PORT = 'in'
@@ -48,7 +80,7 @@
 PORT_HOVER_BORDER_COLOR = (136, 255, 35, 255)
 PORT_FALLOFF = 15.0
 
-# === NODE ===
+# ==================================== NODE ====================================
 
 NODE_WIDTH = 160
 NODE_HEIGHT = 60
@@ -108,6 +140,8 @@
 VIEWER_GRID_COLOR = (45, 45, 45)
 VIEWER_GRID_SIZE = 50
 
+# ================================== PRIVATE ===================================
+
 URI_SCHEME = 'nodegraphqt://'
 URN_SCHEME = 'nodegraphqt::'
 
diff --git a/NodeGraphQt/qgraphics/pipe.py b/NodeGraphQt/qgraphics/pipe.py
@@ -4,21 +4,18 @@
 from Qt import QtCore, QtGui, QtWidgets
 
 from NodeGraphQt.constants import (
-    PIPE_DEFAULT_COLOR, PIPE_ACTIVE_COLOR,
-    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,
+    PIPE_STYLING, PIPE_LAYOUT, IN_PORT, OUT_PORT, Z_VAL_PIPE,
     Z_VAL_NODE_WIDGET,
-    PIPE_LAYOUT_ANGLE, PIPE_LAYOUT_CURVED,
     ITEM_CACHE_MODE,
     NODE_LAYOUT_VERTICAL, NODE_LAYOUT_HORIZONTAL,
-    NODE_LAYOUT_DIRECTION)
+    NODE_LAYOUT_DIRECTION
+)
 from NodeGraphQt.qgraphics.port import PortItem
 
 PIPE_STYLES = {
-    PIPE_STYLE_DEFAULT: QtCore.Qt.SolidLine,
-    PIPE_STYLE_DASHED: QtCore.Qt.DashLine,
-    PIPE_STYLE_DOTTED: QtCore.Qt.DotLine
+    PIPE_STYLING.DRAW_TYPE_DEFAULT.value: QtCore.Qt.SolidLine,
+    PIPE_STYLING.DRAW_TYPE_DASHED.value: QtCore.Qt.DashLine,
+    PIPE_STYLING.DRAW_TYPE_DOTTED.value: QtCore.Qt.DotLine
 }
 
 
@@ -32,8 +29,8 @@ def __init__(self, input_port=None, output_port=None):
         self.setZValue(Z_VAL_PIPE)
         self.setAcceptHoverEvents(True)
         self.setFlag(QtWidgets.QGraphicsItem.ItemIsSelectable)
-        self._color = PIPE_DEFAULT_COLOR
-        self._style = PIPE_STYLE_DEFAULT
+        self._color = PIPE_STYLING.COLOR.value
+        self._style = PIPE_STYLING.DRAW_TYPE_DEFAULT.value
         self._active = False
         self._highlight = False
         self._input_port = input_port
@@ -76,22 +73,22 @@ def paint(self, painter, option, widget):
         """
         color = QtGui.QColor(*self._color)
         pen_style = PIPE_STYLES.get(self.style)
-        pen_width = PIPE_WIDTH
+        pen_width = PIPE_STYLING.WIDTH.value
         if self._active:
-            color = QtGui.QColor(*PIPE_ACTIVE_COLOR)
+            color = QtGui.QColor(*PIPE_STYLING.ACTIVE_COLOR.value)
             if pen_style == QtCore.Qt.DashDotDotLine:
                 pen_width += 1
             else:
                 pen_width += 0.35
         elif self._highlight:
-            color = QtGui.QColor(*PIPE_HIGHLIGHT_COLOR)
-            pen_style = PIPE_STYLES.get(PIPE_STYLE_DEFAULT)
+            color = QtGui.QColor(*PIPE_STYLING.HIGHLIGHT_COLOR.value)
+            pen_style = PIPE_STYLES.get(PIPE_STYLING.DRAW_TYPE_DEFAULT.value)
 
         if self.disabled():
             if not self._active:
-                color = QtGui.QColor(*PIPE_DISABLED_COLOR)
+                color = QtGui.QColor(*PIPE_STYLING.DISABLED_COLOR.value)
             pen_width += 0.2
-            pen_style = PIPE_STYLES.get(PIPE_STYLE_DOTTED)
+            pen_style = PIPE_STYLES.get(PIPE_STYLING.DRAW_TYPE_DOTTED.value)
 
         pen = QtGui.QPen(color, pen_width, pen_style)
         pen.setCapStyle(QtCore.Qt.RoundCap)
@@ -154,7 +151,7 @@ def __draw_path_vertical(self, start_port, pos1, pos2, path):
             pos2 (QPointF): end port position.
             path (QPainterPath): path to draw.
         """
-        if self.viewer_pipe_layout() == PIPE_LAYOUT_CURVED:
+        if self.viewer_pipe_layout() == PIPE_LAYOUT.CURVED.value:
             ctr_offset_y1, ctr_offset_y2 = pos1.y(), pos2.y()
             tangent = abs(ctr_offset_y1 - ctr_offset_y2)
 
@@ -171,7 +168,7 @@ def __draw_path_vertical(self, start_port, pos1, pos2, path):
             ctr_point2 = QtCore.QPointF(pos2.x(), ctr_offset_y2)
             path.cubicTo(ctr_point1, ctr_point2, pos2)
             self.setPath(path)
-        elif self.viewer_pipe_layout() == PIPE_LAYOUT_ANGLE:
+        elif self.viewer_pipe_layout() == PIPE_LAYOUT.ANGLE.value:
             ctr_offset_y1, ctr_offset_y2 = pos1.y(), pos2.y()
             distance = abs(ctr_offset_y1 - ctr_offset_y2)/2
             if start_port.port_type == IN_PORT:
@@ -198,7 +195,7 @@ def __draw_path_horizontal(self, start_port, pos1, pos2, path):
             pos2 (QPointF): end port position.
             path (QPainterPath): path to draw.
         """
-        if self.viewer_pipe_layout() == PIPE_LAYOUT_CURVED:
+        if self.viewer_pipe_layout() == PIPE_LAYOUT.CURVED.value:
             ctr_offset_x1, ctr_offset_x2 = pos1.x(), pos2.x()
             tangent = abs(ctr_offset_x1 - ctr_offset_x2)
 
@@ -215,7 +212,7 @@ def __draw_path_horizontal(self, start_port, pos1, pos2, path):
             ctr_point2 = QtCore.QPointF(ctr_offset_x2, pos2.y())
             path.cubicTo(ctr_point1, ctr_point2, pos2)
             self.setPath(path)
-        elif self.viewer_pipe_layout() == PIPE_LAYOUT_ANGLE:
+        elif self.viewer_pipe_layout() == PIPE_LAYOUT.ANGLE.value:
             ctr_offset_x1, ctr_offset_x2 = pos1.x(), pos2.x()
             distance = abs(ctr_offset_x1 - ctr_offset_x2) / 2
             if start_port.port_type == IN_PORT:
@@ -260,7 +257,7 @@ def draw_path(self, start_port, end_port=None, cursor_pos=None):
         path = QtGui.QPainterPath()
         path.moveTo(line.x1(), line.y1())
 
-        if self.viewer_pipe_layout() == PIPE_LAYOUT_STRAIGHT:
+        if self.viewer_pipe_layout() == PIPE_LAYOUT.STRAIGHT.value:
             path.lineTo(pos2)
             self.setPath(path)
             return
@@ -298,17 +295,21 @@ def viewer_pipe_layout(self):
 
     def activate(self):
         self._active = True
-        color = QtGui.QColor(*PIPE_ACTIVE_COLOR)
-        pen = QtGui.QPen(color, 2.5, PIPE_STYLES.get(PIPE_STYLE_DEFAULT))
+        color = QtGui.QColor(*PIPE_STYLING.ACTIVE_COLOR.value)
+        pen = QtGui.QPen(
+            color, 2.5, PIPE_STYLES.get(PIPE_STYLING.DRAW_TYPE_DEFAULT.value)
+        )
         self.setPen(pen)
 
     def active(self):
         return self._active
 
     def highlight(self):
         self._highlight = True
-        color = QtGui.QColor(*PIPE_HIGHLIGHT_COLOR)
-        pen = QtGui.QPen(color, 2, PIPE_STYLES.get(PIPE_STYLE_DEFAULT))
+        color = QtGui.QColor(*PIPE_STYLING.HIGHLIGHT_COLOR.value)
+        pen = QtGui.QPen(
+            color, 2, PIPE_STYLES.get(PIPE_STYLING.DRAW_TYPE_DEFAULT.value)
+        )
         self.setPen(pen)
 
     def highlighted(self):
@@ -409,9 +410,9 @@ def paint(self, painter, option, widget):
                 used to describe the parameters needed to draw.
             widget (QtWidgets.QWidget): not used.
         """
-        color = QtGui.QColor(*PIPE_ACTIVE_COLOR)
-        pen_style = PIPE_STYLES.get(PIPE_STYLE_DASHED)
-        pen_width = PIPE_WIDTH + 0.35
+        color = QtGui.QColor(*PIPE_STYLING.ACTIVE_COLOR.value)
+        pen_style = PIPE_STYLES.get(PIPE_STYLING.DRAW_TYPE_DASHED.value)
+        pen_width = PIPE_STYLING.WIDTH.value + 0.35
 
         pen = QtGui.QPen(color, pen_width)
         pen.setStyle(pen_style)
diff --git a/NodeGraphQt/qgraphics/slicer.py b/NodeGraphQt/qgraphics/slicer.py
@@ -3,7 +3,7 @@
 
 from Qt import QtCore, QtGui, QtWidgets
 
-from NodeGraphQt.constants import Z_VAL_NODE_WIDGET, PIPE_SLICER_COLOR
+from NodeGraphQt.constants import Z_VAL_NODE_WIDGET, PIPE_SLICER_STYLING
 
 
 class SlicerPipeItem(QtWidgets.QGraphicsPathItem):
@@ -25,7 +25,7 @@ def paint(self, painter, option, widget):
                 used to describe the parameters needed to draw.
             widget (QtWidgets.QWidget): not used.
         """
-        color = QtGui.QColor(*PIPE_SLICER_COLOR)
+        color = QtGui.QColor(*PIPE_SLICER_STYLING.COLOR.value)
         p1 = self.path().pointAtPercent(0)
         p2 = self.path().pointAtPercent(1)
         size = 6.0
@@ -42,15 +42,21 @@ def paint(self, painter, option, widget):
         text_x = painter.fontMetrics().width(text) / 2
         text_y = painter.fontMetrics().height() / 1.5
         text_pos = QtCore.QPointF(p1.x() - text_x, p1.y() - text_y)
-        text_color = QtGui.QColor(*PIPE_SLICER_COLOR)
+        text_color = QtGui.QColor(*PIPE_SLICER_STYLING.COLOR.value)
         text_color.setAlpha(80)
-        painter.setPen(QtGui.QPen(text_color, 1.5, QtCore.Qt.SolidLine))
+        painter.setPen(QtGui.QPen(
+            text_color, PIPE_SLICER_STYLING.WIDTH.value, QtCore.Qt.SolidLine
+        ))
         painter.drawText(text_pos, text)
 
-        painter.setPen(QtGui.QPen(color, 1.5, QtCore.Qt.DashDotLine))
+        painter.setPen(QtGui.QPen(
+            color, PIPE_SLICER_STYLING.WIDTH.value, QtCore.Qt.DashDotLine
+        ))
         painter.drawPath(self.path())
 
-        pen = QtGui.QPen(color, 1.5, QtCore.Qt.SolidLine)
+        pen = QtGui.QPen(
+            color, PIPE_SLICER_STYLING.WIDTH.value, QtCore.Qt.SolidLine
+        )
         pen.setCapStyle(QtCore.Qt.RoundCap)
         pen.setJoinStyle(QtCore.Qt.MiterJoin)
         painter.setPen(pen)
diff --git a/NodeGraphQt/widgets/viewer.py b/NodeGraphQt/widgets/viewer.py
@@ -6,7 +6,7 @@
 from Qt import QtGui, QtCore, QtWidgets
 
 from NodeGraphQt.base.menu import BaseMenu
-from NodeGraphQt.constants import IN_PORT, OUT_PORT, PIPE_LAYOUT_CURVED
+from NodeGraphQt.constants import IN_PORT, OUT_PORT, PIPE_LAYOUT
 from NodeGraphQt.qgraphics.node_abstract import AbstractNodeItem
 from NodeGraphQt.qgraphics.node_backdrop import BackdropNodeItem
 from NodeGraphQt.qgraphics.pipe import PipeItem, LivePipeItem
@@ -71,7 +71,7 @@ def __init__(self, parent=None, undo_stack=None):
         self._update_scene()
         self._last_size = self.size()
 
-        self._pipe_layout = PIPE_LAYOUT_CURVED
+        self._pipe_layout = PIPE_LAYOUT.CURVED.value
         self._detached_port = None
         self._start_port = None
         self._origin_pos = None
