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