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