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