pv/view/view.h

   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 <vector>
  29
  30 #include <QAbstractScrollArea>
  31 #include <QSizeF>
  32
  33 #include <pv/data/signaldata.h>
  34
  35 #include "cursorpair.h"
  36 #include "rowitemowner.h"
  37
  38 namespace pv {
  39
  40 class SigSession;
  41
  42 namespace view {
  43
  44 class CursorHeader;
  45 class Header;
  46 class Ruler;
  47 class Viewport;
  48
  49 class View : public QAbstractScrollArea, public RowItemOwner {
  50         Q_OBJECT
  51
  52 private:
  53         static const double MaxScale;
  54         static const double MinScale;
  55
  56         static const int MaxScrollValue;
  57
  58 public:
  59         static const QColor CursorAreaColour;
  60
  61         static const QSizeF LabelPadding;
  62
  63 public:
  64         explicit View(SigSession &session, QWidget *parent = 0);
  65
  66         SigSession& session();
  67         const SigSession& session() const;
  68
  69         /**
  70          * Returns the view of the owner.
  71          */
  72         virtual pv::view::View* view();
  73
  74         /**
  75          * Returns the view of the owner.
  76          */
  77         virtual const pv::view::View* view() const;
  78
  79         Viewport* viewport();
  80
  81         const Viewport* viewport() const;
  82
  83         /**
  84          * Returns the view time scale in seconds per pixel.
  85          */
  86         double scale() const;
  87
  88         /**
  89          * Returns the time offset of the left edge of the view in
  90          * seconds.
  91          */
  92         double offset() const;
  93         int owner_v_offset() const;
  94
  95         void zoom(double steps);
  96         void zoom(double steps, int offset);
  97
  98         void zoom_fit();
  99
 100         void zoom_one_to_one();
 101
 102         /**
 103          * Sets the scale and offset.
 104          * @param scale The new view scale in seconds per pixel.
 105          * @param offset The view time offset in seconds.
 106          */
 107         void set_scale_offset(double scale, double offset);
 108
 109         std::set< std::shared_ptr<pv::data::SignalData> >
 110                 get_visible_data() const;
 111
 112         std::pair<double, double> get_time_extents() const;
 113
 114         /**
 115          * Returns true if cursors are displayed. false otherwise.
 116          */
 117         bool cursors_shown() const;
 118
 119         /**
 120          * Shows or hides the cursors.
 121          */
 122         void show_cursors(bool show = true);
 123
 124         /**
 125          * Moves the cursors to a convenient position in the view.
 126          */
 127         void centre_cursors();
 128
 129         /**
 130          * Returns a reference to the pair of cursors.
 131          */
 132         CursorPair& cursors();
 133
 134         /**
 135          * Returns a reference to the pair of cursors.
 136          */
 137         const CursorPair& cursors() const;
 138
 139         const QPoint& hover_point() const;
 140
 141         void update_viewport();
 142
 143 Q_SIGNALS:
 144         void hover_point_changed();
 145
 146         void signals_moved();
 147
 148         void selection_changed();
 149
 150         void scale_offset_changed();
 151
 152 private:
 153         void get_scroll_layout(double &length, double &offset) const;
 154
 155         /**
 156          * Simultaneously sets the zoom and offset.
 157          * @param scale The scale to set the view to in seconds per pixel. This
 158          * value is clamped between MinScale and MaxScale.
 159          * @param offset The offset of the left edge of the view in seconds.
 160          */
 161         void set_zoom(double scale, int offset);
 162
 163         void update_scroll();
 164
 165         void update_layout();
 166
 167         /**
 168          * Satisifies RowItem functionality.
 169          * @param p the QPainter to paint into.
 170          * @param right the x-coordinate of the right edge of the header
 171          *      area.
 172          * @param hover true if the label is being hovered over by the mouse.
 173          */
 174         void paint_label(QPainter &p, int right, bool hover);
 175
 176         /**
 177          * Computes the outline rectangle of a label.
 178          * @param right the x-coordinate of the right edge of the header
 179          *      area.
 180          * @return Returns the rectangle of the signal label.
 181          */
 182         QRectF label_rect(int right);
 183
 184 private:
 185         bool eventFilter(QObject *object, QEvent *event);
 186
 187         bool viewportEvent(QEvent *e);
 188
 189         void resizeEvent(QResizeEvent *e);
 190
 191 private Q_SLOTS:
 192
 193         void h_scroll_value_changed(int value);
 194         void v_scroll_value_changed(int value);
 195
 196         void signals_changed();
 197         void data_updated();
 198
 199         void marker_time_changed();
 200
 201         void on_signals_moved();
 202
 203         void on_geometry_updated();
 204
 205         void on_hover_point_changed();
 206
 207 private:
 208         SigSession &_session;
 209
 210         Viewport *_viewport;
 211         Ruler *_ruler;
 212         CursorHeader *_cursorheader;
 213         Header *_header;
 214
 215         /// The view time scale in seconds per pixel.
 216         double _scale;
 217
 218         /// The view time offset in seconds.
 219         double _offset;
 220
 221         int _v_offset;
 222         bool _updating_scroll;
 223
 224         bool _show_cursors;
 225         CursorPair _cursors;
 226
 227         QPoint _hover_point;
 228 };
 229
 230 } // namespace view
 231 } // namespace pv
 232
 233 #endif // PULSEVIEW_PV_VIEW_VIEW_H