]> sigrok.org Git - pulseview.git/blobdiff - pv/view/view.hpp
View: Provide a clear setup path for the initial v_offset value
[pulseview.git] / pv / view / view.hpp
index a355cf921cdb43c00bcb5132fec4cc4dfae7d8ae..42fa322cc50b7e47f42ee51e1145a60ecf97c19b 100644 (file)
@@ -18,8 +18,8 @@
  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  */
 
-#ifndef PULSEVIEW_PV_VIEW_VIEW_H
-#define PULSEVIEW_PV_VIEW_VIEW_H
+#ifndef PULSEVIEW_PV_VIEW_VIEW_HPP
+#define PULSEVIEW_PV_VIEW_VIEW_HPP
 
 #include <stdint.h>
 
 #include <QTimer>
 
 #include <pv/data/signaldata.hpp>
+#include <pv/util.hpp>
 
 #include "cursorpair.hpp"
 #include "flag.hpp"
-#include "rowitemowner.hpp"
+#include "tracetreeitemowner.hpp"
+
+namespace sigrok {
+class ChannelGroup;
+}
 
 namespace pv {
 
@@ -48,22 +53,25 @@ namespace view {
 class CursorHeader;
 class Header;
 class Ruler;
+class Trace;
 class Viewport;
+class TriggerMarker;
 
-class View : public QAbstractScrollArea, public RowItemOwner {
+class View : public QAbstractScrollArea, public TraceTreeItemOwner {
        Q_OBJECT
 
 private:
        enum StickyEvents {
-               RowItemHExtentsChanged = 1,
-               RowItemVExtentsChanged = 2
+               TraceTreeItemHExtentsChanged = 1,
+               TraceTreeItemVExtentsChanged = 2
        };
 
 private:
-       static const double MaxScale;
-       static const double MinScale;
+       static const pv::util::Timestamp MaxScale;
+       static const pv::util::Timestamp MinScale;
 
        static const int MaxScrollValue;
+       static const int MaxViewAutoUpdateRate;
 
        static const int ScaleUnits[3];
 
@@ -101,18 +109,37 @@ public:
         * Returns the time offset of the left edge of the view in
         * seconds.
         */
-       double offset() const;
+       const pv::util::Timestamp& offset() const;
+
+       /**
+        * Returns the vertical scroll offset.
+        */
        int owner_visual_v_offset() const;
 
+       /**
+        * Sets the visual v-offset.
+        */
+       void set_v_offset(int offset);
+
        /**
         * Returns the SI prefix to apply to the graticule time markings.
         */
-       unsigned int tick_prefix() const;
+       pv::util::SIPrefix tick_prefix() const;
+
+       /**
+        * Returns the number of fractional digits shown for the time markings.
+        */
+       unsigned int tick_precision() const;
 
        /**
         * Returns period of the graticule time markings.
         */
-       double tick_period() const;
+       const pv::util::Timestamp& tick_period() const;
+
+       /**
+        * Returns the unit of time currently used.
+        */
+       util::TimeUnit time_unit() const;
 
        /**
         * Returns the number of nested parents that this row item owner has.
@@ -122,7 +149,7 @@ public:
        void zoom(double steps);
        void zoom(double steps, int offset);
 
-       void zoom_fit();
+       void zoom_fit(bool gui_state);
 
        void zoom_one_to_one();
 
@@ -131,12 +158,24 @@ public:
         * @param scale The new view scale in seconds per pixel.
         * @param offset The view time offset in seconds.
         */
-       void set_scale_offset(double scale, double offset);
+       void set_scale_offset(double scale, const pv::util::Timestamp& offset);
 
        std::set< std::shared_ptr<pv::data::SignalData> >
                get_visible_data() const;
 
-       std::pair<double, double> get_time_extents() const;
+       std::pair<pv::util::Timestamp, pv::util::Timestamp> get_time_extents() const;
+
+       /**
+        * Enables or disables sticky scrolling, i.e. the view always shows
+        * the most recent samples when capturing data.
+        */
+       void enable_sticky_scrolling(bool state);
+
+       /**
+        * Enables or disables coloured trace backgrounds. If they're not
+        * coloured then they will use alternating colors.
+        */
+       void enable_coloured_bg(bool state);
 
        /**
         * Returns true if cursors are displayed. false otherwise.
@@ -161,7 +200,7 @@ public:
        /**
         * Adds a new flag at a specified time.
         */
-       void add_flag(double time);
+       void add_flag(const pv::util::Timestamp& time);
 
        /**
         * Removes a flag from the list.
@@ -177,17 +216,40 @@ public:
 
        void update_viewport();
 
-       void restack_all_row_items();
+       void restack_all_trace_tree_items();
 
 Q_SIGNALS:
        void hover_point_changed();
 
        void selection_changed();
 
-       void scale_offset_changed();
+       /// Emitted when the offset changed.
+       void offset_changed();
+
+       /// Emitted when the scale changed.
+       void scale_changed();
+
+       void sticky_scrolling_changed(bool state);
+
+       void always_zoom_to_fit_changed(bool state);
+
+       /// Emitted when the tick_prefix changed.
+       void tick_prefix_changed();
+
+       /// Emitted when the tick_precision changed.
+       void tick_precision_changed();
+
+       /// Emitted when the tick_period changed.
+       void tick_period_changed();
+
+       /// Emitted when the time_unit changed.
+       void time_unit_changed();
+
+public Q_SLOTS:
+       void trigger_event(util::Timestamp location);
 
 private:
-       void get_scroll_layout(double &length, double &offset) const;
+       void get_scroll_layout(double &length, pv::util::Timestamp &offset) const;
 
        /**
         * Simultaneously sets the zoom and offset.
@@ -205,10 +267,14 @@ private:
 
        void update_scroll();
 
+       void reset_scroll();
+
+       void set_scroll_default();
+
        void update_layout();
 
        /**
-        * Satisifies RowItem functionality.
+        * Satisfies TraceTreeItem functionality.
         * @param p the QPainter to paint into.
         * @param rect the rectangle of the header area.
         * @param hover true if the label is being hovered over by the mouse.
@@ -222,23 +288,25 @@ private:
         */
        QRectF label_rect(const QRectF &rect);
 
-       static bool add_channels_to_owner(
+       TraceTreeItemOwner* find_prevalent_trace_group(
+               const std::shared_ptr<sigrok::ChannelGroup> &group,
+               const std::unordered_map<std::shared_ptr<sigrok::Channel>,
+                       std::shared_ptr<Signal> > &signal_map);
+
+       static std::vector< std::shared_ptr<Trace> >
+               extract_new_traces_for_channels(
                const std::vector< std::shared_ptr<sigrok::Channel> > &channels,
-               RowItemOwner *owner, int &offset,
-               std::unordered_map<std::shared_ptr<sigrok::Channel>,
+               const std::unordered_map<std::shared_ptr<sigrok::Channel>,
                        std::shared_ptr<Signal> > &signal_map,
-               std::function<bool (std::shared_ptr<RowItem>)> filter_func =
-                       std::function<bool (std::shared_ptr<RowItem>)>());
+               std::set< std::shared_ptr<Trace> > &add_list);
 
-       static void apply_offset(
-               std::shared_ptr<RowItem> row_item, int &offset);
+       void determine_time_unit();
 
-private:
        bool eventFilter(QObject *object, QEvent *event);
 
-       bool viewportEvent(QEvent *e);
+       bool viewportEvent(QEvent *event);
 
-       void resizeEvent(QResizeEvent *e);
+       void resizeEvent(QResizeEvent *event);
 
 public:
        void row_item_appearance_changed(bool label, bool content);
@@ -249,15 +317,54 @@ public:
 private Q_SLOTS:
 
        void h_scroll_value_changed(int value);
-       void v_scroll_value_changed(int value);
+       void v_scroll_value_changed();
 
        void signals_changed();
+       void capture_state_updated(int state);
        void data_updated();
 
+       void perform_delayed_view_update();
+
        void process_sticky_events();
 
        void on_hover_point_changed();
 
+       /**
+        * Sets the 'offset_' member and emits the 'offset_changed'
+        * signal if needed.
+        */
+       void set_offset(const pv::util::Timestamp& offset);
+
+       /**
+        * Sets the 'scale_' member and emits the 'scale_changed'
+        * signal if needed.
+        */
+       void set_scale(double scale);
+
+       /**
+        * Sets the 'tick_prefix_' member and emits the 'tick_prefix_changed'
+        * signal if needed.
+        */
+       void set_tick_prefix(pv::util::SIPrefix tick_prefix);
+
+       /**
+        * Sets the 'tick_precision_' member and emits the 'tick_precision_changed'
+        * signal if needed.
+        */
+       void set_tick_precision(unsigned tick_precision);
+
+       /**
+        * Sets the 'tick_period_' member and emits the 'tick_period_changed'
+        * signal if needed.
+        */
+       void set_tick_period(const pv::util::Timestamp& tick_period);
+
+       /**
+        * Sets the 'time_unit' member and emits the 'time_unit_changed'
+        * signal if needed.
+        */
+       void set_time_unit(pv::util::TimeUnit time_unit);
+
 private:
        Session &session_;
 
@@ -269,13 +376,17 @@ private:
        double scale_;
 
        /// The view time offset in seconds.
-       double offset_;
+       pv::util::Timestamp offset_;
 
-       int v_offset_;
        bool updating_scroll_;
+       bool sticky_scrolling_;
+       bool always_zoom_to_fit_;
+       QTimer delayed_view_updater_;
 
-       double tick_period_;
-       unsigned int tick_prefix_;
+       pv::util::Timestamp tick_period_;
+       pv::util::SIPrefix tick_prefix_;
+       unsigned int tick_precision_;
+       util::TimeUnit time_unit_;
 
        bool show_cursors_;
        std::shared_ptr<CursorPair> cursors_;
@@ -283,13 +394,18 @@ private:
        std::list< std::shared_ptr<Flag> > flags_;
        char next_flag_text_;
 
+       std::vector< std::shared_ptr<TriggerMarker> > trigger_markers_;
+
        QPoint hover_point_;
 
        unsigned int sticky_events_;
        QTimer lazy_event_handler_;
+
+       // This is true when the defaults couldn't be set due to insufficient info
+       bool scroll_needs_defaults;
 };
 
 } // namespace view
 } // namespace pv
 
-#endif // PULSEVIEW_PV_VIEW_VIEW_H
+#endif // PULSEVIEW_PV_VIEW_VIEW_HPP