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 <vector>
  27
  28 #include <boost/shared_ptr.hpp>
  29 #include <boost/weak_ptr.hpp>
  30
  31 #include <QAbstractScrollArea>
  32 #include <QSizeF>
  33
  34 #include "cursorpair.h"
  35
  36 namespace pv {
  37
  38 class SigSession;
  39
  40 namespace view {
  41
  42 class Header;
  43 class Ruler;
  44 class Trace;
  45 class Viewport;
  46
  47 class View : public QAbstractScrollArea {
  48         Q_OBJECT
  49
  50 private:
  51         static const double MaxScale;
  52         static const double MinScale;
  53
  54         static const int MaxScrollValue;
  55
  56 public:
  57         static const int SignalHeight;
  58         static const int SignalMargin;
  59         static const int SignalSnapGridSize;
  60
  61         static const QColor CursorAreaColour;
  62
  63         static const QSizeF LabelPadding;
  64
  65 public:
  66         explicit View(SigSession &session, QWidget *parent = 0);
  67
  68         SigSession& session();
  69         const SigSession& session() const;
  70
  71         /**
  72          * Returns the view time scale in seconds per pixel.
  73          */
  74         double scale() const;
  75
  76         /**
  77          * Returns the time offset of the left edge of the view in
  78          * seconds.
  79          */
  80         double offset() const;
  81         int v_offset() const;
  82
  83         void zoom(double steps);
  84         void zoom(double steps, int offset);
  85
  86         void zoom_fit();
  87
  88         void zoom_one_to_one();
  89
  90         /**
  91          * Sets the scale and offset.
  92          * @param scale The new view scale in seconds per pixel.
  93          * @param offset The view time offset in seconds.
  94          */
  95         void set_scale_offset(double scale, double offset);
  96
  97         std::vector< boost::shared_ptr<Trace> > get_traces() const;
  98
  99         std::list<boost::weak_ptr<SelectableItem> > selected_items() const;
 100
 101         /**
 102          * Returns true if cursors are displayed. false otherwise.
 103          */
 104         bool cursors_shown() const;
 105
 106         /**
 107          * Shows or hides the cursors.
 108          */
 109         void show_cursors(bool show = true);
 110
 111         /**
 112          * Moves the cursors to a convenient position in the view.
 113          */
 114         void centre_cursors();
 115
 116         /**
 117          * Returns a reference to the pair of cursors.
 118          */
 119         CursorPair& cursors();
 120
 121         /**
 122          * Returns a reference to the pair of cursors.
 123          */
 124         const CursorPair& cursors() const;
 125
 126         const QPoint& hover_point() const;
 127
 128         void normalize_layout();
 129
 130         void update_viewport();
 131
 132 signals:
 133         void hover_point_changed();
 134
 135         void signals_moved();
 136
 137         void selection_changed();
 138
 139         void scale_offset_changed();
 140
 141 private:
 142         void get_scroll_layout(double &length, double &offset) const;
 143
 144         void set_zoom(double scale, int offset);
 145
 146         void update_scroll();
 147
 148         void update_layout();
 149
 150         static bool compare_trace_v_offsets(
 151                 const boost::shared_ptr<pv::view::Trace> &a,
 152                 const boost::shared_ptr<pv::view::Trace> &b);
 153
 154 private:
 155         bool eventFilter(QObject *object, QEvent *event);
 156
 157         bool viewportEvent(QEvent *e);
 158
 159         void resizeEvent(QResizeEvent *e);
 160
 161 private slots:
 162
 163         void h_scroll_value_changed(int value);
 164         void v_scroll_value_changed(int value);
 165
 166         void signals_changed();
 167         void data_updated();
 168
 169         void marker_time_changed();
 170
 171         void on_signals_moved();
 172
 173         void on_geometry_updated();
 174
 175 private:
 176         SigSession &_session;
 177
 178         Viewport *_viewport;
 179         Ruler *_ruler;
 180         Header *_header;
 181
 182         uint64_t _data_length;
 183
 184         /// The view time scale in seconds per pixel.
 185         double _scale;
 186
 187         /// The view time offset in seconds.
 188         double _offset;
 189
 190         int _v_offset;
 191         bool _updating_scroll;
 192
 193         bool _show_cursors;
 194         CursorPair _cursors;
 195
 196         QPoint _hover_point;
 197 };
 198
 199 } // namespace view
 200 } // namespace pv
 201
 202 #endif // PULSEVIEW_PV_VIEW_VIEW_H