]> sigrok.org Git - pulseview.git/blobdiff - pv/view/view.cpp
Ruler: Factor out the calculation of the tick spacing
[pulseview.git] / pv / view / view.cpp
index 0844b6a47e6fd13c16d34ba85eddfc7850ec3974..fd8781d642f06fff22f1ef2250e7fa6cfd05a6c6 100644 (file)
@@ -62,6 +62,7 @@ using pv::data::SignalData;
 using pv::data::Segment;
 using pv::util::format_time;
 using pv::util::TimeUnit;
+using pv::util::Timestamp;
 
 using std::deque;
 using std::dynamic_pointer_cast;
@@ -83,8 +84,8 @@ using std::weak_ptr;
 namespace pv {
 namespace view {
 
-const double View::MaxScale = 1e9;
-const double View::MinScale = 1e-15;
+const Timestamp View::MaxScale("1e9");
+const Timestamp View::MinScale("1e-12");
 
 const int View::MaxScrollValue = INT_MAX / 2;
 const int View::MaxViewAutoUpdateRate = 25; // No more than 25 Hz with sticky scrolling
@@ -103,8 +104,9 @@ View::View(Session &session, QWidget *parent) :
        sticky_scrolling_(false), // Default setting is set in MainWindow::setup_ui()
        always_zoom_to_fit_(false),
        tick_period_(0.0),
-       tick_prefix_(0),
-       time_unit_(util::Time),
+       tick_prefix_(pv::util::SIPrefix::yocto),
+       tick_precision_(0),
+       time_unit_(util::TimeUnit::Time),
        show_cursors_(false),
        cursors_(new CursorPair(*this)),
        next_flag_text_('A'),
@@ -209,11 +211,27 @@ double View::scale() const
        return scale_;
 }
 
-double View::offset() const
+void View::set_scale(double scale)
+{
+       if (scale_ != scale) {
+               scale_ = scale;
+               Q_EMIT scale_changed();
+       }
+}
+
+const Timestamp& View::offset() const
 {
        return offset_;
 }
 
+void View::set_offset(const pv::util::Timestamp& offset)
+{
+       if (offset_ != offset) {
+               offset_ = offset;
+               Q_EMIT offset_changed();
+       }
+}
+
 int View::owner_visual_v_offset() const
 {
        return -verticalScrollBar()->sliderPosition();
@@ -231,21 +249,58 @@ unsigned int View::depth() const
        return 0;
 }
 
-unsigned int View::tick_prefix() const
+pv::util::SIPrefix View::tick_prefix() const
 {
        return tick_prefix_;
 }
 
+void View::set_tick_prefix(pv::util::SIPrefix tick_prefix)
+{
+       if (tick_prefix_ != tick_prefix) {
+               tick_prefix_ = tick_prefix;
+               Q_EMIT tick_prefix_changed();
+       }
+}
+
+unsigned int View::tick_precision() const
+{
+       return tick_precision_;
+}
+
+void View::set_tick_precision(unsigned tick_precision)
+{
+       if (tick_precision_ != tick_precision) {
+               tick_precision_ = tick_precision;
+               Q_EMIT tick_precision_changed();
+       }
+}
+
 double View::tick_period() const
 {
        return tick_period_;
 }
 
+void View::set_tick_period(double tick_period)
+{
+       if (tick_period_ != tick_period) {
+               tick_period_ = tick_period;
+               Q_EMIT tick_period_changed();
+       }
+}
+
 TimeUnit View::time_unit() const
 {
        return time_unit_;
 }
 
+void View::set_time_unit(pv::util::TimeUnit time_unit)
+{
+       if (time_unit_ != time_unit) {
+               time_unit_ = time_unit;
+               Q_EMIT time_unit_changed();
+       }
+}
+
 void View::zoom(double steps)
 {
        zoom(steps, viewport_->width() / 2);
@@ -267,9 +322,9 @@ void View::zoom_fit(bool gui_state)
                always_zoom_to_fit_changed(gui_state);
        }
 
-       const pair<double, double> extents = get_time_extents();
-       const double delta = extents.second - extents.first;
-       if (delta < 1e-12)
+       const pair<Timestamp, Timestamp> extents = get_time_extents();
+       const Timestamp delta = extents.second - extents.first;
+       if (delta < Timestamp("1e-12"))
                return;
 
        assert(viewport_);
@@ -277,8 +332,8 @@ void View::zoom_fit(bool gui_state)
        if (w <= 0)
                return;
 
-       const double scale = max(min(delta / w, MaxScale), MinScale);
-       set_scale_offset(scale, extents.first);
+       const Timestamp scale = max(min(delta / w, MaxScale), MinScale);
+       set_scale_offset(scale.convert_to<double>(), extents.first);
 }
 
 void View::zoom_one_to_one()
@@ -310,7 +365,7 @@ void View::zoom_one_to_one()
        set_zoom(1.0 / samplerate, w / 2);
 }
 
-void View::set_scale_offset(double scale, double offset)
+void View::set_scale_offset(double scale, const Timestamp& offset)
 {
        // Disable sticky scrolling / always zoom to fit when acquisition runs
        // and user drags the viewport
@@ -328,15 +383,14 @@ void View::set_scale_offset(double scale, double offset)
                }
        }
 
-       scale_ = scale;
-       offset_ = offset;
+       set_scale(scale);
+       set_offset(offset);
 
        calculate_tick_spacing();
 
        update_scroll();
        ruler_->update();
        viewport_->update();
-       scale_offset_changed();
 }
 
 set< shared_ptr<SignalData> > View::get_visible_data() const
@@ -353,9 +407,9 @@ set< shared_ptr<SignalData> > View::get_visible_data() const
        return visible_data;
 }
 
-pair<double, double> View::get_time_extents() const
+pair<Timestamp, Timestamp> View::get_time_extents() const
 {
-       double left_time = DBL_MAX, right_time = DBL_MIN;
+       boost::optional<Timestamp> left_time, right_time;
        const set< shared_ptr<SignalData> > visible_data = get_visible_data();
        for (const shared_ptr<SignalData> d : visible_data)
        {
@@ -365,18 +419,21 @@ pair<double, double> View::get_time_extents() const
                        double samplerate = s->samplerate();
                        samplerate = (samplerate <= 0.0) ? 1.0 : samplerate;
 
-                       const double start_time = s->start_time();
-                       left_time = min(left_time, start_time);
-                       right_time = max(right_time, start_time +
-                               d->max_sample_count() / samplerate);
+                       const Timestamp start_time = s->start_time();
+                       left_time = left_time ?
+                               min(*left_time, start_time) :
+                                               start_time;
+                       right_time = right_time ?
+                               max(*right_time, start_time + d->max_sample_count() / samplerate) :
+                                                start_time + d->max_sample_count() / samplerate;
                }
        }
 
-       if (left_time == DBL_MAX && right_time == DBL_MIN)
-               return make_pair(0.0, 0.0);
+       if (!left_time || !right_time)
+               return make_pair(00);
 
-       assert(left_time < right_time);
-       return make_pair(left_time, right_time);
+       assert(*left_time < *right_time);
+       return make_pair(*left_time, *right_time);
 }
 
 void View::enable_sticky_scrolling(bool state)
@@ -410,7 +467,7 @@ std::shared_ptr<CursorPair> View::cursors() const
        return cursors_;
 }
 
-void View::add_flag(double time)
+void View::add_flag(const Timestamp& time)
 {
        flags_.push_back(shared_ptr<Flag>(new Flag(*this, time,
                QString("%1").arg(next_flag_text_))));
@@ -466,10 +523,10 @@ void View::restack_all_row_items()
                r->animate_to_layout_v_offset();
 }
 
-void View::get_scroll_layout(double &length, double &offset) const
+void View::get_scroll_layout(double &length, Timestamp &offset) const
 {
-       const pair<double, double> extents = get_time_extents();
-       length = (extents.second - extents.first) / scale_;
+       const pair<Timestamp, Timestamp> extents = get_time_extents();
+       length = ((extents.second - extents.first) / scale_).convert_to<double>();
        offset = offset_ / scale_;
 }
 
@@ -479,18 +536,24 @@ void View::set_zoom(double scale, int offset)
        always_zoom_to_fit_ = false;
        always_zoom_to_fit_changed(false);
 
-       const double cursor_offset = offset_ + scale_ * offset;
-       const double new_scale = max(min(scale, MaxScale), MinScale);
-       const double new_offset = cursor_offset - new_scale * offset;
-       set_scale_offset(new_scale, new_offset);
+       const Timestamp cursor_offset = offset_ + scale_ * offset;
+       const Timestamp new_scale = max(min(Timestamp(scale), MaxScale), MinScale);
+       const Timestamp new_offset = cursor_offset - new_scale * offset;
+       set_scale_offset(new_scale.convert_to<double>(), new_offset);
 }
 
 void View::calculate_tick_spacing()
 {
-       const double SpacingIncrement = 32.0f;
-       const double MinValueSpacing = 32.0f;
+       const double SpacingIncrement = 10.0f;
+       const double MinValueSpacing = 40.0f;
 
-       double min_width = SpacingIncrement, typical_width;
+       // Figure out the highest numeric value visible on a label
+       const QSize areaSize = viewport_->size();
+       const Timestamp max_time = max(fabs(offset_),
+               fabs(offset_ + scale_ * areaSize.width()));
+
+       double min_width = SpacingIncrement;
+       double label_width, tick_period_width;
 
        QFontMetrics m(QApplication::font());
 
@@ -500,23 +563,38 @@ void View::calculate_tick_spacing()
                const int order = (int)floorf(log10f(min_period));
                const double order_decimal = pow(10.0, order);
 
+               // Allow for a margin of error so that a scale unit of 1 can be used.
+               // Otherwise, for a SU of 1 the tick period will almost always be below
+               // the min_period by a small amount - and thus skipped in favor of 2.
+               // Note: margin assumes that SU[0] and SU[1] contain the smallest values
+               double tp_margin = (ScaleUnits[0] + ScaleUnits[1]) / 2.0;
+               double tp_with_margin;
                unsigned int unit = 0;
 
                do {
-                       tick_period_ = order_decimal * ScaleUnits[unit++];
-               } while (tick_period_ < min_period &&
-                       unit < countof(ScaleUnits));
+                       tp_with_margin = order_decimal * (ScaleUnits[unit++] + tp_margin);
+               } while (tp_with_margin < min_period && unit < countof(ScaleUnits));
+
+               set_tick_period(order_decimal * ScaleUnits[unit - 1]);
+               set_tick_prefix(static_cast<pv::util::SIPrefix>(
+                       (order - pv::util::exponent(pv::util::SIPrefix::yocto)) / 3));
+
+               // Precision is the number of fractional digits required, not
+               // taking the prefix into account (and it must never be negative)
+               set_tick_precision(std::max((int)ceil(log10f(1 / tick_period_)), 0));
 
-               tick_prefix_ = (order - pv::util::FirstSIPrefixPower) / 3;
+               tick_period_width = tick_period_ / scale_;
 
-               typical_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
-                       Qt::AlignLeft | Qt::AlignTop,
-                       format_time(offset_, tick_prefix_, time_unit_)).width() +
+               const QString label_text =
+                       format_time(max_time, tick_prefix_, time_unit_, tick_precision_);
+
+               label_width = m.boundingRect(0, 0, INT_MAX, INT_MAX,
+                       Qt::AlignLeft | Qt::AlignTop, label_text).width() +
                                MinValueSpacing;
 
                min_width += SpacingIncrement;
 
-       } while (typical_width > tick_period_ / scale_);
+       } while (tick_period_width < label_width);
 }
 
 void View::update_scroll()
@@ -526,7 +604,8 @@ void View::update_scroll()
        const QSize areaSize = viewport_->size();
 
        // Set the horizontal scroll bar
-       double length = 0, offset = 0;
+       double length = 0;
+       Timestamp offset;
        get_scroll_layout(length, offset);
        length = max(length - areaSize.width(), 0.0);
 
@@ -539,11 +618,11 @@ void View::update_scroll()
 
        if (length < MaxScrollValue) {
                horizontalScrollBar()->setRange(0, length);
-               horizontalScrollBar()->setSliderPosition(offset);
+               horizontalScrollBar()->setSliderPosition(offset.convert_to<double>());
        } else {
                horizontalScrollBar()->setRange(0, MaxScrollValue);
                horizontalScrollBar()->setSliderPosition(
-                       offset_ * MaxScrollValue / (scale_ * length));
+                       (offset_ * MaxScrollValue / (scale_ * length)).convert_to<double>());
        }
 
        updating_scroll_ = false;
@@ -648,7 +727,7 @@ vector< shared_ptr<Trace> > View::extract_new_traces_for_channels(
 void View::determine_time_unit()
 {
        // Check whether we know the sample rate and hence can use time as the unit
-       if (time_unit_ == util::Samples) {
+       if (time_unit_ == util::TimeUnit::Samples) {
                shared_lock<shared_mutex> lock(session().signals_mutex());
                const unordered_set< shared_ptr<Signal> > &sigs(session().signals());
 
@@ -660,7 +739,7 @@ void View::determine_time_unit()
                        const vector< shared_ptr<Segment> > segments = data->segments();
                        if (!segments.empty())
                                if (segments[0]->samplerate()) {
-                                       time_unit_ = util::Time;
+                                       set_time_unit(util::TimeUnit::Time);
                                        break;
                                }
                }
@@ -754,11 +833,12 @@ void View::h_scroll_value_changed(int value)
 
        const int range = horizontalScrollBar()->maximum();
        if (range < MaxScrollValue)
-               offset_ = scale_ * value;
+               set_offset(scale_ * value);
        else {
-               double length = 0, offset;
+               double length = 0;
+               Timestamp offset;
                get_scroll_layout(length, offset);
-               offset_ = scale_ * length * value / MaxScrollValue;
+               set_offset(scale_ * length * value / MaxScrollValue);
        }
 
        ruler_->update();
@@ -899,14 +979,20 @@ void View::signals_changed()
 
 void View::capture_state_updated(int state)
 {
-       // Reset "always zoom to fit" when we change to the stopped state
-       if (always_zoom_to_fit_ && (state == Session::Stopped)) {
-               always_zoom_to_fit_ = false;
-               always_zoom_to_fit_changed(false);
-       }
-
        if (state == Session::Running)
-               time_unit_ = util::Samples;
+               set_time_unit(util::TimeUnit::Samples);
+
+       if (state == Session::Stopped) {
+               // After acquisition has stopped we need to re-calculate the ticks once
+               // as it's otherwise done when the user pans or zooms, which is too late
+               calculate_tick_spacing();
+
+               // Reset "always zoom to fit", the acquisition has stopped
+               if (always_zoom_to_fit_) {
+                       always_zoom_to_fit_ = false;
+                       always_zoom_to_fit_changed(false);
+               }
+       }
 }
 
 void View::data_updated()
@@ -929,13 +1015,14 @@ void View::perform_delayed_view_update()
 
        if (sticky_scrolling_) {
                // Make right side of the view sticky
-               double length = 0, offset;
+               double length = 0;
+               Timestamp offset;
                get_scroll_layout(length, offset);
 
                const QSize areaSize = viewport_->size();
                length = max(length - areaSize.width(), 0.0);
 
-               offset_ = scale_ * length;
+               set_offset(scale_ * length);
        }
 
        determine_time_unit();