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