doc updates

Author: jchanvfx

NodeGraphQt/base/graph.py

@@ -885,7 +885,7 @@ def create_node(self, node_type, name=None, selected=True, color=None,
             push_undo (bool): register the command to the undo stack. (default: True)
 
         Returns:
-            NodeObject: the created instance of the node.
+            BaseNode: the created instance of the node.
         """
         node = self._node_factory.create_node_instance(node_type)
         if node:
@@ -1894,6 +1894,8 @@ class SubGraph(NodeGraph):
 
     .. image:: _images/sub_graph.png
         :width: 70%
+
+    -
     """
 
     def __init__(self, parent=None, node=None, node_factory=None):
@@ -2178,6 +2180,9 @@ def node(self):
         """
         Returns the parent node to the sub graph.
 
+        .. image:: _images/group_node.png
+            :width: 250px
+
         Returns:
             NodeGraphQt.GroupNode: group node.
         """
@@ -2304,6 +2309,8 @@ def get_input_port_nodes(self):
         .. image:: _images/port_in_node.png
             :width: 150px
 
+        -
+
         See Also:
             :meth:`NodeGraph.get_nodes_by_type`,
             :meth:`SubGraph.get_output_port_nodes`
@@ -2320,6 +2327,8 @@ def get_output_port_nodes(self):
         .. image:: _images/port_out_node.png
             :width: 150px
 
+        -
+
         See Also:
             :meth:`NodeGraph.get_nodes_by_type`,
             :meth:`SubGraph.get_input_port_nodes`

NodeGraphQt/constants.py

@@ -52,7 +52,7 @@
 
 NODE_WIDTH = 160
 NODE_HEIGHT = 60
-NODE_ICON_SIZE = 24
+NODE_ICON_SIZE = 18
 NODE_SEL_COLOR = (255, 255, 255, 30)
 NODE_SEL_BORDER_COLOR = (254, 207, 42, 255)
 

NodeGraphQt/custom_widgets/nodes_tree.py

@@ -55,6 +55,8 @@ def __init__(self, parent=None, node_graph=None):
         self._custom_labels = {}
         self._category_items = {}
 
+        self._build_tree()
+
     def __repr__(self):
         return '<{} object at {}>'.format(
             self.__class__.__name__, hex(id(self))

NodeGraphQt/nodes/backdrop_node.py

@@ -15,6 +15,8 @@ class BackdropNode(NodeObject):
 
     .. image:: ../_images/backdrop.png
         :width: 250px
+
+    -
     """
 
     NODE_NAME = 'Backdrop'

NodeGraphQt/nodes/base_node.py

@@ -37,16 +37,16 @@ class BaseNode(NodeObject):
 
         from NodeGraphQt import BaseNode
 
-        class FooNode(BaseNode):
+        class ExampleNode(BaseNode):
 
             # unique node identifier domain.
-            __identifier__ = 'com.chantasticvfx'
+            __identifier__ = 'io.jchanvfx.github'
 
             # initial default node name.
-            NODE_NAME = 'Foo Node'
+            NODE_NAME = 'My Node'
 
             def __init__(self):
-                super(FooNode, self).__init__()
+                super(ExampleNode, self).__init__()
 
                 # create an input port.
                 self.add_input('in')

NodeGraphQt/nodes/group_node.py

@@ -18,6 +18,8 @@ class GroupNode(BaseNode):
 
     .. image:: ../_images/group_node.png
         :width: 250px
+
+    -
     """
 
     NODE_NAME = 'Group'

NodeGraphQt/nodes/port_node.py

@@ -21,6 +21,7 @@ class PortInputNode(BaseNode):
     .. image:: ../_images/port_in_node.png
         :width: 150px
 
+    -
     """
 
     NODE_NAME = 'InputPort'
@@ -81,6 +82,7 @@ class PortOutputNode(BaseNode):
     .. image:: ../_images/port_out_node.png
         :width: 150px
 
+    -
     """
 
     NODE_NAME = 'OutputPort'

NodeGraphQt/qgraphics/node_base.py

@@ -29,8 +29,9 @@ def __init__(self, name='node', parent=None):
         super(NodeItem, self).__init__(name, parent)
         pixmap = QtGui.QPixmap(ICON_NODE_BASE)
         if pixmap.size().height() > NODE_ICON_SIZE:
-            pixmap = pixmap.scaledToHeight(NODE_ICON_SIZE,
-                                           QtCore.Qt.SmoothTransformation)
+            pixmap = pixmap.scaledToHeight(
+                NODE_ICON_SIZE, QtCore.Qt.SmoothTransformation
+            )
         self._properties['icon'] = ICON_NODE_BASE
         self._icon_item = QtWidgets.QGraphicsPixmapItem(pixmap, self)
         self._icon_item.setTransformationMode(QtCore.Qt.SmoothTransformation)
@@ -329,8 +330,10 @@ def align_icon(self, h_offset=0.0, v_offset=0.0):
             v_offset (float): additional vertical offset.
             h_offset (float): additional horizontal offset.
         """
-        top_left = self.boundingRect().topLeft()
-        x, y = top_left.x(), top_left.y()
+        icon_rect = self._icon_item.boundingRect()
+        text_rect = self._text_item.boundingRect()
+        x = self.boundingRect().left() + 2.0
+        y = text_rect.center().y() - (icon_rect.height() / 2)
         self._icon_item.setPos(x + h_offset, y + v_offset)
 
     def align_label(self, h_offset=0.0, v_offset=0.0):

NodeGraphQt/qgraphics/node_group.py

@@ -161,7 +161,7 @@ def draw_node(self):
         height = self._text_item.boundingRect().height()
 
         # setup initial base size.
-        self._set_base_size(add_w=8.0, add_h=height)
+        self._set_base_size(add_w=8.0, add_h=height + 10)
         # set text color when node is initialized.
         self._set_text_color(self.text_color)
         # set the tooltip

NodeGraphQt/widgets/actions.py

@@ -1,14 +1,45 @@
 #!/usr/bin/python
 from Qt import QtCore, QtWidgets
 
-from NodeGraphQt.widgets.stylesheet import STYLE_QMENU
+from NodeGraphQt.constants import VIEWER_BG_COLOR
 
 
 class BaseMenu(QtWidgets.QMenu):
 
     def __init__(self, *args, **kwargs):
         super(BaseMenu, self).__init__(*args, **kwargs)
-        self.setStyleSheet(STYLE_QMENU)
+        text_color = self.palette().text().color().toTuple()
+        selected_color = self.palette().highlight().color().toTuple()
+        style_dict = {
+            'QMenu': {
+                'color': 'rgb({0},{1},{2})'.format(*text_color),
+                'background-color': 'rgb({0},{1},{2})'.format(*VIEWER_BG_COLOR),
+                'border': '1px solid rgba({0},{1},{2},30)'.format(*text_color),
+                'border-radius': '3px',
+            },
+            'QMenu::item': {
+                'padding': '5px 18px 2px',
+                'background-color': 'transparent',
+            },
+            'QMenu::item:selected': {
+                'color': 'rgb({0},{1},{2})'.format(*text_color),
+                'background-color': 'rgba({0},{1},{2},200)'
+                                    .format(*selected_color),
+            },
+            'QMenu::separator': {
+                'height': '1px',
+                'background': 'rgba({0},{1},{2}, 50)'.format(*text_color),
+                'margin': '4px 8px',
+            }
+        }
+        stylesheet = ''
+        for css_class, css in style_dict.items():
+            style = '{} {{\n'.format(css_class)
+            for elm_name, elm_val in css.items():
+                style += '  {}:{};\n'.format(elm_name, elm_val)
+            style += '}\n'
+            stylesheet += style
+        self.setStyleSheet(stylesheet)
         self.node_class = None
         self.graph = None