]>
Commit | Line | Data |
---|---|---|
1 | /* | |
2 | * This file is part of the PulseView project. | |
3 | * | |
4 | * Copyright (C) 2013 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, see <http://www.gnu.org/licenses/>. | |
18 | */ | |
19 | ||
20 | #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP | |
21 | #define PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP | |
22 | ||
23 | #include <QColor> | |
24 | #include <QPainter> | |
25 | #include <QPen> | |
26 | #include <QRect> | |
27 | #include <QString> | |
28 | ||
29 | #include <cstdint> | |
30 | ||
31 | #include "tracetreeitem.hpp" | |
32 | ||
33 | #include "pv/data/signalbase.hpp" | |
34 | ||
35 | using std::shared_ptr; | |
36 | ||
37 | class QFormLayout; | |
38 | ||
39 | namespace pv { | |
40 | ||
41 | namespace data { | |
42 | class SignalBase; | |
43 | } | |
44 | ||
45 | namespace widgets { | |
46 | class Popup; | |
47 | } | |
48 | ||
49 | namespace views { | |
50 | namespace trace { | |
51 | ||
52 | /** | |
53 | * The Trace class represents a @ref TraceTreeItem which occupies some vertical | |
54 | * space on the canvas and spans across its entire width, essentially showing | |
55 | * a time series of values, events, objects or similar. While easily confused | |
56 | * with @ref Signal, the difference is that Trace may represent anything that | |
57 | * can be drawn, not just numeric values. One example is a @ref DecodeTrace. | |
58 | * | |
59 | * For this reason, Trace is more generic and contains properties and helpers | |
60 | * that benefit any kind of time series items. | |
61 | */ | |
62 | class Trace : public TraceTreeItem | |
63 | { | |
64 | Q_OBJECT | |
65 | ||
66 | public: | |
67 | /** | |
68 | * Allowed values for the multi-segment display mode. | |
69 | * | |
70 | * Note: Consider these locations when updating the list: | |
71 | * * | |
72 | * @ref View::set_segment_display_mode | |
73 | * @ref AnalogSignal::get_analog_segment_to_paint | |
74 | * @ref AnalogSignal::get_logic_segment_to_paint | |
75 | * @ref LogicSignal::get_logic_segment_to_paint | |
76 | */ | |
77 | enum SegmentDisplayMode { | |
78 | ShowLastSegmentOnly = 1, | |
79 | ShowLastCompleteSegmentOnly, | |
80 | ShowSingleSegmentOnly, | |
81 | ShowAllSegments, | |
82 | ShowAccumulatedIntensity | |
83 | }; | |
84 | ||
85 | private: | |
86 | static const QPen AxisPen; | |
87 | static const int LabelHitPadding; | |
88 | ||
89 | static const QColor BrightGrayBGColour; | |
90 | static const QColor DarkGrayBGColour; | |
91 | ||
92 | protected: | |
93 | Trace(shared_ptr<data::SignalBase> channel); | |
94 | ||
95 | public: | |
96 | /** | |
97 | * Returns the underlying SignalBase instance. | |
98 | */ | |
99 | shared_ptr<data::SignalBase> base() const; | |
100 | ||
101 | /** | |
102 | * Sets the name of the signal. | |
103 | */ | |
104 | virtual void set_name(QString name); | |
105 | ||
106 | /** | |
107 | * Set the colour of the signal. | |
108 | */ | |
109 | virtual void set_colour(QColor colour); | |
110 | ||
111 | /** | |
112 | * Configures the segment display mode to use. | |
113 | */ | |
114 | virtual void set_segment_display_mode(SegmentDisplayMode mode); | |
115 | ||
116 | /** | |
117 | * Paints the signal label. | |
118 | * @param p the QPainter to paint into. | |
119 | * @param rect the rectangle of the header area. | |
120 | * @param hover true if the label is being hovered over by the mouse. | |
121 | */ | |
122 | virtual void paint_label(QPainter &p, const QRect &rect, bool hover); | |
123 | ||
124 | virtual QMenu* create_context_menu(QWidget *parent); | |
125 | ||
126 | pv::widgets::Popup* create_popup(QWidget *parent); | |
127 | ||
128 | /** | |
129 | * Computes the outline rectangle of a label. | |
130 | * @param rect the rectangle of the header area. | |
131 | * @return Returns the rectangle of the signal label. | |
132 | */ | |
133 | QRectF label_rect(const QRectF &rect) const; | |
134 | ||
135 | void set_current_segment(const int segment); | |
136 | ||
137 | int get_current_segment() const; | |
138 | ||
139 | protected: | |
140 | /** | |
141 | * Paints the background layer of the signal with a QPainter. | |
142 | * @param p The QPainter to paint into. | |
143 | * @param pp The painting parameters object to paint with. | |
144 | */ | |
145 | virtual void paint_back(QPainter &p, ViewItemPaintParams &pp); | |
146 | ||
147 | /** | |
148 | * Paints a zero axis across the viewport. | |
149 | * @param p the QPainter to paint into. | |
150 | * @param pp the painting parameters object to paint with. | |
151 | * @param y the y-offset of the axis. | |
152 | */ | |
153 | void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y); | |
154 | ||
155 | void add_colour_option(QWidget *parent, QFormLayout *form); | |
156 | ||
157 | void create_popup_form(); | |
158 | ||
159 | virtual void populate_popup_form(QWidget *parent, QFormLayout *form); | |
160 | ||
161 | protected Q_SLOTS: | |
162 | virtual void on_name_changed(const QString &text); | |
163 | ||
164 | virtual void on_colour_changed(const QColor &colour); | |
165 | ||
166 | void on_popup_closed(); | |
167 | ||
168 | private Q_SLOTS: | |
169 | void on_nameedit_changed(const QString &name); | |
170 | ||
171 | void on_colouredit_changed(const QColor &colour); | |
172 | ||
173 | protected: | |
174 | shared_ptr<data::SignalBase> base_; | |
175 | QPen axis_pen_; | |
176 | ||
177 | SegmentDisplayMode segment_display_mode_; | |
178 | ||
179 | /// The ID of the currently displayed segment | |
180 | int current_segment_; | |
181 | ||
182 | private: | |
183 | pv::widgets::Popup *popup_; | |
184 | QFormLayout *popup_form_; | |
185 | }; | |
186 | ||
187 | } // namespace trace | |
188 | } // namespace views | |
189 | } // namespace pv | |
190 | ||
191 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP |