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