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