pv/signal.h

   1 /*
   2  * This file is part of the PulseView project.
   3  *
   4  * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  19  */
  20
  21 #include <boost/shared_ptr.hpp>
  22
  23 #include <QPainter>
  24 #include <QRect>
  25 #include <QString>
  26
  27 #include <stdint.h>
  28
  29 namespace pv {
  30
  31 class SignalData;
  32
  33 class Signal
  34 {
  35 private:
  36         static const QSizeF LabelPadding;
  37         static const int LabelHitPadding;
  38
  39 protected:
  40         Signal(QString name);
  41
  42 public:
  43         QString get_name() const;
  44
  45         /**
  46          * Paints the signal with a QPainter
  47          * @param p the QPainter to paint into.
  48          * @param rect the rectangular area to draw the trace into.
  49          * @param scale the scale in seconds per pixel.
  50          * @param offset the time to show at the left hand edge of
  51          *   the view in seconds.
  52          **/
  53         virtual void paint(QPainter &p, const QRect &rect, double scale,
  54                 double offset) = 0;
  55
  56
  57         /**
  58          * Paints the signal label into a QGLWidget.
  59          * @param p the QPainter to paint into.
  60          * @param rect the rectangular area to draw the label into.
  61          * @param hover true if the label is being hovered over by the mouse.
  62          */
  63         virtual void paint_label(QPainter &p, const QRect &rect,
  64                 bool hover);
  65
  66         /**
  67          * Determines if a point is in the header label rect.
  68          * @param rect the rectangular area to draw the label into.
  69          * @param point the point to test.
  70          */
  71         bool pt_in_label_rect(const QRect &rect, const QPoint &point);
  72
  73 private:
  74
  75         /**
  76          * Computes an caches the size of the label text.
  77          */
  78         void compute_text_size(QPainter &p);
  79
  80         /**
  81          * Computes the outline rectangle of a label.
  82          * @param p the QPainter to lay out text with.
  83          * @param rect The rectangle of the signal header.
  84          * @return Returns the rectangle of the signal label.
  85          */
  86         QRectF get_label_rect(const QRect &rect);
  87
  88 protected:
  89         /**
  90          * Get the colour of the logic signal
  91          */
  92         virtual QColor get_colour() const = 0;
  93
  94         /**
  95          * When painting into the rectangle, calculate the y
  96          * offset of the zero point.
  97          **/
  98         virtual int get_nominal_offset(const QRect &rect) const = 0;
  99
 100 protected:
 101         QString _name;
 102         QSizeF _text_size;
 103 };
 104
 105 } // namespace pv