]> sigrok.org Git - pulseview.git/blobdiff - pv/views/trace/decodetrace.cpp
Implement expansion marker animation and its infrastructure
[pulseview.git] / pv / views / trace / decodetrace.cpp
index 30f333ddc7c4fe033ed439653f57354ab6fd68fd..61163bc2bdca727068f7384d0c455877ef5756fe 100644 (file)
@@ -86,12 +86,13 @@ namespace trace {
 const QColor DecodeTrace::ErrorBgColor = QColor(0xEF, 0x29, 0x29);
 const QColor DecodeTrace::NoDecodeColor = QColor(0x88, 0x8A, 0x85);
 
-const int DecodeTrace::ArrowSize = 7;
+const int DecodeTrace::ArrowSize = 6;
 const double DecodeTrace::EndCapWidth = 5;
-const int DecodeTrace::RowTitleMargin = 10;
+const int DecodeTrace::RowTitleMargin = 7;
 const int DecodeTrace::DrawPadding = 100;
 
 const int DecodeTrace::MaxTraceUpdateRate = 1; // No more than 1 Hz
+const unsigned int DecodeTrace::AnimationDurationInTicks = 7;
 
 DecodeTrace::DecodeTrace(pv::Session &session,
        shared_ptr<data::SignalBase> signalbase, int index) :
@@ -113,6 +114,7 @@ DecodeTrace::DecodeTrace(pv::Session &session,
        min_useful_label_width_ = m.width("XX"); // e.g. two hex characters
 
        default_row_height_ = (ViewItemPaintParams::text_height() * 6) / 4;
+       annotation_height_ = (ViewItemPaintParams::text_height() * 5) / 4;
 
        // For the base color, we want to start at a very different color for
        // every decoder stack, so multiply the index with a number that is
@@ -143,6 +145,14 @@ DecodeTrace::DecodeTrace(pv::Session &session,
                this, SLOT(on_delayed_trace_update()));
        delayed_trace_updater_.setSingleShot(true);
        delayed_trace_updater_.setInterval(1000 / MaxTraceUpdateRate);
+
+       connect(&animation_timer_, SIGNAL(timeout()),
+               this, SLOT(on_animation_timer()));
+       animation_timer_.setInterval(1000 / 50);
+
+       default_marker_shape_ << QPoint(0,         -ArrowSize);
+       default_marker_shape_ << QPoint(ArrowSize,  0);
+       default_marker_shape_ << QPoint(0,          ArrowSize);
 }
 
 DecodeTrace::~DecodeTrace()
@@ -184,9 +194,6 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
 {
        lock_guard<mutex> lock(row_modification_mutex_);
 
-       const int text_height = ViewItemPaintParams::text_height();
-       const int annotation_height = (text_height * 5) / 4;
-
        // Set default pen to allow for text width calculation
        p.setPen(Qt::black);
 
@@ -204,6 +211,12 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
        int y = get_visual_y();
 
        for (RowData& r : rows_) {
+               // If an entire decoder is hidden, we don't want to fetch annotations
+               if (!r.decode_row.decoder()->shown()) {
+                       r.currently_visible = false;
+                       continue;
+               }
+
                vector<Annotation> annotations;
                decode_signal_->get_annotation_subset(annotations, r.decode_row,
                        current_segment_, sample_range.first, sample_range.second);
@@ -211,18 +224,17 @@ void DecodeTrace::paint_mid(QPainter &p, ViewItemPaintParams &pp)
                // Show row if there are visible annotations or when user wants to see
                // all rows that have annotations somewhere and this one is one of them
                size_t ann_count = decode_signal_->get_annotation_count(r.decode_row, current_segment_);
-               r.currently_visible = (!annotations.empty() || (always_show_all_rows_ && (ann_count > 0)))
-                       && (r.decode_row.decoder()->shown());
+               r.currently_visible = !annotations.empty() || (always_show_all_rows_ && (ann_count > 0));
 
                if (r.currently_visible) {
-                       draw_annotations(annotations, p, annotation_height, pp, y,
+                       draw_annotations(annotations, p, annotation_height_, pp, y,
                                get_row_color(r.decode_row.index()), r.title_width);
                        y += r.height;
                        visible_rows_++;
                }
        }
 
-       draw_unresolved_period(p, annotation_height, pp.left(), pp.right());
+       draw_unresolved_period(p, annotation_height_, pp.left(), pp.right());
 
        if (visible_rows_ > max_visible_rows_) {
                max_visible_rows_ = visible_rows_;
@@ -248,17 +260,14 @@ void DecodeTrace::paint_fore(QPainter &p, ViewItemPaintParams &pp)
                p.setPen(QPen(Qt::NoPen));
 
                if (r.expand_marker_highlighted)
-                       p.setBrush(QApplication::palette().brush(QPalette::HighlightedText));
+                       p.setBrush(QApplication::palette().brush(QPalette::Highlight));
                else
                        p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 
                // Draw expansion marker
-               const QPointF points[] = {
-                       QPointF(pp.left(), y - ArrowSize),
-                       QPointF(pp.left() + ArrowSize, y),
-                       QPointF(pp.left(), y + ArrowSize)
-               };
-               p.drawPolygon(points, countof(points));
+               QPolygon marker(r.expand_marker_shape);
+               marker.translate(pp.left(), y);
+               p.drawPolygon(marker);
 
                p.setBrush(QApplication::palette().brush(QPalette::WindowText));
 
@@ -481,6 +490,91 @@ QMenu* DecodeTrace::create_view_context_menu(QWidget *parent, QPoint &click_pos)
        return menu;
 }
 
+void DecodeTrace::delete_pressed()
+{
+       on_delete();
+}
+
+void DecodeTrace::hover_point_changed(const QPoint &hp)
+{
+       Trace::hover_point_changed(hp);
+
+       assert(owner_);
+
+       RowData* hover_row = get_row_at_point(hp);
+
+       // Row expansion marker handling
+       for (RowData& r : rows_)
+               r.expand_marker_highlighted = false;
+
+       if (hover_row) {
+               int row_y = get_row_y(hover_row);
+               if ((hp.x() > 0) && (hp.x() < 2 * ArrowSize) &&
+                       (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize)))
+                       hover_row->expand_marker_highlighted = true;
+       }
+
+       // Tooltip handling
+       if (hp.x() > 0) {
+               QString ann = get_annotation_at_point(hp);
+
+               if (!ann.isEmpty()) {
+                       QFontMetrics m(QToolTip::font());
+                       const QRect text_size = m.boundingRect(QRect(), 0, ann);
+
+                       // This is OS-specific and unfortunately we can't query it, so
+                       // use an approximation to at least try to minimize the error.
+                       const int padding = default_row_height_ + 8;
+
+                       // Make sure the tool tip doesn't overlap with the mouse cursor.
+                       // If it did, the tool tip would constantly hide and re-appear.
+                       // We also push it up by one row so that it appears above the
+                       // decode trace, not below.
+                       QPoint p = hp;
+                       p.setX(hp.x() - (text_size.width() / 2) - padding);
+
+                       p.setY(get_row_y(hover_row) - default_row_height_ -
+                               text_size.height() - padding);
+
+                       const View *const view = owner_->view();
+                       assert(view);
+                       QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
+
+               } else
+                       QToolTip::hideText();
+
+       } else
+               QToolTip::hideText();
+}
+
+void DecodeTrace::mouse_left_press_event(const QMouseEvent* event)
+{
+       // Handle row expansion marker
+       for (RowData& r : rows_) {
+               if (!r.expand_marker_highlighted)
+                       continue;
+
+               unsigned int y = get_row_y(&r);
+               if ((event->x() > 0) && (event->x() <= (int)(ArrowSize + 3)) &&
+                       (event->y() > (int)(y - (default_row_height_ / 2))) &&
+                       (event->y() <= (int)(y + (default_row_height_ / 2)))) {
+
+                       if (r.expanded) {
+                               r.collapsing = true;
+                               r.expanded = false;
+                               r.anim_shape = ArrowSize;
+                       } else {
+                               r.expanding = true;
+                               r.anim_shape = 0;
+                       }
+
+                       r.animation_step = 0;
+                       r.anim_height = r.height;
+                       animation_timer_.start();
+               }
+       }
+}
+
 void DecodeTrace::draw_annotations(vector<pv::data::decode::Annotation> annotations,
                QPainter &p, int h, const ViewItemPaintParams &pp, int y,
                QColor row_color, int row_title_width)
@@ -678,7 +772,7 @@ void DecodeTrace::draw_range(const pv::data::decode::Annotation &a, QPainter &p,
        const int ann_start = start + cap_width;
        const int ann_end = end - cap_width;
 
-       const int real_start = max(ann_start, pp.left() + row_title_width);
+       const int real_start = max(ann_start, pp.left() + ArrowSize + row_title_width);
        const int real_end = min(ann_end, pp.right());
        const int real_width = real_end - real_start;
 
@@ -833,18 +927,22 @@ unsigned int DecodeTrace::get_row_y(const RowData* row) const
 
        unsigned int y = get_visual_y();
 
-       for (const RowData& r : rows_)
-               if (row != &r)
-                       y += r.height;
-               else
+       for (const RowData& r : rows_) {
+               if (!r.currently_visible)
+                       continue;
+
+               if (row->decode_row == r.decode_row)
                        break;
+               else
+                       y += r.height;
+       }
 
        return y;
 }
 
 RowData* DecodeTrace::get_row_at_point(const QPoint &point)
 {
-       int y = get_visual_y();
+       int y = get_visual_y() - (default_row_height_ / 2);
 
        for (RowData& r : rows_) {
                if (!r.currently_visible)
@@ -873,6 +971,9 @@ const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
        if (!r)
                return QString();
 
+       if (point.y() > (int)(get_row_y(r) + (annotation_height_ / 2)))
+               return QString();
+
        vector<Annotation> annotations;
 
        decode_signal_->get_annotation_subset(annotations, r->decode_row,
@@ -882,59 +983,6 @@ const QString DecodeTrace::get_annotation_at_point(const QPoint &point)
                QString() : annotations[0].annotations().front();
 }
 
-void DecodeTrace::hover_point_changed(const QPoint &hp)
-{
-       Trace::hover_point_changed(hp);
-
-       assert(owner_);
-
-       RowData* hover_row = get_row_at_point(hp);
-
-       // Row/class visibility button handling
-       for (RowData& r : rows_)
-               r.expand_marker_highlighted = false;
-
-       if (hover_row) {
-               int row_y = get_row_y(hover_row);
-               if ((hp.x() > 0) && (hp.x() < ArrowSize) &&
-                       (hp.y() > (int)(row_y - ArrowSize)) && (hp.y() < (int)(row_y + ArrowSize)))
-                       hover_row->expand_marker_highlighted = true;
-       }
-
-       // Tooltip handling
-       if (hp.x() > 0) {
-               QString ann = get_annotation_at_point(hp);
-
-               if (ann.isEmpty()) {
-                       QToolTip::hideText();
-                       return;
-               }
-
-               QFontMetrics m(QToolTip::font());
-               const QRect text_size = m.boundingRect(QRect(), 0, ann);
-
-               // This is OS-specific and unfortunately we can't query it, so
-               // use an approximation to at least try to minimize the error.
-               const int padding = 8;
-
-               // Make sure the tool tip doesn't overlap with the mouse cursor.
-               // If it did, the tool tip would constantly hide and re-appear.
-               // We also push it up by one row so that it appears above the
-               // decode trace, not below.
-               QPoint p = hp;
-               p.setX(hp.x() - (text_size.width() / 2) - padding);
-
-               p.setY(get_row_y(hover_row) - hover_row->height - default_row_height_ -
-                       text_size.height() - padding);
-
-               const View *const view = owner_->view();
-               assert(view);
-               QToolTip::showText(view->viewport()->mapToGlobal(p), ann);
-
-       } else
-               QToolTip::hideText();
-}
-
 void DecodeTrace::create_decoder_form(int index,
        shared_ptr<data::decode::Decoder> &dec, QWidget *parent,
        QFormLayout *form)
@@ -1133,9 +1181,13 @@ void DecodeTrace::update_rows()
                        RowData nr;
                        nr.decode_row = decode_row;
                        nr.height = default_row_height_;
+                       nr.expanded_height = 5*default_row_height_;
                        nr.currently_visible = false;
                        nr.expand_marker_highlighted = false;
+                       nr.expanding = false;
                        nr.expanded = false;
+                       nr.collapsing = false;
+                       nr.expand_marker_shape = default_marker_shape_;
 
                        rows_.push_back(nr);
                        r = &rows_.back();
@@ -1207,11 +1259,6 @@ void DecodeTrace::on_pause_decode()
                decode_signal_->pause_decode();
 }
 
-void DecodeTrace::delete_pressed()
-{
-       on_delete();
-}
-
 void DecodeTrace::on_delete()
 {
        session_.remove_decode_signal(decode_signal_);
@@ -1409,6 +1456,59 @@ void DecodeTrace::on_export_all_rows_from_here()
        delete annotations;
 }
 
+void DecodeTrace::on_animation_timer()
+{
+       bool animation_finished = true;
+
+       for (RowData& r : rows_) {
+               if (!(r.expanding || r.collapsing))
+                       continue;
+
+               unsigned int height_delta = r.expanded_height - default_row_height_;
+
+               if (r.expanding) {
+                       if (r.height < r.expanded_height) {
+                               r.anim_height += height_delta / (float)AnimationDurationInTicks;
+                               r.height = r.anim_height;
+                               r.anim_shape += ArrowSize / (float)AnimationDurationInTicks;
+                               animation_finished = false;
+                       } else {
+                               r.height = std::min(r.height, r.expanded_height);
+                               r.expanding = false;
+                               r.expanded = true;
+                       }
+               }
+
+               if (r.collapsing) {
+                       if (r.height > default_row_height_) {
+                               r.anim_height -= height_delta / (float)AnimationDurationInTicks;
+                               r.height = r.anim_height;
+                               r.anim_shape -= ArrowSize / (float)AnimationDurationInTicks;
+                               animation_finished = false;
+                       } else {
+                               r.height = std::max(r.height, default_row_height_);
+                               r.collapsing = false;
+                               r.expanded = false;
+                               r.expand_marker_shape = default_marker_shape_;
+                       }
+               }
+
+               // The expansion marker shape switches between
+               // 0/-A, A/0,  0/A (default state; anim_shape=0) and
+               // 0/ 0, A/A, 2A/0 (expanded state; anim_shape=ArrowSize)
+
+               r.expand_marker_shape.setPoint(0, 0, -ArrowSize + r.anim_shape);
+               r.expand_marker_shape.setPoint(1, ArrowSize, r.anim_shape);
+               r.expand_marker_shape.setPoint(2, 2*r.anim_shape, ArrowSize - r.anim_shape);
+       }
+
+       if (animation_finished)
+               animation_timer_.stop();
+
+       if (owner_)
+               owner_->row_item_appearance_changed(false, true);
+}
+
 } // namespace trace
 } // namespace views
 } // namespace pv