]>
Commit | Line | Data |
---|---|---|
931f20b0 JH |
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 | |
efdec55a | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
931f20b0 JH |
18 | */ |
19 | ||
f4e57597 SA |
20 | #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP |
21 | #define PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP | |
931f20b0 JH |
22 | |
23 | #include <QColor> | |
24 | #include <QPainter> | |
fe08b6e8 | 25 | #include <QPen> |
931f20b0 JH |
26 | #include <QRect> |
27 | #include <QString> | |
28 | ||
cafe470e | 29 | #include <cstdint> |
931f20b0 | 30 | |
af503b10 | 31 | #include "tracetreeitem.hpp" |
931f20b0 | 32 | |
1931b5f9 | 33 | #include <pv/globalsettings.hpp> |
bf0edd2b SA |
34 | #include "pv/data/signalbase.hpp" |
35 | ||
6f925ba9 UH |
36 | using std::shared_ptr; |
37 | ||
b213ef09 JH |
38 | class QFormLayout; |
39 | ||
931f20b0 | 40 | namespace pv { |
931f20b0 | 41 | |
5ed05b69 SA |
42 | namespace data { |
43 | class SignalBase; | |
44 | } | |
45 | ||
23935421 JH |
46 | namespace widgets { |
47 | class Popup; | |
48 | } | |
49 | ||
f4e57597 | 50 | namespace views { |
1573bf16 | 51 | namespace trace { |
01fd3263 | 52 | |
1373fec5 SA |
53 | /** |
54 | * The Trace class represents a @ref TraceTreeItem which occupies some vertical | |
55 | * space on the canvas and spans across its entire width, essentially showing | |
56 | * a time series of values, events, objects or similar. While easily confused | |
57 | * with @ref Signal, the difference is that Trace may represent anything that | |
58 | * can be drawn, not just numeric values. One example is a @ref DecodeTrace. | |
59 | * | |
60 | * For this reason, Trace is more generic and contains properties and helpers | |
61 | * that benefit any kind of time series items. | |
62 | */ | |
1931b5f9 | 63 | class Trace : public TraceTreeItem, public GlobalSettingsInterface |
931f20b0 JH |
64 | { |
65 | Q_OBJECT | |
66 | ||
7daebd05 SA |
67 | public: |
68 | /** | |
69 | * Allowed values for the multi-segment display mode. | |
70 | * | |
558ad6ce SA |
71 | * Note: Consider these locations when updating the list: |
72 | * * | |
73 | * @ref View::set_segment_display_mode | |
89914a86 | 74 | * @ref View::on_segment_changed |
558ad6ce SA |
75 | * @ref AnalogSignal::get_analog_segment_to_paint |
76 | * @ref AnalogSignal::get_logic_segment_to_paint | |
77 | * @ref LogicSignal::get_logic_segment_to_paint | |
89914a86 | 78 | * @ref StandardBar |
7daebd05 SA |
79 | */ |
80 | enum SegmentDisplayMode { | |
81 | ShowLastSegmentOnly = 1, | |
558ad6ce | 82 | ShowLastCompleteSegmentOnly, |
7daebd05 SA |
83 | ShowSingleSegmentOnly, |
84 | ShowAllSegments, | |
85 | ShowAccumulatedIntensity | |
86 | }; | |
87 | ||
931f20b0 | 88 | private: |
fe08b6e8 | 89 | static const QPen AxisPen; |
931f20b0 JH |
90 | static const int LabelHitPadding; |
91 | ||
641574bc SA |
92 | static const QColor BrightGrayBGColor; |
93 | static const QColor DarkGrayBGColor; | |
ac0708fb | 94 | |
931f20b0 | 95 | protected: |
6f925ba9 | 96 | Trace(shared_ptr<data::SignalBase> channel); |
99c49526 | 97 | ~Trace(); |
931f20b0 JH |
98 | |
99 | public: | |
5ed05b69 SA |
100 | /** |
101 | * Returns the underlying SignalBase instance. | |
102 | */ | |
103 | shared_ptr<data::SignalBase> base() const; | |
104 | ||
7daebd05 SA |
105 | /** |
106 | * Configures the segment display mode to use. | |
107 | */ | |
108 | virtual void set_segment_display_mode(SegmentDisplayMode mode); | |
109 | ||
1931b5f9 SA |
110 | virtual void on_setting_changed(const QString &key, const QVariant &value); |
111 | ||
931f20b0 | 112 | /** |
7db87de3 | 113 | * Paints the signal label. |
931f20b0 | 114 | * @param p the QPainter to paint into. |
b3f44329 | 115 | * @param rect the rectangle of the header area. |
931f20b0 JH |
116 | * @param hover true if the label is being hovered over by the mouse. |
117 | */ | |
b3f44329 | 118 | virtual void paint_label(QPainter &p, const QRect &rect, bool hover); |
931f20b0 | 119 | |
9b6378f1 JH |
120 | virtual QMenu* create_context_menu(QWidget *parent); |
121 | ||
569d1e41 JH |
122 | pv::widgets::Popup* create_popup(QWidget *parent); |
123 | ||
d7c0ca4a JH |
124 | /** |
125 | * Computes the outline rectangle of a label. | |
b3f44329 | 126 | * @param rect the rectangle of the header area. |
d7c0ca4a JH |
127 | * @return Returns the rectangle of the signal label. |
128 | */ | |
b3f44329 | 129 | QRectF label_rect(const QRectF &rect) const; |
d7c0ca4a | 130 | |
d9b55cc8 SA |
131 | /** |
132 | * Computes the outline rectangle of the viewport hit-box. | |
133 | * @param rect the rectangle of the viewport area. | |
134 | * @return Returns the rectangle of the hit-box. | |
135 | * @remarks The default implementation returns an empty hit-box. | |
136 | */ | |
137 | virtual QRectF hit_box_rect(const ViewItemPaintParams &pp) const; | |
138 | ||
2749b858 SA |
139 | void set_current_segment(const int segment); |
140 | ||
141 | int get_current_segment() const; | |
142 | ||
1931b5f9 SA |
143 | virtual void hover_point_changed(const QPoint &hp); |
144 | ||
569d1e41 | 145 | protected: |
99af6802 | 146 | /** |
5d738861 UH |
147 | * Paints the background layer of the signal with a QPainter. |
148 | * @param p The QPainter to paint into. | |
149 | * @param pp The painting parameters object to paint with. | |
99af6802 | 150 | */ |
60938e04 | 151 | virtual void paint_back(QPainter &p, ViewItemPaintParams &pp); |
99af6802 | 152 | |
fe08b6e8 JH |
153 | /** |
154 | * Paints a zero axis across the viewport. | |
155 | * @param p the QPainter to paint into. | |
97904bf7 | 156 | * @param pp the painting parameters object to paint with. |
fe08b6e8 | 157 | * @param y the y-offset of the axis. |
fe08b6e8 | 158 | */ |
60938e04 | 159 | void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y); |
fe08b6e8 | 160 | |
1931b5f9 SA |
161 | /** |
162 | * Draw a hover marker under the cursor position. | |
163 | * @param p The painter to draw into. | |
164 | */ | |
165 | void paint_hover_marker(QPainter &p); | |
166 | ||
641574bc | 167 | void add_color_option(QWidget *parent, QFormLayout *form); |
91e8bf08 | 168 | |
37fd11b1 JH |
169 | void create_popup_form(); |
170 | ||
569d1e41 JH |
171 | virtual void populate_popup_form(QWidget *parent, QFormLayout *form); |
172 | ||
bf0edd2b SA |
173 | protected Q_SLOTS: |
174 | virtual void on_name_changed(const QString &text); | |
68456dab | 175 | |
641574bc | 176 | virtual void on_color_changed(const QColor &color); |
91e8bf08 | 177 | |
20eaae39 JH |
178 | void on_popup_closed(); |
179 | ||
bf0edd2b SA |
180 | private Q_SLOTS: |
181 | void on_nameedit_changed(const QString &name); | |
182 | ||
641574bc | 183 | void on_coloredit_changed(const QColor &color); |
bf0edd2b | 184 | |
931f20b0 | 185 | protected: |
6f925ba9 | 186 | shared_ptr<data::SignalBase> base_; |
561ba3ae | 187 | QPen axis_pen_; |
931f20b0 | 188 | |
7daebd05 | 189 | SegmentDisplayMode segment_display_mode_; |
1931b5f9 | 190 | bool show_hover_marker_; |
7daebd05 | 191 | |
2749b858 SA |
192 | /// The ID of the currently displayed segment |
193 | int current_segment_; | |
194 | ||
37fd11b1 | 195 | private: |
8dbbc7f0 JH |
196 | pv::widgets::Popup *popup_; |
197 | QFormLayout *popup_form_; | |
931f20b0 JH |
198 | }; |
199 | ||
1573bf16 | 200 | } // namespace trace |
f4e57597 | 201 | } // namespace views |
931f20b0 JH |
202 | } // namespace pv |
203 | ||
f4e57597 | 204 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP |