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