]> sigrok.org Git - pulseview.git/blame_incremental - pv/views/trace/ruler.cpp
Fixes
[pulseview.git] / pv / views / trace / ruler.cpp
... / ...
CommitLineData
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, see <http://www.gnu.org/licenses/>.
18 */
19
20#include <extdef.h>
21
22#include <QApplication>
23#include <QFontMetrics>
24#include <QMenu>
25#include <QMouseEvent>
26
27#include <pv/globalsettings.hpp>
28
29#include "ruler.hpp"
30#include "view.hpp"
31
32using namespace Qt;
33
34using std::function;
35using std::max;
36using std::min;
37using std::shared_ptr;
38using std::vector;
39
40namespace pv {
41namespace views {
42namespace trace {
43
44const float Ruler::RulerHeight = 2.5f; // x Text Height
45
46const float Ruler::HoverArrowSize = 0.5f; // x Text Height
47
48Ruler::Ruler(View &parent) :
49 MarginWidget(parent)
50{
51 setMouseTracking(true);
52
53 connect(&view_, SIGNAL(hover_point_changed(const QWidget*, QPoint)),
54 this, SLOT(on_hover_point_changed(const QWidget*, QPoint)));
55 connect(&view_, SIGNAL(offset_changed()),
56 this, SLOT(invalidate_tick_position_cache()));
57 connect(&view_, SIGNAL(scale_changed()),
58 this, SLOT(invalidate_tick_position_cache()));
59 connect(&view_, SIGNAL(tick_prefix_changed()),
60 this, SLOT(invalidate_tick_position_cache()));
61 connect(&view_, SIGNAL(tick_precision_changed()),
62 this, SLOT(invalidate_tick_position_cache()));
63 connect(&view_, SIGNAL(tick_period_changed()),
64 this, SLOT(invalidate_tick_position_cache()));
65 connect(&view_, SIGNAL(time_unit_changed()),
66 this, SLOT(invalidate_tick_position_cache()));
67}
68
69QSize Ruler::sizeHint() const
70{
71 const int text_height = calculate_text_height();
72 return QSize(0, RulerHeight * text_height);
73}
74
75QSize Ruler::extended_size_hint() const
76{
77 QRectF max_rect;
78 vector< shared_ptr<TimeItem> > items(view_.time_items());
79 for (auto &i : items)
80 max_rect = max_rect.united(i->label_rect(QRect()));
81 return QSize(0, sizeHint().height() - max_rect.top() / 2 +
82 ViewItem::HighlightRadius);
83}
84
85QString Ruler::format_time_with_distance(
86 const pv::util::Timestamp& distance,
87 const pv::util::Timestamp& t,
88 pv::util::SIPrefix prefix,
89 pv::util::TimeUnit unit,
90 unsigned precision,
91 bool sign)
92{
93 const unsigned limit = 60;
94
95 if (t.is_zero())
96 return "0";
97
98 // If we have to use samples then we have no alternative formats
99 if (unit == pv::util::TimeUnit::Samples)
100 return pv::util::format_time_si_adjusted(t, prefix, precision, "sa", sign);
101
102 QString unit_string;
103 if (unit == pv::util::TimeUnit::Time)
104 unit_string = "s";
105 // Note: In case of pv::util::TimeUnit::None, unit_string remains empty
106
107 // View zoomed way out -> low precision (0), big distance (>=60s)
108 // -> DD:HH:MM
109 if ((precision == 0) && (distance >= limit))
110 return pv::util::format_time_minutes(t, 0, sign);
111
112 // View in "normal" range -> medium precision, medium step size
113 // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
114 // View zoomed way in -> high precision (>3), low step size (<1s)
115 // -> HH:MM:SS.mmm... or xxxx (si unit) if less than limit seconds
116 if (abs(t) < limit)
117 return pv::util::format_time_si_adjusted(t, prefix, precision, unit_string, sign);
118 else
119 return pv::util::format_time_minutes(t, precision, sign);
120}
121
122pv::util::Timestamp Ruler::get_absolute_time_from_x_pos(uint32_t x) const
123{
124 return view_.offset() + ((double)x + 0.5) * view_.scale();
125}
126
127pv::util::Timestamp Ruler::get_ruler_time_from_x_pos(uint32_t x) const
128{
129 return view_.ruler_offset() + ((double)x + 0.5) * view_.scale();
130}
131
132void Ruler::contextMenuEvent(QContextMenuEvent *event)
133{
134 MarginWidget::contextMenuEvent(event);
135
136 // Don't show a context menu if the MarginWidget found a widget that shows one
137 if (event->isAccepted())
138 return;
139
140 context_menu_x_pos_ = event->pos().x();
141
142 QMenu *const menu = new QMenu(this);
143
144 QAction *const create_marker = new QAction(tr("Create marker here"), this);
145 connect(create_marker, SIGNAL(triggered()), this, SLOT(on_createMarker()));
146 menu->addAction(create_marker);
147
148 QAction *const set_zero_position = new QAction(tr("Set as zero point"), this);
149 connect(set_zero_position, SIGNAL(triggered()), this, SLOT(on_setZeroPosition()));
150 menu->addAction(set_zero_position);
151
152 QAction *const toggle_hover_marker = new QAction(this);
153 connect(toggle_hover_marker, SIGNAL(triggered()), this, SLOT(on_toggleHoverMarker()));
154 menu->addAction(toggle_hover_marker);
155
156 GlobalSettings settings;
157 const bool hover_marker_shown =
158 settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
159 toggle_hover_marker->setText(hover_marker_shown ?
160 tr("Disable mouse hover marker") : tr("Enable mouse hover marker"));
161
162 event->setAccepted(true);
163 menu->popup(event->globalPos());
164}
165
166void Ruler::resizeEvent(QResizeEvent*)
167{
168 // the tick calculation depends on the width of this widget
169 invalidate_tick_position_cache();
170}
171
172vector< shared_ptr<ViewItem> > Ruler::items()
173{
174 const vector< shared_ptr<TimeItem> > time_items(view_.time_items());
175 return vector< shared_ptr<ViewItem> >(
176 time_items.begin(), time_items.end());
177}
178
179shared_ptr<ViewItem> Ruler::get_mouse_over_item(const QPoint &pt)
180{
181 const vector< shared_ptr<TimeItem> > items(view_.time_items());
182 for (auto i = items.rbegin(); i != items.rend(); i++)
183 if ((*i)->enabled() && (*i)->label_rect(rect()).contains(pt))
184 return *i;
185 return nullptr;
186}
187
188void Ruler::mouseDoubleClickEvent(QMouseEvent *event)
189{
190 view_.add_flag(get_ruler_time_from_x_pos(event->x()));
191}
192
193void Ruler::paintEvent(QPaintEvent*)
194{
195 if (!tick_position_cache_) {
196 auto ffunc = [this](const pv::util::Timestamp& t) {
197 return format_time_with_distance(
198 this->view_.tick_period(),
199 t,
200 this->view_.tick_prefix(),
201 this->view_.time_unit(),
202 this->view_.tick_precision());
203 };
204
205 tick_position_cache_ = calculate_tick_positions(
206 view_.tick_period(),
207 view_.ruler_offset(),
208 view_.scale(),
209 width(),
210 view_.minor_tick_count(),
211 ffunc);
212 }
213
214 const int ValueMargin = 3;
215
216 const int text_height = calculate_text_height();
217 const int ruler_height = RulerHeight * text_height;
218 const int major_tick_y1 = text_height + ValueMargin * 2;
219 const int minor_tick_y1 = (major_tick_y1 + ruler_height) / 2;
220
221 QPainter p(this);
222
223 // Draw the tick marks
224 p.setPen(palette().color(foregroundRole()));
225
226 for (const auto& tick: tick_position_cache_->major) {
227 const int leftedge = 0;
228 const int rightedge = width();
229 const int x_tick = tick.first;
230 if ((x_tick > leftedge) && (x_tick < rightedge)) {
231 const int x_left_bound = QFontMetrics(font()).width(tick.second) / 2;
232 const int x_right_bound = rightedge - x_left_bound;
233 const int x_legend = min(max(x_tick, x_left_bound), x_right_bound);
234 p.drawText(x_legend, ValueMargin, 0, text_height,
235 AlignCenter | AlignTop | TextDontClip, tick.second);
236 p.drawLine(QPointF(x_tick, major_tick_y1),
237 QPointF(tick.first, ruler_height));
238 }
239 }
240
241 for (const auto& tick: tick_position_cache_->minor) {
242 p.drawLine(QPointF(tick, minor_tick_y1),
243 QPointF(tick, ruler_height));
244 }
245
246 // Draw the hover mark
247 draw_hover_mark(p, text_height);
248
249 p.setRenderHint(QPainter::Antialiasing);
250
251 // The cursor labels are not drawn with the arrows exactly on the
252 // bottom line of the widget, because then the selection shadow
253 // would be clipped away.
254 const QRect r = rect().adjusted(0, 0, 0, -ViewItem::HighlightRadius);
255
256 // Draw the items
257 const vector< shared_ptr<TimeItem> > items(view_.time_items());
258 for (auto &i : items) {
259 const bool highlight = !item_dragging_ &&
260 i->label_rect(r).contains(mouse_point_);
261 i->paint_label(p, r, highlight);
262 }
263}
264
265void Ruler::draw_hover_mark(QPainter &p, int text_height)
266{
267 const int x = view_.hover_point().x();
268
269 if (x == -1)
270 return;
271
272 p.setPen(QPen(Qt::NoPen));
273 p.setBrush(QBrush(palette().color(foregroundRole())));
274
275 const int b = RulerHeight * text_height;
276 const float hover_arrow_size = HoverArrowSize * text_height;
277 const QPointF points[] = {
278 QPointF(x, b),
279 QPointF(x - hover_arrow_size, b - hover_arrow_size),
280 QPointF(x + hover_arrow_size, b - hover_arrow_size)
281 };
282 p.drawPolygon(points, countof(points));
283}
284
285int Ruler::calculate_text_height() const
286{
287 return QFontMetrics(font()).ascent();
288}
289
290TickPositions Ruler::calculate_tick_positions(
291 const pv::util::Timestamp& major_period,
292 const pv::util::Timestamp& offset,
293 const double scale,
294 const int width,
295 const unsigned int minor_tick_count,
296 function<QString(const pv::util::Timestamp&)> format_function)
297{
298 TickPositions tp;
299
300 const pv::util::Timestamp minor_period = major_period / minor_tick_count;
301 const pv::util::Timestamp first_major_division = floor(offset / major_period);
302 const pv::util::Timestamp first_minor_division = ceil(offset / minor_period);
303 const pv::util::Timestamp t0 = first_major_division * major_period;
304
305 int division = (round(first_minor_division -
306 first_major_division * minor_tick_count)).convert_to<int>() - 1;
307
308 double x;
309
310 do {
311 pv::util::Timestamp t = t0 + division * minor_period;
312 x = ((t - offset) / scale).convert_to<double>();
313
314 if (division % minor_tick_count == 0) {
315 // Recalculate 't' without using 'minor_period' which is a fraction
316 t = t0 + division / minor_tick_count * major_period;
317 tp.major.emplace_back(x, format_function(t));
318 } else {
319 tp.minor.emplace_back(x);
320 }
321
322 division++;
323 } while (x < width);
324
325 return tp;
326}
327
328void Ruler::on_hover_point_changed(const QWidget* widget, const QPoint &hp)
329{
330 (void)widget;
331 (void)hp;
332
333 update();
334}
335
336void Ruler::invalidate_tick_position_cache()
337{
338 tick_position_cache_ = boost::none;
339}
340
341void Ruler::on_createMarker()
342{
343 view_.add_flag(get_absolute_time_from_x_pos(mouse_down_point_.x()));
344}
345
346void Ruler::on_setZeroPosition()
347{
348 view_.set_zero_position(get_absolute_time_from_x_pos(mouse_down_point_.x()));
349}
350
351void Ruler::on_toggleHoverMarker()
352{
353 GlobalSettings settings;
354 const bool state = settings.value(GlobalSettings::Key_View_ShowHoverMarker).toBool();
355 settings.setValue(GlobalSettings::Key_View_ShowHoverMarker, !state);
356}
357
358} // namespace trace
359} // namespace views
360} // namespace pv