use QColor methods and functions

doc/source/functions.rst

@@ -34,12 +34,6 @@ Qt uses the classes QColor, QPen, and QBrush to determine how to draw lines and
 
 .. autofunction:: pyqtgraph.colorCIELab
 
-.. autofunction:: pyqtgraph.colorTuple
-
-.. autofunction:: pyqtgraph.colorStr
-
-.. autofunction:: pyqtgraph.glColor
-
 .. autofunction:: pyqtgraph.colorDistance
 
 
@@ -108,3 +102,16 @@ Miscellaneous Functions
 .. autofunction:: pyqtgraph.systemInfo
 
 .. autofunction:: pyqtgraph.exit
+
+
+Legacy Color Helper Functions
+-------------------------------
+
+The following helper functions should no longer be used. The functionality that they implement is trivial and it is suggested that the user use the equivalent QColor methods directly.
+
+
+.. autofunction:: pyqtgraph.colorTuple
+
+.. autofunction:: pyqtgraph.colorStr
+
+.. autofunction:: pyqtgraph.glColor

examples/GLLinePlotItem.py

@@ -6,7 +6,6 @@ Demonstrate use of GLLinePlotItem to draw cross-sections of a surface.
 ## Add path to library (just for examples; you do not need this)
 import initExample
 
-from pyqtgraph.Qt import QtCore, QtGui
 import pyqtgraph.opengl as gl
 import pyqtgraph as pg
 import numpy as np
@@ -37,7 +36,7 @@ for i in range(n):
     d = np.hypot(x, yi)
     z = 10 * np.cos(d) / (d+1)
     pts = np.column_stack([x, np.full_like(x, yi), z])
-    plt = gl.GLLinePlotItem(pos=pts, color=pg.glColor((i,n*1.3)), width=(i+1)/10., antialias=True)
+    plt = gl.GLLinePlotItem(pos=pts, color=pg.mkColor((i,n*1.3)), width=(i+1)/10., antialias=True)
     w.addItem(plt)
 
 if __name__ == '__main__':

pyqtgraph/colormap.py

@@ -249,8 +249,7 @@ def makeHslCycle( hue=0.0, saturation=1.0, lightness=0.5, steps=36 ):
     lgt_vals = np.linspace(lgtA, lgtB, num=steps+1)
     color_list = []
     for hue, sat, lgt in zip( hue_vals, sat_vals, lgt_vals):
-        qcol = QtGui.QColor()
+        qcol = QtGui.QColor.fromHslF( hue%1.0, sat, lgt )
-        qcol.setHslF( hue%1.0, sat, lgt )
         color_list.append( qcol )
     name = f'Hue {hueA:0.2f}-{hueB:0.2f}'
     return ColorMap( None, color_list, name=name )
@@ -311,8 +310,7 @@ def makeMonochrome(color='neutral'):
     l_vals = np.linspace(l_min, l_max, num=16)
     color_list = []
     for l_val in l_vals:
-        qcol = QtGui.QColor()
+        qcol = QtGui.QColor.fromHslF( h_val, s_val, l_val )
-        qcol.setHslF( h_val, s_val, l_val )
         color_list.append( qcol )
     return ColorMap( None, color_list, name=name, linearize=True )
 
@@ -581,7 +579,7 @@ class ColorMap(object):
             mode = self.enumMap[mode.lower()]
 
         if mode == self.QCOLOR:
-            pos, color = self.getStops(self.BYTE)
+            pos, color = self.getStops(self.FLOAT)
         else:
             pos, color = self.getStops(mode)
 
@@ -606,9 +604,9 @@ class ColorMap(object):
         # Convert to QColor if requested
         if mode == self.QCOLOR:
             if np.isscalar(data):
-                return QtGui.QColor(*interp)
+                return QtGui.QColor.fromRgbF(*interp)
             else:
-                return [QtGui.QColor(*x.tolist()) for x in interp]
+                return [QtGui.QColor.fromRgbF(*x.tolist()) for x in interp]
         else:
             return interp
 
@@ -762,8 +760,10 @@ class ColorMap(object):
                 color = color.astype(float) / 255.
             elif mode == self.QCOLOR:
                 if color.dtype.kind == 'f':
-                    color = (color*255).astype(np.ubyte)
+                    factory = QtGui.QColor.fromRgbF
-                color = [QtGui.QColor(*x.tolist()) for x in color]
+                else:
+                    factory = QtGui.QColor.fromRgb
+                color = [factory(*x.tolist()) for x in color]
             self.stopsCache[mode] = (self.pos, color)
         return self.stopsCache[mode]
 

pyqtgraph/exporters/Matplotlib.py

@@ -95,19 +95,19 @@ class MatplotlibExporter(Exporter):
                 linestyle = ''
             else:
                 linestyle = '-'
-            color = tuple([c/255. for c in fn.colorTuple(pen.color())])
+            color = pen.color().getRgbF()
             symbol = opts['symbol']
             if symbol == 't':
                 symbol = '^'
             symbolPen = fn.mkPen(opts['symbolPen'])
             symbolBrush = fn.mkBrush(opts['symbolBrush'])
-            markeredgecolor = tuple([c/255. for c in fn.colorTuple(symbolPen.color())])
+            markeredgecolor = symbolPen.color().getRgbF()
-            markerfacecolor = tuple([c/255. for c in fn.colorTuple(symbolBrush.color())])
+            markerfacecolor = symbolBrush.color().getRgbF()
             markersize = opts['symbolSize']
             
             if opts['fillLevel'] is not None and opts['fillBrush'] is not None:
                 fillBrush = fn.mkBrush(opts['fillBrush'])
-                fillcolor = tuple([c/255. for c in fn.colorTuple(fillBrush.color())])
+                fillcolor = fillBrush.color().getRgbF()
                 ax.fill_between(x=x, y1=y, y2=opts['fillLevel'], facecolor=fillcolor)
             
             pl = ax.plot(x, y, marker=symbol, color=color, linewidth=pen.width(), 

pyqtgraph/functions.py

@@ -224,7 +224,7 @@ class Color(QtGui.QColor):
         
     def glColor(self):
         """Return (r,g,b,a) normalized for use in opengl"""
-        return (self.red()/255., self.green()/255., self.blue()/255., self.alpha()/255.)
+        return self.getRgbF()
         
     def __getitem__(self, ind):
         return (self.red, self.green, self.blue, self.alpha)[ind]()
@@ -390,9 +390,7 @@ def mkPen(*args, **kargs):
 
 def hsvColor(hue, sat=1.0, val=1.0, alpha=1.0):
     """Generate a QColor from HSVa values. (all arguments are float 0.0-1.0)"""
-    c = QtGui.QColor()
+    return QtGui.QColor.fromHsvF(hue, sat, val, alpha)
-    c.setHsvF(hue, sat, val, alpha)
-    return c
     
 # Matrices and math taken from "CIELab Color Space" by Gernot Hoffmann
 # http://docs-hoffmann.de/cielab03022003.pdf
@@ -475,10 +473,7 @@ def CIELabColor(L, a, b, alpha=1.0):
         else:
             arr_sRGB[idx] = 12.92 * val # (s)
     arr_sRGB = clip_array( arr_sRGB, 0.0, 1.0 ) # avoid QColor errors
-    qcol = QtGui.QColor()
+    return QtGui.QColor.fromRgbF( *arr_sRGB, alpha )
-    qcol.setRgbF( *arr_sRGB )
-    if alpha < 1.0: qcol.setAlpha(alpha)
-    return qcol
 
 def colorCIELab(qcol):
     """
@@ -555,7 +550,7 @@ def colorDistance(colors, metric='CIE76'):
 
 def colorTuple(c):
     """Return a tuple (R,G,B,A) from a QColor"""
-    return (c.red(), c.green(), c.blue(), c.alpha())
+    return c.getRgb()
 
 def colorStr(c):
     """Generate a hex string code from a QColor"""
@@ -581,10 +576,7 @@ def intColor(index, hues=9, values=1, maxValue=255, minValue=150, maxHue=360, mi
         v = maxValue
     h = minHue + (indh * (maxHue-minHue)) // hues
     
-    c = QtGui.QColor()
+    return QtGui.QColor.fromHsv(h, sat, v, alpha)
-    c.setHsv(h, sat, v)
-    c.setAlpha(alpha)
-    return c
 
 
 def glColor(*args, **kargs):
@@ -593,7 +585,7 @@ def glColor(*args, **kargs):
     Accepts same arguments as :func:`mkColor <pyqtgraph.mkColor>`.
     """
     c = mkColor(*args, **kargs)
-    return (c.red()/255., c.green()/255., c.blue()/255., c.alpha()/255.)
+    return c.getRgbF()
 
     
 

pyqtgraph/graphicsItems/AxisItem.py

@@ -433,7 +433,7 @@ class AxisItem(GraphicsWidget):
             self._pen = fn.mkPen(*args, **kwargs)
         else:
             self._pen = fn.mkPen(getConfigOption('foreground'))
-        self.labelStyle['color'] = '#' + fn.colorStr(self._pen.color())[:6]
+        self.labelStyle['color'] = self._pen.color().name() #   #RRGGBB
         self._updateLabel()
 
     def textPen(self):
@@ -451,7 +451,7 @@ class AxisItem(GraphicsWidget):
             self._textPen = fn.mkPen(*args, **kwargs)
         else:
             self._textPen = fn.mkPen(getConfigOption('foreground'))
-        self.labelStyle['color'] = '#' + fn.colorStr(self._textPen.color())[:6]
+        self.labelStyle['color'] = self._textPen.color().name() #   #RRGGBB
         self._updateLabel()
 
     def setScale(self, scale=None):

pyqtgraph/graphicsItems/GradientEditorItem.py

@@ -581,7 +581,7 @@ class GradientEditorItem(TickSliderItem):
         for t,x in self.listTicks():
             pos.append(x)
             c = t.color
-            color.append([c.red(), c.green(), c.blue(), c.alpha()])
+            color.append(c.getRgb())
         return ColorMap(np.array(pos), np.array(color, dtype=np.ubyte))
         
     def updateGradient(self):
@@ -671,13 +671,13 @@ class GradientEditorItem(TickSliderItem):
             if toQColor:
                 return QtGui.QColor(c)  # always copy colors before handing them out
             else:
-                return (c.red(), c.green(), c.blue(), c.alpha())
+                return c.getRgb()
         if x >= ticks[-1][1]:
             c = ticks[-1][0].color
             if toQColor:
                 return QtGui.QColor(c)  # always copy colors before handing them out
             else:
-                return (c.red(), c.green(), c.blue(), c.alpha())
+                return c.getRgb()
             
         x2 = ticks[0][1]
         for i in range(1,len(ticks)):
@@ -708,12 +708,11 @@ class GradientEditorItem(TickSliderItem):
             h = h1 * (1.-f) + h2 * f
             s = s1 * (1.-f) + s2 * f
             v = v1 * (1.-f) + v2 * f
-            c = QtGui.QColor()
+            c = QtGui.QColor.fromHsv(int(h), int(s), int(v))
-            c.setHsv(*map(int, [h,s,v]))
             if toQColor:
                 return c
             else:
-                return (c.red(), c.green(), c.blue(), c.alpha())
+                return c.getRgb()
                     
     def getLookupTable(self, nPts, alpha=None):
         """
@@ -757,8 +756,8 @@ class GradientEditorItem(TickSliderItem):
             return False
         if ticks[0][1] != 0.0 or ticks[1][1] != 1.0:
             return False
-        c1 = fn.colorTuple(ticks[0][0].color)
+        c1 = ticks[0][0].color.getRgb()
-        c2 = fn.colorTuple(ticks[1][0].color)
+        c2 = ticks[1][0].color.getRgb()
         if c1 != (0,0,0,255) or c2 != (255,255,255,255):
             return False
         return True
@@ -794,7 +793,7 @@ class GradientEditorItem(TickSliderItem):
         ticks = []
         for t in self.ticks:
             c = t.color
-            ticks.append((self.ticks[t], (c.red(), c.green(), c.blue(), c.alpha())))
+            ticks.append((self.ticks[t], c.getRgb()))
         state = {'mode': self.colorMode, 
                  'ticks': ticks,
                  'ticksVisible': next(iter(self.ticks)).isVisible()}

pyqtgraph/graphicsItems/LabelItem.py

@@ -56,7 +56,7 @@ class LabelItem(GraphicsWidget, GraphicsWidgetAnchor):
         if color is None:
             color = getConfigOption('foreground')
         color = fn.mkColor(color)
-        optlist.append('color: #' + fn.colorStr(color)[:6])
+        optlist.append('color: ' + color.name())
         if 'size' in opts:
             optlist.append('font-size: ' + opts['size'])
         if 'bold' in opts and opts['bold'] in [True, False]:

pyqtgraph/graphicsItems/PlotCurveItem.py

@@ -620,8 +620,7 @@ class PlotCurveItem(GraphicsObject):
             try:
                 gl.glVertexPointerf(pos)
                 pen = fn.mkPen(self.opts['pen'])
-                color = pen.color()
+                gl.glColor4f(*pen.color().getRgbF())
-                gl.glColor4f(color.red()/255., color.green()/255., color.blue()/255., color.alpha()/255.)
                 width = pen.width()
                 if pen.isCosmetic() and width < 1:
                     width = 1

pyqtgraph/graphicsItems/PlotItem/PlotItem.py

@@ -763,9 +763,8 @@ class PlotItem(GraphicsWidget):
 
             for item in self.curves:
                 if isinstance(item, PlotCurveItem):
-                    color = fn.colorStr(item.pen.color())
+                    color = item.pen.color()
-                    opacity = item.pen.color().alpha() / 255.
+                    hrrggbb, opacity = color.name(), color.alphaF()
-                    color = color[:6]
                     x, y = item.getData()
                     mask = (x > xRange[0]) * (x < xRange[1])
                     mask[:-1] += mask[1:]
@@ -780,9 +779,9 @@ class PlotItem(GraphicsWidget):
                     # fh.write('<g fill="none" stroke="#%s" '
                     #          'stroke-opacity="1" stroke-width="1">\n' % (
                     #           color, ))
-                    fh.write('<path fill="none" stroke="#%s" '
+                    fh.write('<path fill="none" stroke="%s" '
                              'stroke-opacity="%f" stroke-width="1" '
-                             'd="M%f,%f ' % (color, opacity, x[0], y[0]))
+                             'd="M%f,%f ' % (hrrggbb, opacity, x[0], y[0]))
                     for i in range(1, len(x)):
                         fh.write('L%f,%f ' % (x[i], y[i]))
 
@@ -798,15 +797,14 @@ class PlotItem(GraphicsWidget):
                         pos = point.pos()
                         if not rect.contains(pos):
                             continue
-                        color = fn.colorStr(point.brush.color())
+                        color = point.brush.color()
-                        opacity = point.brush.color().alpha() / 255.
+                        hrrggbb, opacity = color.name(), color.alphaF()
-                        color = color[:6]
                         x = pos.x() * sx
                         y = pos.y() * sy
 
-                        fh.write('<circle cx="%f" cy="%f" r="1" fill="#%s" '
+                        fh.write('<circle cx="%f" cy="%f" r="1" fill="%s" '
                                  'stroke="none" fill-opacity="%f"/>\n' % (
-                                    x, y, color, opacity))
+                                    x, y, hrrggbb, opacity))
 
             fh.write("</svg>\n")
 

pyqtgraph/opengl/GLViewWidget.py

@@ -138,9 +138,9 @@ class GLViewWidget(QtWidgets.QOpenGLWidget):
     def setBackgroundColor(self, *args, **kwds):
         """
         Set the background color of the widget. Accepts the same arguments as
-        pg.mkColor() and pg.glColor().
+        :func:`~pyqtgraph.mkColor`.
         """
-        self.opts['bgcolor'] = fn.glColor(*args, **kwds)
+        self.opts['bgcolor'] = fn.mkColor(*args, **kwds).getRgbF()
         self.update()
         
     def getViewport(self):

pyqtgraph/opengl/items/GLBoxItem.py

@@ -38,7 +38,7 @@ class GLBoxItem(GLGraphicsItem):
     
     def setColor(self, *args):
         """Set the color of the box. Arguments are the same as those accepted by functions.mkColor()"""
-        self.__color = fn.Color(*args)
+        self.__color = fn.mkColor(*args)
         
     def color(self):
         return self.__color
@@ -54,7 +54,7 @@ class GLBoxItem(GLGraphicsItem):
         
         glBegin( GL_LINES )
         
-        glColor4f(*self.color().glColor())
+        glColor4f(*self.color().getRgbF())
         x,y,z = self.size()
         glVertex3f(0, 0, 0)
         glVertex3f(0, 0, z)

pyqtgraph/opengl/items/GLGridItem.py

@@ -56,7 +56,7 @@ class GLGridItem(GLGraphicsItem):
         
     def setColor(self, color):
         """Set the color of the grid. Arguments are the same as those accepted by functions.mkColor()"""
-        self.__color = fn.Color(color)
+        self.__color = fn.mkColor(color)
         self.update()
 
     def color(self):
@@ -77,7 +77,7 @@ class GLGridItem(GLGraphicsItem):
         xs,ys,zs = self.spacing()
         xvals = np.arange(-x/2., x/2. + xs*0.001, xs) 
         yvals = np.arange(-y/2., y/2. + ys*0.001, ys)
-        glColor4f(*self.color().glColor())
+        glColor4f(*self.color().getRgbF())
         for x in xvals:
             glVertex3f(x, yvals[0], 0)
             glVertex3f(x,  yvals[-1], 0)

pyqtgraph/opengl/items/GLLinePlotItem.py

@@ -66,10 +66,12 @@ class GLLinePlotItem(GLGraphicsItem):
                 glEnableClientState(GL_COLOR_ARRAY)
                 glColorPointerf(self.color)
             else:
-                if isinstance(self.color, (str, QtGui.QColor)):
+                color = self.color
-                    glColor4f(*fn.glColor(self.color))
+                if isinstance(color, str):
-                else:
+                    color = fn.mkColor(color)
-                    glColor4f(*self.color)
+                if isinstance(color, QtGui.QColor):
+                    color = color.getRgbF()
+                glColor4f(*color)
             glLineWidth(self.width)
             
             if self.antialias:

pyqtgraph/opengl/items/GLMeshItem.py

@@ -3,7 +3,6 @@ from .. GLGraphicsItem import GLGraphicsItem
 from .. MeshData import MeshData
 from ...Qt import QtGui
 from .. import shaders
-from ... import functions as fn
 import numpy as np
 
 
@@ -181,7 +180,7 @@ class GLMeshItem(GLGraphicsItem):
                     if self.colors is None:
                         color = self.opts['color']
                         if isinstance(color, QtGui.QColor):
-                            glColor4f(*fn.glColor(color))
+                            glColor4f(*color.getRgbF())
                         else:
                             glColor4f(*color)
                     else:
@@ -213,7 +212,7 @@ class GLMeshItem(GLGraphicsItem):
                 if self.edgeColors is None:
                     color = self.opts['edgeColor']
                     if isinstance(color, QtGui.QColor):
-                        glColor4f(*fn.glColor(color))
+                        glColor4f(*color.getRgbF())
                     else:
                         glColor4f(*color)
                 else:

pyqtgraph/opengl/items/GLScatterPlotItem.py

@@ -126,10 +126,10 @@ class GLScatterPlotItem(GLGraphicsItem):
                     glEnableClientState(GL_COLOR_ARRAY)
                     glColorPointerf(self.color)
                 else:
-                    if isinstance(self.color, QtGui.QColor):
+                    color = self.color
-                        glColor4f(*fn.glColor(self.color))
+                    if isinstance(color, QtGui.QColor):
-                    else:
+                        color = color.getRgbF()
-                        glColor4f(*self.color)
+                    glColor4f(*color)
                 
                 if not self.pxMode or isinstance(self.size, np.ndarray):
                     glEnableClientState(GL_NORMAL_ARRAY)

pyqtgraph/parametertree/parameterTypes/color.py

@@ -27,5 +27,5 @@ class ColorParameter(SimpleParameter):
 
     def saveState(self, filter=None):
         state = super().saveState(filter)
-        state['value'] = fn.colorTuple(self.value())
+        state['value'] = self.value().getRgb()
         return state

pyqtgraph/widgets/ColorButton.py

@@ -72,7 +72,7 @@ class ColorButton(QtGui.QPushButton):
         self.setColor(self._color, finished=True)
     
     def saveState(self):
-        return functions.colorTuple(self._color)
+        return self._color.getRgb()
         
     def restoreState(self, state):
         self.setColor(state)
@@ -82,9 +82,9 @@ class ColorButton(QtGui.QPushButton):
         if mode == 'qcolor':
             return color
         elif mode == 'byte':
-            return (color.red(), color.green(), color.blue(), color.alpha())
+            return color.getRgb()
         elif mode == 'float':
-            return (color.red()/255., color.green()/255., color.blue()/255., color.alpha()/255.)
+            return color.getRgbF()
 
     def widgetGroupInterface(self):
         return (self.sigColorChanged, ColorButton.saveState, ColorButton.restoreState)

pyqtgraph/widgets/ColorMapWidget.py

@@ -217,7 +217,7 @@ class RangeColorMapItem(ptree.types.SimpleParameter):
         
         mask = np.invert(np.isfinite(data))
         nanColor = self['NaN']
-        nanColor = (nanColor.red()/255., nanColor.green()/255., nanColor.blue()/255., nanColor.alpha()/255.)
+        nanColor = nanColor.getRgbF()
         colors[mask] = nanColor
         
         return colors        
@@ -254,12 +254,12 @@ class EnumColorMapItem(ptree.types.GroupParameter):
     def map(self, data):
         data = data[self.fieldName]
         colors = np.empty((len(data), 4))
-        default = np.array(fn.colorTuple(self['Default'])) / 255.
+        default = np.array(self['Default'].getRgbF())
         colors[:] = default
         
         for v in self.param('Values'):
             mask = data == v.maskValue
-            c = np.array(fn.colorTuple(v.value())) / 255.
+            c = np.array(v.value().getRgbF())
             colors[mask] = c
         #scaled = np.clip((data-self['Min']) / (self['Max']-self['Min']), 0, 1)
         #cmap = self.value()
@@ -267,7 +267,7 @@ class EnumColorMapItem(ptree.types.GroupParameter):
         
         #mask = np.isnan(data) | np.isinf(data)
         #nanColor = self['NaN']
-        #nanColor = (nanColor.red()/255., nanColor.green()/255., nanColor.blue()/255., nanColor.alpha()/255.)
+        #nanColor = nanColor.getRgbF()
         #colors[mask] = nanColor
         
         return colors