manual/color.rst

   1
   2 .. module:: color
   3
   4 *******************
   5 Module :mod:`color`
   6 *******************
   7
   8
   9 Color models
  10 ============
  11
  12 PostScript provides different color models. They are available to PyX by
  13 different color classes, which just pass the colors down to the PostScript
  14 level. This implies, that there are no conversion routines between different
  15 color models available. However, some color model conversion routines are
  16 included in Python's standard library in the module ``colorsym``. Furthermore
  17 also the comparison of colors within a color model is not supported, but might
  18 be added in future versions at least for checking color identity and for
  19 ordering gray colors.
  20
  21 There is a class for each of the supported color models, namely ``gray``,
  22 ``rgb``, ``cmyk``, and ``hsb``. The constructors take variables appropriate for
  23 the color model. Additionally, a list of named colors is given in appendix
  24 :ref:`colorname`.
  25
  26
  27 Example
  28 =======
  29
  30    ::
  31
  32       from pyx import *
  33
  34       c = canvas.canvas()
  35
  36       c.fill(path.rect(0, 0, 7, 3), [color.gray(0.8)])
  37       c.fill(path.rect(1, 1, 1, 1), [color.rgb.red])
  38       c.fill(path.rect(3, 1, 1, 1), [color.rgb.green])
  39       c.fill(path.rect(5, 1, 1, 1), [color.rgb.blue])
  40
  41       c.writeEPSfile("color")
  42
  43
  44 The file ``color.eps`` is created and looks like:
  45
  46 .. _fig_color:
  47 .. figure:: color.*
  48    :align:  center
  49
  50    Color example
  51
  52
  53 Color gradients
  54 ===============
  55
  56 The color module provides a class :class:`gradient` for continous transitions between
  57 colors. A list of named gradients is available in appendix :ref:`gradientname`.
  58
  59 Note that all predefined non-gray gradients are defined in the RGB color space,
  60 except for `gradient.Rainbow`, `gradient.ReverseRainbow`, `gradient.Hue`, and
  61 `gradient.ReverseHue`, which are naturally defined in the HSB color space. Converted
  62 RGB and CMYK versions of these latter gradients are also defined under the names
  63 `rgbgradient.Rainbow` and `cmykgradient.Rainbow`, etc.
  64
  65
  66 .. class:: gradient(min=0, max=1)
  67
  68    This class provides the methods for the ``gradient``. Different initializations
  69    can be found in ``lineargradient`` and ``functiongradient``.
  70
  71    *min* and *max* provide the valid range of the arguments for ``getcolor``.
  72
  73
  74    .. function:: getcolor(parameter)
  75
  76       Returns the color that corresponds to *parameter* (must be between *min* and
  77       *max*).
  78
  79
  80    .. function:: select(index, n_indices)
  81
  82       When a total number of *n_indices* different colors is needed from the gradient,
  83       this method returns the *index*-th color.
  84
  85
  86 .. class:: lineargradient(startcolor, endcolor, min=0, max=1)
  87
  88    This class provides a linear transition between two given colors. The linear
  89    interpolation is performed on the color components of the specific color model.
  90
  91    *startcolor* and *endcolor* must be colors of the same color model.
  92
  93
  94 .. class:: functiongradient(functions, type, min=0, max=1)
  95
  96    This class provides an arbitray transition between colors of the same color
  97    model.
  98
  99    *type* is a string indicating the color model (one of ``"cmyk"``, ``"rgb"``,
 100    ``"hsb"``, ``"grey"``)
 101
 102    *functions* is a dictionary that maps the color components onto given functions.
 103    E.g. for ``type="rgb"`` this dictionary must have the keys ``"r"``, ``"g"``, and
 104    ``"b"``.
 105
 106 .. class:: class rgbgradient(gradient)
 107
 108    This class takes an arbitrary gradient and converts it into one in the RGB color model.
 109    This is useful for instance in bitmap output, where only certain color models
 110    are supported in Postscript/PDF.
 111
 112 .. class:: class cmykgradient(gradient)
 113
 114    This class takes an arbitrary gradient and converts it into one in the CMYK color mode.
 115    This is useful for instance in bitmap output, where only certain color models
 116    are supported in Postscript/PDF.
 117
 118
 119
 120 Transparency
 121 ============
 122
 123
 124 .. class:: transparency(value)
 125
 126    Instances of this class will make drawing operations (stroking, filling) to
 127    become partially transparent. *value* defines the transparency factor in the
 128    range ``0`` (opaque) to ``1`` (transparent).
 129
 130    Transparency is available in PDF output only since it is not supported by
 131    PostScript. However, for certain ghostscript devices (for example the pdf
 132    backend as used by ps2pdf) proprietary PostScript extension allows for
 133    transparency in PostScript code too. PyX creates such PostScript proprietary
 134    code, but issues a warning when doing so.
 135