edab476deb7d31c22f0b16929c2221e82e05cb1a
[pulseview.git] / signal.h
1 /*
2  * This file is part of the sigrok 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 <QGLWidget>
24 #include <QPainter>
25 #include <QRect>
26 #include <QString>
27
28 #include <stdint.h>
29
30 class SignalData;
31
32 class Signal
33 {
34 private:
35         static const QSizeF LabelPadding;
36
37 protected:
38         Signal(QString name);
39
40 public:
41         QString get_name() const;
42
43         /**
44          * Paints the signal into a QGLWidget.
45          * @param widget the QGLWidget to paint into.
46          * @param rect the rectangular area to draw the trace into.
47          * @param scale the scale in seconds per pixel.
48          * @param offset the time to show at the left hand edge of
49          *   the view in seconds.
50          **/
51         virtual void paint(QGLWidget &widget, const QRect &rect,
52                 double scale, double offset) = 0;
53
54         /**
55          * Paints the signal label into a QGLWidget.
56          * @param p the QPainter to paint into.
57          * @param rect the rectangular area to draw the label into.
58          */
59         virtual void paint_label(QPainter &p, const QRect &rect);
60
61 protected:
62
63         /**
64          * Get the colour of the logic signal
65          */
66         virtual QColor get_colour() const = 0;
67
68         /**
69          * When painting into the rectangle, calculate the y
70          * offset of the zero point.
71          **/
72         virtual int get_nominal_offset(const QRect &rect) const = 0;
73
74 protected:
75         QString _name;
76 };