2 * This file is part of the PulseView project.
4 * Copyright (C) 2012 Joel Holdsworth <joel@airwebreathe.org.uk>
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.
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.
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
21 #ifndef PULSEVIEW_PV_VIEW_VIEW_HPP
22 #define PULSEVIEW_PV_VIEW_VIEW_HPP
29 #include <unordered_map>
32 #include <QAbstractScrollArea>
36 #include <pv/data/signaldata.hpp>
37 #include <pv/util.hpp>
39 #include "cursorpair.hpp"
41 #include "tracetreeitemowner.hpp"
60 class View : public QAbstractScrollArea, public TraceTreeItemOwner {
65 TraceTreeItemHExtentsChanged = 1,
66 TraceTreeItemVExtentsChanged = 2
70 static const pv::util::Timestamp MaxScale;
71 static const pv::util::Timestamp MinScale;
73 static const int MaxScrollValue;
74 static const int MaxViewAutoUpdateRate;
76 static const int ScaleUnits[3];
79 explicit View(Session &session, QWidget *parent = 0);
82 const Session& session() const;
85 * Returns the view of the owner.
87 virtual pv::view::View* view();
90 * Returns the view of the owner.
92 virtual const pv::view::View* view() const;
96 const Viewport* viewport() const;
99 * Gets a list of time markers.
101 std::vector< std::shared_ptr<TimeItem> > time_items() const;
104 * Returns the view time scale in seconds per pixel.
106 double scale() const;
109 * Returns the time offset of the left edge of the view in
112 const pv::util::Timestamp& offset() const;
115 * Returns the vertical scroll offset.
117 int owner_visual_v_offset() const;
120 * Sets the visual v-offset.
122 void set_v_offset(int offset);
125 * Returns the SI prefix to apply to the graticule time markings.
127 pv::util::SIPrefix tick_prefix() const;
130 * Returns the number of fractional digits shown for the time markings.
132 unsigned int tick_precision() const;
135 * Returns period of the graticule time markings.
137 const pv::util::Timestamp& tick_period() const;
140 * Returns the unit of time currently used.
142 util::TimeUnit time_unit() const;
145 * Returns the number of nested parents that this row item owner has.
147 unsigned int depth() const;
149 void zoom(double steps);
150 void zoom(double steps, int offset);
152 void zoom_fit(bool gui_state);
154 void zoom_one_to_one();
157 * Sets the scale and offset.
158 * @param scale The new view scale in seconds per pixel.
159 * @param offset The view time offset in seconds.
161 void set_scale_offset(double scale, const pv::util::Timestamp& offset);
163 std::set< std::shared_ptr<pv::data::SignalData> >
164 get_visible_data() const;
166 std::pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
169 * Enables or disables sticky scrolling, i.e. the view always shows
170 * the most recent samples when capturing data.
172 void enable_sticky_scrolling(bool state);
175 * Enables or disables coloured trace backgrounds. If they're not
176 * coloured then they will use alternating colors.
178 void enable_coloured_bg(bool state);
181 * Returns true if cursors are displayed. false otherwise.
183 bool cursors_shown() const;
186 * Shows or hides the cursors.
188 void show_cursors(bool show = true);
191 * Moves the cursors to a convenient position in the view.
193 void centre_cursors();
196 * Returns a reference to the pair of cursors.
198 std::shared_ptr<CursorPair> cursors() const;
201 * Adds a new flag at a specified time.
203 void add_flag(const pv::util::Timestamp& time);
206 * Removes a flag from the list.
208 void remove_flag(std::shared_ptr<Flag> flag);
211 * Gets the list of flags.
213 std::vector< std::shared_ptr<Flag> > flags() const;
215 const QPoint& hover_point() const;
217 void update_viewport();
219 void restack_all_trace_tree_items();
222 void hover_point_changed();
224 void selection_changed();
226 /// Emitted when the offset changed.
227 void offset_changed();
229 /// Emitted when the scale changed.
230 void scale_changed();
232 void sticky_scrolling_changed(bool state);
234 void always_zoom_to_fit_changed(bool state);
236 /// Emitted when the tick_prefix changed.
237 void tick_prefix_changed();
239 /// Emitted when the tick_precision changed.
240 void tick_precision_changed();
242 /// Emitted when the tick_period changed.
243 void tick_period_changed();
245 /// Emitted when the time_unit changed.
246 void time_unit_changed();
249 void trigger_event(util::Timestamp location);
252 void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
255 * Simultaneously sets the zoom and offset.
256 * @param scale The scale to set the view to in seconds per pixel. This
257 * value is clamped between MinScale and MaxScale.
258 * @param offset The offset of the left edge of the view in seconds.
260 void set_zoom(double scale, int offset);
263 * Find a tick spacing and number formatting that does not cause
264 * the values to collide.
266 void calculate_tick_spacing();
268 void update_scroll();
270 void update_layout();
273 * Satisifies TraceTreeItem functionality.
274 * @param p the QPainter to paint into.
275 * @param rect the rectangle of the header area.
276 * @param hover true if the label is being hovered over by the mouse.
278 void paint_label(QPainter &p, const QRect &rect, bool hover);
281 * Computes the outline rectangle of a label.
282 * @param rect the rectangle of the header area.
283 * @return Returns the rectangle of the signal label.
285 QRectF label_rect(const QRectF &rect);
287 TraceTreeItemOwner* find_prevalent_trace_group(
288 const std::shared_ptr<sigrok::ChannelGroup> &group,
289 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
290 std::shared_ptr<Signal> > &signal_map);
292 static std::vector< std::shared_ptr<Trace> >
293 extract_new_traces_for_channels(
294 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
295 const std::unordered_map<std::shared_ptr<sigrok::Channel>,
296 std::shared_ptr<Signal> > &signal_map,
297 std::set< std::shared_ptr<Trace> > &add_list);
299 void determine_time_unit();
301 bool eventFilter(QObject *object, QEvent *event);
303 bool viewportEvent(QEvent *event);
305 void resizeEvent(QResizeEvent *event);
308 void row_item_appearance_changed(bool label, bool content);
309 void time_item_appearance_changed(bool label, bool content);
311 void extents_changed(bool horz, bool vert);
315 void h_scroll_value_changed(int value);
316 void v_scroll_value_changed();
318 void signals_changed();
319 void capture_state_updated(int state);
322 void perform_delayed_view_update();
324 void process_sticky_events();
326 void on_hover_point_changed();
329 * Sets the 'offset_' member and emits the 'offset_changed'
332 void set_offset(const pv::util::Timestamp& offset);
335 * Sets the 'scale_' member and emits the 'scale_changed'
338 void set_scale(double scale);
341 * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
344 void set_tick_prefix(pv::util::SIPrefix tick_prefix);
347 * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
350 void set_tick_precision(unsigned tick_precision);
353 * Sets the 'tick_period_' member and emits the 'tick_period_changed'
356 void set_tick_period(const pv::util::Timestamp& tick_period);
359 * Sets the 'time_unit' member and emits the 'time_unit_changed'
362 void set_time_unit(pv::util::TimeUnit time_unit);
371 /// The view time scale in seconds per pixel.
374 /// The view time offset in seconds.
375 pv::util::Timestamp offset_;
377 bool updating_scroll_;
378 bool sticky_scrolling_;
379 bool always_zoom_to_fit_;
380 QTimer delayed_view_updater_;
382 pv::util::Timestamp tick_period_;
383 pv::util::SIPrefix tick_prefix_;
384 unsigned int tick_precision_;
385 util::TimeUnit time_unit_;
388 std::shared_ptr<CursorPair> cursors_;
390 std::list< std::shared_ptr<Flag> > flags_;
391 char next_flag_text_;
393 std::vector< std::shared_ptr<TriggerMarker> > trigger_markers_;
397 unsigned int sticky_events_;
398 QTimer lazy_event_handler_;
404 #endif // PULSEVIEW_PV_VIEW_VIEW_HPP