pv/view/ruler.cpp

   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 #include "ruler.h"
  22
  23 #include "cursor.h"
  24 #include "view.h"
  25 #include "viewport.h"
  26
  27 #include <extdef.h>
  28
  29 #include <assert.h>
  30 #include <math.h>
  31 #include <limits.h>
  32
  33 #include <QMouseEvent>
  34 #include <QPainter>
  35 #include <QTextStream>
  36
  37 using namespace std;
  38
  39 namespace pv {
  40 namespace view {
  41
  42 const int Ruler::MinorTickSubdivision = 4;
  43 const int Ruler::ScaleUnits[3] = {1, 2, 5};
  44
  45 const QString Ruler::SIPrefixes[9] =
  46         {"f", "p", "n", QChar(0x03BC), "m", "", "k", "M", "G"};
  47 const int Ruler::FirstSIPrefixPower = -15;
  48
  49 const int Ruler::HoverArrowSize = 5;
  50
  51 Ruler::Ruler(View &parent) :
  52         QWidget(&parent),
  53         _view(parent),
  54         _grabbed_marker(NULL)
  55 {
  56         setMouseTracking(true);
  57
  58         connect(&_view, SIGNAL(hover_point_changed()),
  59                 this, SLOT(hover_point_changed()));
  60 }
  61
  62 QString Ruler::format_time(double t, unsigned int prefix,
  63         unsigned int precision)
  64 {
  65         const double multiplier = pow(10.0,
  66                 - prefix * 3 - FirstSIPrefixPower);
  67
  68         QString s;
  69         QTextStream ts(&s);
  70         ts.setRealNumberPrecision(precision);
  71         ts << fixed << forcesign << (t  * multiplier) <<
  72                 SIPrefixes[prefix] << "s";
  73         return s;
  74 }
  75
  76 void Ruler::paintEvent(QPaintEvent*)
  77 {
  78         using namespace Qt;
  79
  80         const double SpacingIncrement = 32.0f;
  81         const double MinValueSpacing = 32.0f;
  82         const int ValueMargin = 3;
  83
  84         QPainter p(this);
  85         p.setRenderHint(QPainter::Antialiasing);
  86
  87         double min_width = SpacingIncrement, typical_width;
  88         double tick_period;
  89         unsigned int prefix;
  90
  91         // Find tick spacing, and number formatting that does not cause
  92         // value to collide.
  93         do
  94         {
  95                 const double min_period = _view.scale() * min_width;
  96
  97                 const int order = (int)floorf(log10f(min_period));
  98                 const double order_decimal = pow(10, order);
  99
 100                 unsigned int unit = 0;
 101
 102                 do
 103                 {
 104                         tick_period = order_decimal * ScaleUnits[unit++];
 105                 } while (tick_period < min_period && unit < countof(ScaleUnits));
 106
 107                 prefix = (order - FirstSIPrefixPower) / 3;
 108                 assert(prefix < countof(SIPrefixes));
 109
 110
 111                 typical_width = p.boundingRect(0, 0, INT_MAX, INT_MAX,
 112                         AlignLeft | AlignTop, format_time(_view.offset(),
 113                         prefix)).width() + MinValueSpacing;
 114
 115                 min_width += SpacingIncrement;
 116
 117         } while(typical_width > tick_period / _view.scale());
 118
 119         const int text_height = p.boundingRect(0, 0, INT_MAX, INT_MAX,
 120                 AlignLeft | AlignTop, "8").height();
 121
 122         // Draw the tick marks
 123         p.setPen(palette().color(foregroundRole()));
 124
 125         const double minor_tick_period = tick_period / MinorTickSubdivision;
 126         const double first_major_division =
 127                 floor(_view.offset() / tick_period);
 128         const double first_minor_division =
 129                 ceil(_view.offset() / minor_tick_period);
 130         const double t0 = first_major_division * tick_period;
 131
 132         int division = (int)round(first_minor_division -
 133                 first_major_division * MinorTickSubdivision) - 1;
 134
 135         const int major_tick_y1 = text_height + ValueMargin * 2;
 136         const int tick_y2 = height();
 137         const int minor_tick_y1 = (major_tick_y1 + tick_y2) / 2;
 138
 139         double x;
 140
 141         do {
 142                 const double t = t0 + division * minor_tick_period;
 143                 x = (t - _view.offset()) / _view.scale();
 144
 145                 if (division % MinorTickSubdivision == 0)
 146                 {
 147                         // Draw a major tick
 148                         p.drawText(x, ValueMargin, 0, text_height,
 149                                 AlignCenter | AlignTop | TextDontClip,
 150                                 format_time(t, prefix));
 151                         p.drawLine(QPointF(x, major_tick_y1),
 152                                 QPointF(x, tick_y2));
 153                 }
 154                 else
 155                 {
 156                         // Draw a minor tick
 157                         p.drawLine(QPointF(x, minor_tick_y1),
 158                                 QPointF(x, tick_y2));
 159                 }
 160
 161                 division++;
 162
 163         } while (x < width());
 164
 165         // Draw the cursors
 166         draw_cursors(p, prefix);
 167
 168         // Draw the hover mark
 169         draw_hover_mark(p);
 170
 171         p.end();
 172 }
 173
 174 void Ruler::mouseMoveEvent(QMouseEvent *e)
 175 {
 176         if (!_grabbed_marker)
 177                 return;
 178
 179         _grabbed_marker->set_time(_view.offset() +
 180                 ((double)e->x() + 0.5) * _view.scale());
 181 }
 182
 183 void Ruler::mousePressEvent(QMouseEvent *e)
 184 {
 185         if (e->buttons() & Qt::LeftButton) {
 186                 _grabbed_marker = NULL;
 187
 188                 if (_view.cursors_shown()) {
 189                         std::pair<Cursor, Cursor> &cursors =
 190                                 _view.cursors();
 191                         if (cursors.first.get_label_rect(
 192                                 rect()).contains(e->pos()))
 193                                 _grabbed_marker = &cursors.first;
 194                         else if (cursors.second.get_label_rect(
 195                                 rect()).contains(e->pos()))
 196                                 _grabbed_marker = &cursors.second;
 197                 }
 198         }
 199 }
 200
 201 void Ruler::mouseReleaseEvent(QMouseEvent *)
 202 {
 203         _grabbed_marker = NULL;
 204 }
 205
 206 void Ruler::draw_cursors(QPainter &p, unsigned int prefix)
 207 {
 208         if (!_view.cursors_shown())
 209                 return;
 210
 211         const QRect r = rect();
 212         pair<Cursor, Cursor> &cursors = _view.cursors();
 213         cursors.first.paint_label(p, r, prefix);
 214         cursors.second.paint_label(p, r, prefix);
 215 }
 216
 217 void Ruler::draw_hover_mark(QPainter &p)
 218 {
 219         const int x = _view.hover_point().x();
 220
 221         if (x == -1 || _grabbed_marker)
 222                 return;
 223
 224         p.setPen(QPen(Qt::NoPen));
 225         p.setBrush(QBrush(palette().color(foregroundRole())));
 226
 227         const int b = height() - 1;
 228         const QPointF points[] = {
 229                 QPointF(x, b),
 230                 QPointF(x - HoverArrowSize, b - HoverArrowSize),
 231                 QPointF(x + HoverArrowSize, b - HoverArrowSize)
 232         };
 233         p.drawPolygon(points, countof(points));
 234 }
 235
 236 void Ruler::hover_point_changed()
 237 {
 238         update();
 239 }
 240
 241 } // namespace view
 242 } // namespace pv