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