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 #ifndef PULSEVIEW_PV_SIGNAL_H
  22 #define PULSEVIEW_PV_SIGNAL_H
  23
  24 #include <boost/shared_ptr.hpp>
  25
  26 #include <QPainter>
  27 #include <QRect>
  28 #include <QString>
  29
  30 #include <stdint.h>
  31
  32 namespace pv {
  33
  34 class SignalData;
  35
  36 class Signal
  37 {
  38 private:
  39         static const QSizeF LabelPadding;
  40         static const int LabelHitPadding;
  41
  42 protected:
  43         Signal(QString name);
  44
  45 public:
  46         /**
  47          * Gets the name of this signal.
  48          */
  49         QString get_name() const;
  50
  51         /**
  52          * Sets the name of the signal.
  53          */
  54         void set_name(QString name);
  55
  56         /**
  57          * Paints the signal with a QPainter
  58          * @param p the QPainter to paint into.
  59          * @param rect the rectangular area to draw the trace into.
  60          * @param scale the scale in seconds per pixel.
  61          * @param offset the time to show at the left hand edge of
  62          *   the view in seconds.
  63          **/
  64         virtual void paint(QPainter &p, const QRect &rect, double scale,
  65                 double offset) = 0;
  66
  67
  68         /**
  69          * Paints the signal label into a QGLWidget.
  70          * @param p the QPainter to paint into.
  71          * @param rect the rectangular area to draw the label into.
  72          * @param hover true if the label is being hovered over by the mouse.
  73          */
  74         virtual void paint_label(QPainter &p, const QRect &rect,
  75                 bool hover);
  76
  77         /**
  78          * Determines if a point is in the header label rect.
  79          * @param rect the rectangular area to draw the label into.
  80          * @param point the point to test.
  81          */
  82         bool pt_in_label_rect(const QRect &rect, const QPoint &point);
  83
  84 private:
  85
  86         /**
  87          * Computes an caches the size of the label text.
  88          */
  89         void compute_text_size(QPainter &p);
  90
  91         /**
  92          * Computes the outline rectangle of a label.
  93          * @param p the QPainter to lay out text with.
  94          * @param rect The rectangle of the signal header.
  95          * @return Returns the rectangle of the signal label.
  96          */
  97         QRectF get_label_rect(const QRect &rect);
  98
  99 protected:
 100         /**
 101          * Get the colour of the logic signal
 102          */
 103         virtual QColor get_colour() const = 0;
 104
 105         /**
 106          * When painting into the rectangle, calculate the y
 107          * offset of the zero point.
 108          **/
 109         virtual int get_nominal_offset(const QRect &rect) const = 0;
 110
 111 protected:
 112         QString _name;
 113         QSizeF _text_size;
 114 };
 115
 116 } // namespace pv
 117
 118 #endif // PULSEVIEW_PV_SIGNAL_H