Updated VIEWER constant vars to enums

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -21,7 +21,7 @@
     PIPE_LAYOUT,
     URI_SCHEME, URN_SCHEME,
     PORT_TYPE,
-    VIEWER_GRID_LINES
+    VIEWER_STYLING
 )
 from NodeGraphQt.nodes.backdrop_node import BackdropNode
 from NodeGraphQt.nodes.base_node import BaseNode
@@ -553,7 +553,7 @@ def set_grid_color(self, r, g, b):
         self.scene().grid_color = (r, g, b)
         self._viewer.force_update()
 
-    def set_grid_mode(self, mode=VIEWER_GRID_LINES):
+    def set_grid_mode(self, mode=None):
         """
         Set node graph grid mode.
 
@@ -562,13 +562,20 @@ def set_grid_mode(self, mode=VIEWER_GRID_LINES):
 
             Node graph background types:
 
-            * :attr:`NodeGraphQt.constants.VIEWER_GRID_NONE`
-            * :attr:`NodeGraphQt.constants.VIEWER_GRID_DOTS`
-            * :attr:`NodeGraphQt.constants.VIEWER_GRID_LINES`
+            * :attr:`NodeGraphQt.constants.VIEWER_STYLING.GRID_DISPLAY_NONE.value`
+            * :attr:`NodeGraphQt.constants.VIEWER_STYLING.GRID_DISPLAY_DOTS.value`
+            * :attr:`NodeGraphQt.constants.VIEWER_STYLING.GRID_DISPLAY_LINES.value`
 
         Args:
             mode (int): background style.
         """
+        display_types = [
+            VIEWER_STYLING.GRID_DISPLAY_NONE.value,
+            VIEWER_STYLING.GRID_DISPLAY_DOTS.value,
+            VIEWER_STYLING.GRID_DISPLAY_LINES.value
+        ]
+        if mode not in display_types:
+            mode = VIEWER_STYLING.GRID_DISPLAY_LINES.value
         self.scene().grid_mode = mode
         self._viewer.force_update()
 

NodeGraphQt/base/graph_actions.py

@@ -280,24 +280,24 @@ def _bg_grid_none(graph):
     """
     Turn off the background patterns.
     """
-    from NodeGraphQt.constants import VIEWER_GRID_NONE
-    graph.set_grid_mode(VIEWER_GRID_NONE)
+    from NodeGraphQt.constants import VIEWER_STYLING
+    graph.set_grid_mode(VIEWER_STYLING.GRID_DISPLAY_NONE.value)
 
 
 def _bg_grid_dots(graph):
     """
     Set background node graph background with grid dots.
     """
-    from NodeGraphQt.constants import VIEWER_GRID_DOTS
-    graph.set_grid_mode(VIEWER_GRID_DOTS)
+    from NodeGraphQt.constants import VIEWER_STYLING
+    graph.set_grid_mode(VIEWER_STYLING.GRID_DISPLAY_DOTS.value)
 
 
 def _bg_grid_lines(graph):
     """
     Set background node graph background with grid lines.
     """
-    from NodeGraphQt.constants import VIEWER_GRID_LINES
-    graph.set_grid_mode(VIEWER_GRID_LINES)
+    from NodeGraphQt.constants import VIEWER_STYLING
+    graph.set_grid_mode(VIEWER_STYLING.GRID_DISPLAY_LINES.value)
 
 
 def _layout_graph_down(graph):

NodeGraphQt/constants.py

@@ -167,18 +167,36 @@ class NODE_STYLING(Enum):
 
 # === NODE VIEWER ===
 
-#: Style to render the node graph background with nothing.
-VIEWER_GRID_NONE = 0
-#: Style to render the node graph background with dots.
-VIEWER_GRID_DOTS = 1
-#: Style to render the node graph background with grid lines.
-VIEWER_GRID_LINES = 2
-
-VIEWER_NAV_BG_COLOR = (25, 25, 25)
-VIEWER_NAV_ITEM_COLOR = (35, 35, 35)
-VIEWER_BG_COLOR = (35, 35, 35)
-VIEWER_GRID_COLOR = (45, 45, 45)
-VIEWER_GRID_SIZE = 50
+
+class VIEWER_STYLING(Enum):
+    """
+    Node graph viewer styling layout:
+    ``NodeGraphQt.constants.VIEWER_STYLING``
+    """
+    #: default background color for the node graph.
+    BACKGROUND_COLOR = (35, 35, 35)
+    #: style node graph background with no grid or dots.
+    GRID_DISPLAY_NONE = 0
+    #: style node graph background with dots.
+    GRID_DISPLAY_DOTS = 1
+    #: style node graph background with grid lines.
+    GRID_DISPLAY_LINES = 2
+    #: grid size when styled with grid lines.
+    GRID_SIZE = 50
+    #: grid line color.
+    GRID_COLOR = (45, 45, 45)
+
+
+class VIEWER_NAV_STYLING(Enum):
+    """
+    Node graph viewer navigation styling layout:
+    ``NodeGraphQt.constants.VIEWER_NAV_STYLING``
+    """
+    #: default background color.
+    BACKGROUND_COLOR = (25, 25, 25)
+    #: default item color.
+    ITEM_COLOR = (35, 35, 35)
+
 
 # ================================== PRIVATE ===================================
 

NodeGraphQt/widgets/actions.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 from Qt import QtCore, QtWidgets
 
-from NodeGraphQt.constants import VIEWER_BG_COLOR
+from NodeGraphQt.constants import VIEWER_STYLING
 
 
 class BaseMenu(QtWidgets.QMenu):
@@ -13,7 +13,9 @@ def __init__(self, *args, **kwargs):
         style_dict = {
             'QMenu': {
                 'color': 'rgb({0},{1},{2})'.format(*text_color),
-                'background-color': 'rgb({0},{1},{2})'.format(*VIEWER_BG_COLOR),
+                'background-color': 'rgb({0},{1},{2})'.format(
+                    *VIEWER_STYLING.BACKGROUND_COLOR.value
+                ),
                 'border': '1px solid rgba({0},{1},{2},30)'.format(*text_color),
                 'border-radius': '3px',
             },

NodeGraphQt/widgets/node_graph.py

@@ -1,10 +1,9 @@
 from Qt import QtWidgets, QtGui
 
 from NodeGraphQt.constants import (
-    NODE_STYLING,
-    VIEWER_BG_COLOR,
-    VIEWER_NAV_BG_COLOR
+    NODE_STYLING, VIEWER_STYLING, VIEWER_NAV_STYLING
 )
+
 from NodeGraphQt.widgets.viewer_nav import NodeNavigationWidget
 
 
@@ -15,13 +14,18 @@ def __init__(self, parent=None):
         self.setTabsClosable(True)
         self.setTabBarAutoHide(True)
         text_color = self.palette().text().color().toTuple()
-        bg_color = QtGui.QColor(*VIEWER_BG_COLOR).darker(120).toTuple()
+        bg_color = QtGui.QColor(
+            *VIEWER_STYLING.BACKGROUND_COLOR.value).darker(120).toTuple()
         style_dict = {
             'QWidget': {
-                'background-color': 'rgb({0},{1},{2})'.format(*VIEWER_BG_COLOR),
+                'background-color': 'rgb({0},{1},{2})'.format(
+                    *VIEWER_STYLING.BACKGROUND_COLOR.value
+                ),
             },
             'QTabWidget::pane': {
-                'background': 'rgb({0},{1},{2})'.format(*VIEWER_BG_COLOR),
+                'background': 'rgb({0},{1},{2})'.format(
+                    *VIEWER_STYLING.BACKGROUND_COLOR.value
+                ),
                 'border': '0px',
                 'border-top': '0px solid rgb({0},{1},{2})'.format(*bg_color),
             },
@@ -34,7 +38,9 @@ def __init__(self, parent=None):
             },
             'QTabBar::tab:selected': {
                 'color': 'rgb({0},{1},{2})'.format(*text_color),
-                'background': 'rgb({0},{1},{2})'.format(*VIEWER_NAV_BG_COLOR),
+                'background': 'rgb({0},{1},{2})'.format(
+                    *VIEWER_NAV_STYLING.BACKGROUND_COLOR.value
+                ),
                 'border-top': '1px solid rgb({0},{1},{2})'
                               .format(*NODE_STYLING.SELECTED_BORDER_COLOR.value),
             },

NodeGraphQt/widgets/node_widgets.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 from Qt import QtCore, QtWidgets
 
-from NodeGraphQt.constants import VIEWER_GRID_COLOR, Z_VAL_NODE_WIDGET
+from NodeGraphQt.constants import VIEWER_STYLING, Z_VAL_NODE_WIDGET
 from NodeGraphQt.errors import NodeWidgetError
 
 
@@ -329,7 +329,7 @@ def __init__(self, parent=None, name='', label='', text=''):
             'QLineEdit': {
                 'background': 'rgba({0},{1},{2},20)'.format(*bg_color),
                 'border': '1px solid rgb({0},{1},{2})'
-                          .format(*VIEWER_GRID_COLOR),
+                          .format(*VIEWER_STYLING.GRID_COLOR.value),
                 'border-radius': '3px',
                 'color': 'rgba({0},{1},{2},150)'.format(*text_color),
                 'selection-background-color': 'rgba({0},{1},{2},100)'

NodeGraphQt/widgets/scene.py

@@ -1,20 +1,16 @@
 #!/usr/bin/python
 from Qt import QtGui, QtCore, QtWidgets
 
-from NodeGraphQt.constants import (VIEWER_BG_COLOR,
-                                   VIEWER_GRID_SIZE,
-                                   VIEWER_GRID_COLOR,
-                                   VIEWER_GRID_DOTS,
-                                   VIEWER_GRID_LINES)
+from NodeGraphQt.constants import VIEWER_STYLING
 
 
 class NodeScene(QtWidgets.QGraphicsScene):
 
     def __init__(self, parent=None):
         super(NodeScene, self).__init__(parent)
-        self._grid_mode = VIEWER_GRID_LINES
-        self._grid_color = VIEWER_GRID_COLOR
-        self._bg_color = VIEWER_BG_COLOR
+        self._grid_mode = VIEWER_STYLING.GRID_DISPLAY_LINES.value
+        self._grid_color = VIEWER_STYLING.GRID_COLOR.value
+        self._bg_color = VIEWER_STYLING.BACKGROUND_COLOR.value
         self.setBackgroundBrush(QtGui.QColor(*self._bg_color))
 
     def __repr__(self):
@@ -98,21 +94,25 @@ def drawBackground(self, painter, rect):
         painter.setRenderHint(QtGui.QPainter.Antialiasing, False)
         painter.setBrush(self.backgroundBrush())
 
-        if self._grid_mode is VIEWER_GRID_DOTS:
+        if self._grid_mode is VIEWER_STYLING.GRID_DISPLAY_DOTS.value:
             pen = QtGui.QPen(QtGui.QColor(*self.grid_color), 0.65)
-            self._draw_dots(painter, rect, pen, VIEWER_GRID_SIZE)
+            self._draw_dots(painter, rect, pen, VIEWER_STYLING.GRID_SIZE.value)
 
-        elif self._grid_mode is VIEWER_GRID_LINES:
+        elif self._grid_mode is VIEWER_STYLING.GRID_DISPLAY_LINES.value:
             zoom = self.viewer().get_zoom()
             if zoom > -0.5:
                 pen = QtGui.QPen(QtGui.QColor(*self.grid_color), 0.65)
-                self._draw_grid(painter, rect, pen, VIEWER_GRID_SIZE)
+                self._draw_grid(
+                    painter, rect, pen, VIEWER_STYLING.GRID_SIZE.value
+                )
 
             color = QtGui.QColor(*self._bg_color).darker(150)
             if zoom < -0.0:
                 color = color.darker(100 - int(zoom * 110))
             pen = QtGui.QPen(color, 0.65)
-            self._draw_grid(painter, rect, pen, VIEWER_GRID_SIZE * 8)
+            self._draw_grid(
+                painter, rect, pen, VIEWER_STYLING.GRID_SIZE.value * 8
+            )
 
         painter.restore()
 
@@ -148,7 +148,9 @@ def grid_mode(self):
         return self._grid_mode
 
     @grid_mode.setter
-    def grid_mode(self, mode=VIEWER_GRID_LINES):
+    def grid_mode(self, mode=None):
+        if mode is None:
+            mode = VIEWER_STYLING.GRID_DISPLAY_LINES.value
         self._grid_mode = mode
 
     @property

NodeGraphQt/widgets/tab_search.py

@@ -4,7 +4,7 @@
 
 from Qt import QtCore, QtWidgets, QtGui
 
-from NodeGraphQt.constants import VIEWER_BG_COLOR, VIEWER_NAV_BG_COLOR
+from NodeGraphQt.constants import VIEWER_STYLING, VIEWER_NAV_STYLING
 
 
 class TabSearchCompleter(QtWidgets.QCompleter):
@@ -62,12 +62,15 @@ def __init__(self, parent=None):
         style_dict = {
             'QLineEdit': {
                 'color': 'rgb({0},{1},{2})'.format(*text_color),
-                'border': '1px solid rgb({0},{1},{2})'
-                          .format(*selected_color),
+                'border': '1px solid rgb({0},{1},{2})'.format(
+                    *selected_color
+                ),
                 'border-radius': '3px',
                 'padding': '2px 4px',
                 'margin': '2px 4px 8px 4px',
-                'background': 'rgb({0},{1},{2})'.format(*VIEWER_NAV_BG_COLOR),
+                'background': 'rgb({0},{1},{2})'.format(
+                    *VIEWER_NAV_STYLING.BACKGROUND_COLOR.value
+                ),
                 'selection-background-color': 'rgba({0},{1},{2},200)'
                                               .format(*selected_color),
             }
@@ -110,7 +113,9 @@ def __init__(self, node_dict=None):
         style_dict = {
             'QMenu': {
                 'color': 'rgb({0},{1},{2})'.format(*text_color),
-                'background-color': 'rgb({0},{1},{2})'.format(*VIEWER_BG_COLOR),
+                'background-color': 'rgb({0},{1},{2})'.format(
+                    *VIEWER_STYLING.BACKGROUND_COLOR.value
+                ),
                 'border': '1px solid rgba({0},{1},{2},30)'.format(*text_color),
                 'border-radius': '3px',
             },

NodeGraphQt/widgets/viewer_nav.py

@@ -1,10 +1,6 @@
 from Qt import QtWidgets, QtCore, QtGui
 
-from NodeGraphQt.constants import (
-    NODE_STYLING,
-    VIEWER_NAV_BG_COLOR,
-    VIEWER_NAV_ITEM_COLOR
-)
+from NodeGraphQt.constants import NODE_STYLING, VIEWER_NAV_STYLING
 
 
 class NodeNavigationDelagate(QtWidgets.QStyledItemDelegate):
@@ -36,7 +32,7 @@ def paint(self, painter, option, index):
         painter.setRenderHint(QtGui.QPainter.Antialiasing, True)
 
         # background.
-        bg_color = QtGui.QColor(*VIEWER_NAV_ITEM_COLOR)
+        bg_color = QtGui.QColor(*VIEWER_NAV_STYLING.ITEM_COLOR.value)
         itm_color = QtGui.QColor(80, 128, 123)
         if option.state & QtWidgets.QStyle.State_Selected:
             bg_color = bg_color.lighter(120)
@@ -109,7 +105,7 @@ def __init__(self, parent=None):
         # self.viewport().setAutoFillBackground(False)
         self.setStyleSheet(
             'QListView {{border: 0px;background-color: rgb({0},{1},{2});}}'
-            .format(*VIEWER_NAV_BG_COLOR)
+            .format(*VIEWER_NAV_STYLING.BACKGROUND_COLOR.value)
         )
 
         self.setItemDelegate(NodeNavigationDelagate(self))