pv/view/view.hpp

   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 #ifndef PULSEVIEW_PV_VIEW_VIEW_H
  22 #define PULSEVIEW_PV_VIEW_VIEW_H
  23
  24 #include <stdint.h>
  25
  26 #include <memory>
  27 #include <set>
  28 #include <unordered_map>
  29 #include <vector>
  30
  31 #include <QAbstractScrollArea>
  32 #include <QSizeF>
  33 #include <QTimer>
  34
  35 #include <pv/data/signaldata.hpp>
  36
  37 #include "cursorpair.hpp"
  38 #include "rowitemowner.hpp"
  39
  40 namespace pv {
  41
  42 class Session;
  43
  44 namespace view {
  45
  46 class CursorHeader;
  47 class Header;
  48 class Ruler;
  49 class Viewport;
  50
  51 class View : public QAbstractScrollArea, public RowItemOwner {
  52         Q_OBJECT
  53
  54 private:
  55         enum StickyEvents {
  56                 SelectableItemHExtentsChanged = 1,
  57                 SelectableItemVExtentsChanged = 2
  58         };
  59
  60 private:
  61         static const double MaxScale;
  62         static const double MinScale;
  63
  64         static const int MaxScrollValue;
  65
  66         static const int ScaleUnits[3];
  67
  68 public:
  69         static const QColor CursorAreaColour;
  70
  71         static const QSizeF LabelPadding;
  72
  73 public:
  74         explicit View(Session &session, QWidget *parent = 0);
  75
  76         Session& session();
  77         const Session& session() const;
  78
  79         /**
  80          * Returns the view of the owner.
  81          */
  82         virtual pv::view::View* view();
  83
  84         /**
  85          * Returns the view of the owner.
  86          */
  87         virtual const pv::view::View* view() const;
  88
  89         Viewport* viewport();
  90
  91         const Viewport* viewport() const;
  92
  93         /**
  94          * Gets a list of time markers.
  95          */
  96         std::vector< std::shared_ptr<TimeItem> > time_items() const;
  97
  98         /**
  99          * Returns the view time scale in seconds per pixel.
 100          */
 101         double scale() const;
 102
 103         /**
 104          * Returns the time offset of the left edge of the view in
 105          * seconds.
 106          */
 107         double offset() const;
 108         int owner_visual_v_offset() const;
 109
 110         /**
 111          * Returns the SI prefix to apply to the graticule time markings.
 112          */
 113         unsigned int tick_prefix() const;
 114
 115         /**
 116          * Returns period of the graticule time markings.
 117          */
 118         double tick_period() const;
 119
 120         /**
 121          * Returns the number of nested parents that this row item owner has.
 122          */
 123         unsigned int depth() const;
 124
 125         void zoom(double steps);
 126         void zoom(double steps, int offset);
 127
 128         void zoom_fit();
 129
 130         void zoom_one_to_one();
 131
 132         /**
 133          * Sets the scale and offset.
 134          * @param scale The new view scale in seconds per pixel.
 135          * @param offset The view time offset in seconds.
 136          */
 137         void set_scale_offset(double scale, double offset);
 138
 139         std::set< std::shared_ptr<pv::data::SignalData> >
 140                 get_visible_data() const;
 141
 142         std::pair<double, double> get_time_extents() const;
 143
 144         /**
 145          * Returns true if cursors are displayed. false otherwise.
 146          */
 147         bool cursors_shown() const;
 148
 149         /**
 150          * Shows or hides the cursors.
 151          */
 152         void show_cursors(bool show = true);
 153
 154         /**
 155          * Moves the cursors to a convenient position in the view.
 156          */
 157         void centre_cursors();
 158
 159         /**
 160          * Returns a reference to the pair of cursors.
 161          */
 162         CursorPair& cursors();
 163
 164         /**
 165          * Returns a reference to the pair of cursors.
 166          */
 167         const CursorPair& cursors() const;
 168
 169         const QPoint& hover_point() const;
 170
 171         void update_viewport();
 172
 173         void restack_all_row_items();
 174
 175 Q_SIGNALS:
 176         void hover_point_changed();
 177
 178         void signals_moved();
 179
 180         void selection_changed();
 181
 182         void scale_offset_changed();
 183
 184 private:
 185         void get_scroll_layout(double &length, double &offset) const;
 186
 187         /**
 188          * Simultaneously sets the zoom and offset.
 189          * @param scale The scale to set the view to in seconds per pixel. This
 190          * value is clamped between MinScale and MaxScale.
 191          * @param offset The offset of the left edge of the view in seconds.
 192          */
 193         void set_zoom(double scale, int offset);
 194
 195         /**
 196          * Find a tick spacing and number formatting that does not cause
 197          * the values to collide.
 198          */
 199         void calculate_tick_spacing();
 200
 201         void update_scroll();
 202
 203         void update_layout();
 204
 205         /**
 206          * Satisifies RowItem functionality.
 207          * @param p the QPainter to paint into.
 208          * @param right the x-coordinate of the right edge of the header
 209          *      area.
 210          * @param hover true if the label is being hovered over by the mouse.
 211          */
 212         void paint_label(QPainter &p, int right, bool hover);
 213
 214         /**
 215          * Computes the outline rectangle of a label.
 216          * @param right the x-coordinate of the right edge of the header
 217          *      area.
 218          * @return Returns the rectangle of the signal label.
 219          */
 220         QRectF label_rect(int right);
 221
 222         static bool add_channels_to_owner(
 223                 const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
 224                 RowItemOwner *owner, int &offset,
 225                 std::unordered_map<std::shared_ptr<sigrok::Channel>,
 226                         std::shared_ptr<Signal> > &signal_map,
 227                 std::function<bool (std::shared_ptr<RowItem>)> filter_func =
 228                         std::function<bool (std::shared_ptr<RowItem>)>());
 229
 230         static void apply_offset(
 231                 std::shared_ptr<RowItem> row_item, int &offset);
 232
 233 private:
 234         bool eventFilter(QObject *object, QEvent *event);
 235
 236         bool viewportEvent(QEvent *e);
 237
 238         void resizeEvent(QResizeEvent *e);
 239
 240 public:
 241         void appearance_changed(bool label, bool content);
 242
 243         void extents_changed(bool horz, bool vert);
 244
 245 private Q_SLOTS:
 246
 247         void h_scroll_value_changed(int value);
 248         void v_scroll_value_changed(int value);
 249
 250         void signals_changed();
 251         void data_updated();
 252
 253         void marker_time_changed();
 254
 255         void on_signals_moved();
 256
 257         void process_sticky_events();
 258
 259         void on_hover_point_changed();
 260
 261 private:
 262         Session &session_;
 263
 264         Viewport *viewport_;
 265         Ruler *ruler_;
 266         CursorHeader *cursorheader_;
 267         Header *header_;
 268
 269         /// The view time scale in seconds per pixel.
 270         double scale_;
 271
 272         /// The view time offset in seconds.
 273         double offset_;
 274
 275         int v_offset_;
 276         bool updating_scroll_;
 277
 278         double tick_period_;
 279         unsigned int tick_prefix_;
 280
 281         bool show_cursors_;
 282         CursorPair cursors_;
 283
 284         QPoint hover_point_;
 285
 286         unsigned int sticky_events_;
 287         QTimer lazy_event_handler_;
 288 };
 289
 290 } // namespace view
 291 } // namespace pv
 292
 293 #endif // PULSEVIEW_PV_VIEW_VIEW_H