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 <QPen>
  29 #include <QRect>
  30 #include <QString>
  31
  32 #include <stdint.h>
  33
  34 namespace pv {
  35
  36 namespace data {
  37 class SignalData;
  38 }
  39
  40 namespace view {
  41
  42 class Signal
  43 {
  44 private:
  45         static const int LabelHitPadding;
  46         static const int LabelHighlightRadius;
  47
  48         static const QPen SignalAxisPen;
  49
  50 protected:
  51         Signal(QString name);
  52
  53 public:
  54         /**
  55          * Gets the name of this signal.
  56          */
  57         QString get_name() const;
  58
  59         /**
  60          * Sets the name of the signal.
  61          */
  62         void set_name(QString name);
  63
  64         /**
  65          * Get the colour of the signal.
  66          */
  67         QColor get_colour() const;
  68
  69         /**
  70          * Set the colour of the signal.
  71          */
  72         void set_colour(QColor colour);
  73
  74         /**
  75          * Gets the vertical layout offset of this signal.
  76          */
  77         int get_v_offset() const;
  78
  79         /**
  80          * Sets the vertical layout offset of this signal.
  81          */
  82         void set_v_offset(int v_offset);
  83
  84         /**
  85          * Returns true if the signal has been selected by the user.
  86          */
  87         bool selected() const;
  88
  89         /**
  90          * Selects or deselects the signal.
  91          */
  92         void select(bool select = true);
  93
  94         /**
  95          * Paints the signal with a QPainter
  96          * @param p the QPainter to paint into.
  97          * @param y the y-coordinate to draw the signal at
  98          * @param left the x-coordinate of the left edge of the signal
  99          * @param right the x-coordinate of the right edge of the signal
 100          * @param scale the scale in seconds per pixel.
 101          * @param offset the time to show at the left hand edge of
 102          *   the view in seconds.
 103          **/
 104         virtual void paint(QPainter &p, int y, int left, int right,
 105                 double scale, double offset) = 0;
 106
 107         /**
 108          * Paints the signal label into a QGLWidget.
 109          * @param p the QPainter to paint into.
 110          * @param y the y-coordinate of the signal.
 111          * @param right the x-coordinate of the right edge of the header
 112          *      area.
 113          * @param hover true if the label is being hovered over by the mouse.
 114          */
 115         virtual void paint_label(QPainter &p, int y, int right,
 116                 bool hover);
 117
 118         /**
 119          * Determines if a point is in the header label rect.
 120          * @param y the y-coordinate of the signal.
 121          * @param left the x-coordinate of the left edge of the header
 122          *      area.
 123          * @param right the x-coordinate of the right edge of the header
 124          *      area.
 125          * @param point the point to test.
 126          */
 127         bool pt_in_label_rect(int y, int left, int right,
 128                 const QPoint &point);
 129
 130 protected:
 131
 132         /**
 133          * Paints a zero axis across the viewport.
 134          * @param p the QPainter to paint into.
 135          * @param y the y-offset of the axis.
 136          * @param left the x-coordinate of the left edge of the view.
 137          * @param right the x-coordinate of the right edge of the view.
 138          */
 139         void paint_axis(QPainter &p, int y, int left, int right);
 140
 141 private:
 142
 143         /**
 144          * Computes an caches the size of the label text.
 145          */
 146         void compute_text_size(QPainter &p);
 147
 148         /**
 149          * Computes the outline rectangle of a label.
 150          * @param p the QPainter to lay out text with.
 151          * @param y the y-coordinate of the signal.
 152          * @param right the x-coordinate of the right edge of the header
 153          *      area.
 154          * @return Returns the rectangle of the signal label.
 155          */
 156         QRectF get_label_rect(int y, int right);
 157
 158 protected:
 159         QString _name;
 160         QColor _colour;
 161         int _v_offset;
 162
 163         bool _selected;
 164
 165         QSizeF _text_size;
 166 };
 167
 168 } // namespace view
 169 } // namespace pv
 170
 171 #endif // PULSEVIEW_PV_SIGNAL_H