pv/views/trace/trace.hpp

   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 #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP
  21 #define PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP
  22
  23 #include <QColor>
  24 #include <QPainter>
  25 #include <QPen>
  26 #include <QRect>
  27 #include <QString>
  28
  29 #include <cstdint>
  30
  31 #include "tracetreeitem.hpp"
  32
  33 #include "pv/data/signalbase.hpp"
  34
  35 using std::shared_ptr;
  36
  37 class QFormLayout;
  38
  39 namespace pv {
  40
  41 namespace data {
  42 class SignalBase;
  43 }
  44
  45 namespace widgets {
  46 class Popup;
  47 }
  48
  49 namespace views {
  50 namespace trace {
  51
  52 /**
  53  * The Trace class represents a @ref TraceTreeItem which occupies some vertical
  54  * space on the canvas and spans across its entire width, essentially showing
  55  * a time series of values, events, objects or similar. While easily confused
  56  * with @ref Signal, the difference is that Trace may represent anything that
  57  * can be drawn, not just numeric values. One example is a @ref DecodeTrace.
  58  *
  59  * For this reason, Trace is more generic and contains properties and helpers
  60  * that benefit any kind of time series items.
  61  */
  62 class Trace : public TraceTreeItem
  63 {
  64         Q_OBJECT
  65
  66 public:
  67         /**
  68          * Allowed values for the multi-segment display mode.
  69          *
  70          * Note: Consider these locations when updating the list:
  71          * *
  72          * @ref View::set_segment_display_mode
  73          * @ref View::on_segment_changed
  74          * @ref AnalogSignal::get_analog_segment_to_paint
  75          * @ref AnalogSignal::get_logic_segment_to_paint
  76          * @ref LogicSignal::get_logic_segment_to_paint
  77          * @ref StandardBar
  78          */
  79         enum SegmentDisplayMode {
  80                 ShowLastSegmentOnly = 1,
  81                 ShowLastCompleteSegmentOnly,
  82                 ShowSingleSegmentOnly,
  83                 ShowAllSegments,
  84                 ShowAccumulatedIntensity
  85         };
  86
  87 private:
  88         static const QPen AxisPen;
  89         static const int LabelHitPadding;
  90
  91         static const QColor BrightGrayBGColour;
  92         static const QColor DarkGrayBGColour;
  93
  94 protected:
  95         Trace(shared_ptr<data::SignalBase> channel);
  96
  97 public:
  98         /**
  99          * Returns the underlying SignalBase instance.
 100          */
 101         shared_ptr<data::SignalBase> base() const;
 102
 103         /**
 104          * Sets the name of the signal.
 105          */
 106         virtual void set_name(QString name);
 107
 108         /**
 109          * Set the colour of the signal.
 110          */
 111         virtual void set_colour(QColor colour);
 112
 113         /**
 114          * Configures the segment display mode to use.
 115          */
 116         virtual void set_segment_display_mode(SegmentDisplayMode mode);
 117
 118         /**
 119          * Paints the signal label.
 120          * @param p the QPainter to paint into.
 121          * @param rect the rectangle of the header area.
 122          * @param hover true if the label is being hovered over by the mouse.
 123          */
 124         virtual void paint_label(QPainter &p, const QRect &rect, bool hover);
 125
 126         virtual QMenu* create_context_menu(QWidget *parent);
 127
 128         pv::widgets::Popup* create_popup(QWidget *parent);
 129
 130         /**
 131          * Computes the outline rectangle of a label.
 132          * @param rect the rectangle of the header area.
 133          * @return Returns the rectangle of the signal label.
 134          */
 135         QRectF label_rect(const QRectF &rect) const;
 136
 137         void set_current_segment(const int segment);
 138
 139         int get_current_segment() const;
 140
 141 protected:
 142         /**
 143          * Paints the background layer of the signal with a QPainter.
 144          * @param p The QPainter to paint into.
 145          * @param pp The painting parameters object to paint with.
 146          */
 147         virtual void paint_back(QPainter &p, ViewItemPaintParams &pp);
 148
 149         /**
 150          * Paints a zero axis across the viewport.
 151          * @param p the QPainter to paint into.
 152          * @param pp the painting parameters object to paint with.
 153          * @param y the y-offset of the axis.
 154          */
 155         void paint_axis(QPainter &p, ViewItemPaintParams &pp, int y);
 156
 157         void add_colour_option(QWidget *parent, QFormLayout *form);
 158
 159         void create_popup_form();
 160
 161         virtual void populate_popup_form(QWidget *parent, QFormLayout *form);
 162
 163 protected Q_SLOTS:
 164         virtual void on_name_changed(const QString &text);
 165
 166         virtual void on_colour_changed(const QColor &colour);
 167
 168         void on_popup_closed();
 169
 170 private Q_SLOTS:
 171         void on_nameedit_changed(const QString &name);
 172
 173         void on_colouredit_changed(const QColor &colour);
 174
 175 protected:
 176         shared_ptr<data::SignalBase> base_;
 177         QPen axis_pen_;
 178
 179         SegmentDisplayMode segment_display_mode_;
 180
 181         /// The ID of the currently displayed segment
 182         int current_segment_;
 183
 184 private:
 185         pv::widgets::Popup *popup_;
 186         QFormLayout *popup_form_;
 187 };
 188
 189 } // namespace trace
 190 } // namespace views
 191 } // namespace pv
 192
 193 #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_TRACE_HPP