ViewItem: Make HighlightRadius truly a radius
[pulseview.git] / pv / view / view.hpp
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_VIEW_VIEW_H
22 #define PULSEVIEW_PV_VIEW_VIEW_H
23
24 #include <stdint.h>
25
26 #include <list>
27 #include <memory>
28 #include <set>
29 #include <unordered_map>
30 #include <vector>
31
32 #include <QAbstractScrollArea>
33 #include <QSizeF>
34 #include <QTimer>
35
36 #include <pv/data/signaldata.hpp>
37
38 #include "cursorpair.hpp"
39 #include "flag.hpp"
40 #include "rowitemowner.hpp"
41
42 namespace pv {
43
44 class Session;
45
46 namespace view {
47
48 class CursorHeader;
49 class Header;
50 class Ruler;
51 class Viewport;
52
53 class View : public QAbstractScrollArea, public RowItemOwner {
54         Q_OBJECT
55
56 private:
57         enum StickyEvents {
58                 RowItemHExtentsChanged = 1,
59                 RowItemVExtentsChanged = 2
60         };
61
62 private:
63         static const double MaxScale;
64         static const double MinScale;
65
66         static const int MaxScrollValue;
67
68         static const int ScaleUnits[3];
69
70 public:
71         static const QColor CursorAreaColour;
72
73         static const QSizeF LabelPadding;
74
75 public:
76         explicit View(Session &session, QWidget *parent = 0);
77
78         Session& session();
79         const Session& session() const;
80
81         /**
82          * Returns the view of the owner.
83          */
84         virtual pv::view::View* view();
85
86         /**
87          * Returns the view of the owner.
88          */
89         virtual const pv::view::View* view() const;
90
91         Viewport* viewport();
92
93         const Viewport* viewport() const;
94
95         /**
96          * Gets a list of time markers.
97          */
98         std::vector< std::shared_ptr<TimeItem> > time_items() const;
99
100         /**
101          * Returns the view time scale in seconds per pixel.
102          */
103         double scale() const;
104
105         /**
106          * Returns the time offset of the left edge of the view in
107          * seconds.
108          */
109         double offset() const;
110         int owner_visual_v_offset() const;
111
112         /**
113          * Returns the SI prefix to apply to the graticule time markings.
114          */
115         unsigned int tick_prefix() const;
116
117         /**
118          * Returns period of the graticule time markings.
119          */
120         double tick_period() const;
121
122         /**
123          * Returns the number of nested parents that this row item owner has.
124          */
125         unsigned int depth() const;
126
127         void zoom(double steps);
128         void zoom(double steps, int offset);
129
130         void zoom_fit();
131
132         void zoom_one_to_one();
133
134         /**
135          * Sets the scale and offset.
136          * @param scale The new view scale in seconds per pixel.
137          * @param offset The view time offset in seconds.
138          */
139         void set_scale_offset(double scale, double offset);
140
141         std::set< std::shared_ptr<pv::data::SignalData> >
142                 get_visible_data() const;
143
144         std::pair<double, double> get_time_extents() const;
145
146         /**
147          * Returns true if cursors are displayed. false otherwise.
148          */
149         bool cursors_shown() const;
150
151         /**
152          * Shows or hides the cursors.
153          */
154         void show_cursors(bool show = true);
155
156         /**
157          * Moves the cursors to a convenient position in the view.
158          */
159         void centre_cursors();
160
161         /**
162          * Returns a reference to the pair of cursors.
163          */
164         std::shared_ptr<CursorPair> cursors() const;
165
166         /**
167          * Adds a new flag at a specified time.
168          */
169         void add_flag(double time);
170
171         /**
172          * Removes a flag from the list.
173          */
174         void remove_flag(std::shared_ptr<Flag> flag);
175
176         /**
177          * Gets the list of flags.
178          */
179         std::vector< std::shared_ptr<Flag> > flags() const;
180
181         const QPoint& hover_point() const;
182
183         void update_viewport();
184
185         void restack_all_row_items();
186
187 Q_SIGNALS:
188         void hover_point_changed();
189
190         void signals_moved();
191
192         void selection_changed();
193
194         void scale_offset_changed();
195
196 private:
197         void get_scroll_layout(double &length, double &offset) const;
198
199         /**
200          * Simultaneously sets the zoom and offset.
201          * @param scale The scale to set the view to in seconds per pixel. This
202          * value is clamped between MinScale and MaxScale.
203          * @param offset The offset of the left edge of the view in seconds.
204          */
205         void set_zoom(double scale, int offset);
206
207         /**
208          * Find a tick spacing and number formatting that does not cause
209          * the values to collide.
210          */
211         void calculate_tick_spacing();
212
213         void update_scroll();
214
215         void update_layout();
216
217         /**
218          * Satisifies RowItem functionality.
219          * @param p the QPainter to paint into.
220          * @param rect the rectangle of the header area.
221          * @param hover true if the label is being hovered over by the mouse.
222          */
223         void paint_label(QPainter &p, const QRect &rect, bool hover);
224
225         /**
226          * Computes the outline rectangle of a label.
227          * @param rect the rectangle of the header area.
228          * @return Returns the rectangle of the signal label.
229          */
230         QRectF label_rect(const QRectF &rect);
231
232         static bool add_channels_to_owner(
233                 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
234                 RowItemOwner *owner, int &offset,
235                 std::unordered_map<std::shared_ptr<sigrok::Channel>,
236                         std::shared_ptr<Signal> > &signal_map,
237                 std::function<bool (std::shared_ptr<RowItem>)> filter_func =
238                         std::function<bool (std::shared_ptr<RowItem>)>());
239
240         static void apply_offset(
241                 std::shared_ptr<RowItem> row_item, int &offset);
242
243 private:
244         bool eventFilter(QObject *object, QEvent *event);
245
246         bool viewportEvent(QEvent *e);
247
248         void resizeEvent(QResizeEvent *e);
249
250 public:
251         void row_item_appearance_changed(bool label, bool content);
252         void time_item_appearance_changed(bool label, bool content);
253
254         void extents_changed(bool horz, bool vert);
255
256 private Q_SLOTS:
257
258         void h_scroll_value_changed(int value);
259         void v_scroll_value_changed(int value);
260
261         void signals_changed();
262         void data_updated();
263
264         void on_signals_moved();
265
266         void process_sticky_events();
267
268         void on_hover_point_changed();
269
270 private:
271         Session &session_;
272
273         Viewport *viewport_;
274         Ruler *ruler_;
275         CursorHeader *cursorheader_;
276         Header *header_;
277
278         /// The view time scale in seconds per pixel.
279         double scale_;
280
281         /// The view time offset in seconds.
282         double offset_;
283
284         int v_offset_;
285         bool updating_scroll_;
286
287         double tick_period_;
288         unsigned int tick_prefix_;
289
290         bool show_cursors_;
291         std::shared_ptr<CursorPair> cursors_;
292
293         std::list< std::shared_ptr<Flag> > flags_;
294         char next_flag_text_;
295
296         QPoint hover_point_;
297
298         unsigned int sticky_events_;
299         QTimer lazy_event_handler_;
300 };
301
302 } // namespace view
303 } // namespace pv
304
305 #endif // PULSEVIEW_PV_VIEW_VIEW_H