pv/views/trace/cursorpair.cpp

   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 #include <algorithm>
  21 #include <cassert>
  22
  23 #include <QColor>
  24 #include <QToolTip>
  25
  26 #include "cursorpair.hpp"
  27
  28 #include "pv/globalsettings.hpp"
  29 #include "pv/util.hpp"
  30 #include "ruler.hpp"
  31 #include "view.hpp"
  32
  33 using std::max;
  34 using std::make_pair;
  35 using std::min;
  36 using std::shared_ptr;
  37 using std::pair;
  38
  39 namespace pv {
  40 namespace views {
  41 namespace trace {
  42
  43 const int CursorPair::DeltaPadding = 8;
  44
  45 CursorPair::CursorPair(View &view) :
  46         TimeItem(view),
  47         first_(new Cursor(view, 0.0)),
  48         second_(new Cursor(view, 1.0))
  49 {
  50         GlobalSettings::add_change_handler(this);
  51
  52         GlobalSettings settings;
  53         fill_color_ = QColor::fromRgba(settings.value(
  54                 GlobalSettings::Key_View_CursorFillColor).value<uint32_t>());
  55
  56         connect(&view_, SIGNAL(hover_point_changed(const QWidget*, QPoint)),
  57                 this, SLOT(on_hover_point_changed(const QWidget*, QPoint)));
  58 }
  59
  60 CursorPair::~CursorPair()
  61 {
  62         GlobalSettings::remove_change_handler(this);
  63 }
  64
  65 bool CursorPair::enabled() const
  66 {
  67         return view_.cursors_shown();
  68 }
  69
  70 shared_ptr<Cursor> CursorPair::first() const
  71 {
  72         return first_;
  73 }
  74
  75 shared_ptr<Cursor> CursorPair::second() const
  76 {
  77         return second_;
  78 }
  79
  80 void CursorPair::set_time(const pv::util::Timestamp& time)
  81 {
  82         const pv::util::Timestamp delta = second_->time() - first_->time();
  83         first_->set_time(time);
  84         second_->set_time(time + delta);
  85 }
  86
  87 float CursorPair::get_x() const
  88 {
  89         return (first_->get_x() + second_->get_x()) / 2.0f;
  90 }
  91
  92 QPoint CursorPair::drag_point(const QRect &rect) const
  93 {
  94         return first_->drag_point(rect);
  95 }
  96
  97 pv::widgets::Popup* CursorPair::create_popup(QWidget *parent)
  98 {
  99         (void)parent;
 100         return nullptr;
 101 }
 102
 103 QRectF CursorPair::label_rect(const QRectF &rect) const
 104 {
 105         const QSizeF label_size(text_size_ + LabelPadding * 2);
 106         const pair<float, float> offsets(get_cursor_offsets());
 107         const pair<float, float> normal_offsets(
 108                 (offsets.first < offsets.second) ? offsets :
 109                 make_pair(offsets.second, offsets.first));
 110
 111         const float height = label_size.height();
 112         const float left = max(normal_offsets.first + DeltaPadding, -height);
 113         const float right = min(normal_offsets.second - DeltaPadding,
 114                 (float)rect.width() + height);
 115
 116         return QRectF(left, rect.height() - label_size.height() -
 117                 TimeMarker::ArrowSize - 0.5f,
 118                 right - left, height);
 119 }
 120
 121 void CursorPair::paint_label(QPainter &p, const QRect &rect, bool hover)
 122 {
 123         assert(first_);
 124         assert(second_);
 125
 126         if (!enabled())
 127                 return;
 128
 129         const QColor text_color = ViewItem::select_text_color(Cursor::FillColor);
 130         p.setPen(text_color);
 131
 132         QRectF delta_rect(label_rect(rect));
 133         const int radius = delta_rect.height() / 2;
 134         QRectF text_rect(delta_rect.intersected(rect).adjusted(radius, 0, -radius, 0));
 135
 136         QString text = format_string(text_rect.width(),
 137                 [&p](const QString& s) -> double { return p.boundingRect(QRectF(), 0, s).width(); });
 138
 139         text_size_ = p.boundingRect(QRectF(), 0, text).size();
 140
 141         if (selected()) {
 142                 p.setBrush(Qt::transparent);
 143                 p.setPen(highlight_pen());
 144                 p.drawRoundedRect(delta_rect, radius, radius);
 145         }
 146
 147         p.setBrush(hover ? Cursor::FillColor.lighter() : Cursor::FillColor);
 148         p.setPen(Cursor::FillColor.darker());
 149         p.drawRoundedRect(delta_rect, radius, radius);
 150
 151         delta_rect.adjust(1, 1, -1, -1);
 152         p.setPen(Cursor::FillColor.lighter());
 153         const int highlight_radius = delta_rect.height() / 2 - 2;
 154         p.drawRoundedRect(delta_rect, highlight_radius, highlight_radius);
 155         label_area_ = delta_rect;
 156
 157         p.setPen(text_color);
 158         p.drawText(text_rect, Qt::AlignCenter | Qt::AlignVCenter, text);
 159 }
 160
 161 void CursorPair::paint_back(QPainter &p, ViewItemPaintParams &pp)
 162 {
 163         if (!enabled())
 164                 return;
 165
 166         p.setPen(Qt::NoPen);
 167         p.setBrush(fill_color_);
 168
 169         const pair<float, float> offsets(get_cursor_offsets());
 170         const int l = (int)max(min(offsets.first, offsets.second), 0.0f);
 171         const int r = (int)min(max(offsets.first, offsets.second), (float)pp.width());
 172
 173         p.drawRect(l, pp.top(), r - l, pp.height());
 174 }
 175
 176 QString CursorPair::format_string(int max_width, std::function<double(const QString&)> query_size)
 177 {
 178         int time_precision = 12;
 179         int freq_precision = 12;
 180
 181         QString s = format_string_sub(time_precision, freq_precision);
 182
 183         // Try full "{time} s / {freq} Hz" format
 184         if ((max_width <= 0) || (query_size(s) <= max_width)) {
 185                 label_incomplete_ = false;
 186                 return s;
 187         }
 188
 189         label_incomplete_ = true;
 190
 191         // Gradually reduce time precision to match frequency precision
 192         while (time_precision > freq_precision) {
 193                 time_precision--;
 194
 195                 s = format_string_sub(time_precision, freq_precision);
 196                 if (query_size(s) <= max_width)
 197                         return s;
 198         }
 199
 200         // Gradually reduce both precisions down to zero
 201         while (time_precision > 0) {
 202                 time_precision--;
 203                 freq_precision--;
 204
 205                 s = format_string_sub(time_precision, freq_precision);
 206                 if (query_size(s) <= max_width)
 207                         return s;
 208         }
 209
 210         // Try no trailing digits and drop the unit to at least display something
 211         s = format_string_sub(0, 0, false);
 212
 213         if (query_size(s) <= max_width)
 214                 return s;
 215
 216         // Give up
 217         return "...";
 218 }
 219
 220 pair<float, float> CursorPair::get_cursor_offsets() const
 221 {
 222         assert(first_);
 223         assert(second_);
 224
 225         return pair<float, float>(first_->get_x(), second_->get_x());
 226 }
 227
 228 void CursorPair::on_setting_changed(const QString &key, const QVariant &value)
 229 {
 230         if (key == GlobalSettings::Key_View_CursorFillColor)
 231                 fill_color_ = QColor::fromRgba(value.value<uint32_t>());
 232 }
 233
 234 void CursorPair::on_hover_point_changed(const QWidget* widget, const QPoint& hp)
 235 {
 236         if (widget != view_.ruler())
 237                 return;
 238
 239         if (!label_incomplete_)
 240                 return;
 241
 242         if (label_area_.contains(hp))
 243                 QToolTip::showText(view_.mapToGlobal(hp), format_string());
 244         else
 245                 QToolTip::hideText();  // TODO Will break other tooltips when there can be others
 246 }
 247
 248 QString CursorPair::format_string_sub(int time_precision, int freq_precision, bool show_unit)
 249 {
 250         const pv::util::SIPrefix prefix = view_.tick_prefix();
 251         const pv::util::Timestamp diff = abs(second_->time() - first_->time());
 252
 253         const QString time = Ruler::format_time_with_distance(
 254                 diff, diff, prefix, (show_unit ? view_.time_unit() : pv::util::TimeUnit::None),
 255                 time_precision, false);
 256
 257         // We can only show a frequency when there's a time base
 258         if (view_.time_unit() == pv::util::TimeUnit::Time) {
 259                 const QString freq = util::format_value_si(
 260                         1 / diff.convert_to<double>(), pv::util::SIPrefix::unspecified,
 261                         freq_precision, (show_unit ? "Hz" : nullptr), false);
 262
 263                 return QString("%1 / %2").arg(time, freq);
 264         } else
 265                 // In this case, we return the number of samples, really
 266                 return time;
 267 }
 268
 269 } // namespace trace
 270 } // namespace views
 271 } // namespace pv