]>
Commit | Line | Data |
---|---|---|
ccdd3ef5 | 1 | /* |
b3f22de0 | 2 | * This file is part of the PulseView project. |
ccdd3ef5 JH |
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 | |
efdec55a | 17 | * along with this program; if not, see <http://www.gnu.org/licenses/>. |
ccdd3ef5 JH |
18 | */ |
19 | ||
f4e57597 SA |
20 | #ifndef PULSEVIEW_PV_VIEWS_TRACEVIEW_RULER_HPP |
21 | #define PULSEVIEW_PV_VIEWS_TRACEVIEW_RULER_HPP | |
ccdd3ef5 | 22 | |
4b0af0b6 | 23 | #include <functional> |
f9abf97e | 24 | #include <memory> |
58864c5c | 25 | |
4b0af0b6 JS |
26 | #include <boost/optional.hpp> |
27 | ||
2acdb232 | 28 | #include "marginwidget.hpp" |
4b0af0b6 | 29 | #include <pv/util.hpp> |
ccdd3ef5 | 30 | |
6f925ba9 UH |
31 | using std::function; |
32 | using std::pair; | |
33 | using std::shared_ptr; | |
34 | using std::vector; | |
35 | ||
c677193d | 36 | namespace RulerTest { |
5d6ae8a2 SA |
37 | struct tick_position_test_0; |
38 | struct tick_position_test_1; | |
39 | struct tick_position_test_2; | |
c677193d JS |
40 | } |
41 | ||
ccdd3ef5 | 42 | namespace pv { |
f4e57597 | 43 | namespace views { |
1573bf16 | 44 | namespace trace { |
ccdd3ef5 | 45 | |
819e2e95 | 46 | class TimeItem; |
6871ee9f | 47 | class ViewItem; |
819e2e95 | 48 | |
1373fec5 SA |
49 | /** |
50 | * The Ruler class manages and displays the time scale above the trace canvas. | |
51 | * It may also contain @ref TimeItem instances used to identify or highlight | |
52 | * time-related information. | |
53 | */ | |
c23b29d6 | 54 | class Ruler : public MarginWidget |
ccdd3ef5 JH |
55 | { |
56 | Q_OBJECT | |
57 | ||
5d6ae8a2 SA |
58 | friend struct RulerTest::tick_position_test_0; |
59 | friend struct RulerTest::tick_position_test_1; | |
60 | friend struct RulerTest::tick_position_test_2; | |
c677193d | 61 | |
ccdd3ef5 | 62 | private: |
249229ec JH |
63 | /// Height of the ruler in multipes of the text height |
64 | static const float RulerHeight; | |
65 | ||
ccdd3ef5 | 66 | static const int MinorTickSubdivision; |
ccdd3ef5 | 67 | |
415341a1 JH |
68 | /// Height of the hover arrow in multiples of the text height |
69 | static const float HoverArrowSize; | |
b3a7c013 | 70 | |
ccdd3ef5 JH |
71 | public: |
72 | Ruler(View &parent); | |
73 | ||
a6c1726e | 74 | public: |
b2650e69 | 75 | QSize sizeHint() const override; |
a6c1726e | 76 | |
819e2e95 JH |
77 | /** |
78 | * The extended area that the header widget would like to be sized to. | |
79 | * @remarks This area is the area specified by sizeHint, extended by | |
80 | * the area to overlap the viewport. | |
81 | */ | |
b2650e69 | 82 | QSize extended_size_hint() const override; |
819e2e95 | 83 | |
3ccf0f7f JS |
84 | /** |
85 | * Formats a timestamp depending on its distance to another timestamp. | |
86 | * | |
87 | * Heuristic function, useful when multiple timestamps should be put side by | |
88 | * side. The function procedes in the following order: | |
89 | * - If 't' is zero, "0" is returned. | |
90 | * - If 'unit' is 'TimeUnit::Samples', 'pv::util::format_time_si_adjusted()' | |
91 | * is used to format 't'. | |
92 | * - If a zoomed out view is detected (determined by 'precision' and | |
93 | * 'distance'), 'pv::util::format_time_minutes() is used. | |
94 | * - For timestamps "near the origin" (determined by 'distance'), | |
95 | * 'pv::util::format_time_si_adjusted()' is used. | |
96 | * - If none of the previous was true, 'pv::util::format_time_minutes()' | |
97 | * is used again. | |
98 | * | |
99 | * @param distance The distance between the timestamp to format and | |
100 | * an adjacent one. | |
101 | * @param t The value to format | |
102 | * @param prefix The SI prefix to use. | |
103 | * @param unit The representation of the timestamp value. | |
104 | * @param precision The number of digits after the decimal separator. | |
105 | * @param sign Whether or not to add a sign also for positive numbers. | |
106 | * | |
107 | * @return The formated value. | |
108 | */ | |
109 | static QString format_time_with_distance( | |
110 | const pv::util::Timestamp& distance, | |
111 | const pv::util::Timestamp& t, | |
112 | pv::util::SIPrefix prefix = pv::util::SIPrefix::unspecified, | |
113 | pv::util::TimeUnit unit = pv::util::TimeUnit::Time, | |
114 | unsigned precision = 0, | |
115 | bool sign = true); | |
116 | ||
25a0d47c | 117 | private: |
3e124bee JH |
118 | /** |
119 | * Gets the time items. | |
120 | */ | |
6f925ba9 | 121 | vector< shared_ptr<ViewItem> > items() override; |
3e124bee | 122 | |
6871ee9f JH |
123 | /** |
124 | * Gets the first view item which has a label that contains @c pt . | |
125 | * @param pt the point to search with. | |
126 | * @return the view item that has been found, or and empty | |
127 | * @c shared_ptr if no item was found. | |
128 | */ | |
6f925ba9 | 129 | shared_ptr<ViewItem> get_mouse_over_item(const QPoint &pt) override; |
25a0d47c | 130 | |
b2650e69 | 131 | void paintEvent(QPaintEvent *event) override; |
ccdd3ef5 | 132 | |
d9ea9628 | 133 | void mouseDoubleClickEvent(QMouseEvent *event) override; |
819e2e95 | 134 | |
b3a7c013 JH |
135 | /** |
136 | * Draw a hover arrow under the cursor position. | |
249229ec JH |
137 | * @param p The painter to draw into. |
138 | * @param text_height The height of a single text ascent. | |
b3a7c013 | 139 | */ |
249229ec | 140 | void draw_hover_mark(QPainter &p, int text_height); |
b3a7c013 | 141 | |
e456e8e1 | 142 | int calculate_text_height() const; |
819e2e95 | 143 | |
4b0af0b6 JS |
144 | struct TickPositions |
145 | { | |
6f925ba9 UH |
146 | vector<pair<double, QString>> major; |
147 | vector<double> minor; | |
4b0af0b6 JS |
148 | }; |
149 | ||
150 | /** | |
151 | * Holds the tick positions so that they don't have to be recalculated on | |
152 | * every redraw. Set by 'paintEvent()' when needed. | |
153 | */ | |
154 | boost::optional<TickPositions> tick_position_cache_; | |
155 | ||
156 | /** | |
157 | * Calculates the major and minor tick positions. | |
158 | * | |
159 | * @param major_period The period between the major ticks. | |
160 | * @param offset The time at the left border of the ruler. | |
161 | * @param scale The scale in seconds per pixel. | |
162 | * @param width the Width of the ruler. | |
163 | * @param format_function A function used to format the major tick times. | |
164 | * @return An object of type 'TickPositions' that contains the major tick | |
165 | * positions together with the labels at that ticks, and the minor | |
166 | * tick positions. | |
167 | */ | |
168 | static TickPositions calculate_tick_positions( | |
c677193d | 169 | const pv::util::Timestamp& major_period, |
4b0af0b6 JS |
170 | const pv::util::Timestamp& offset, |
171 | const double scale, | |
172 | const int width, | |
6f925ba9 | 173 | function<QString(const pv::util::Timestamp&)> format_function); |
4b0af0b6 JS |
174 | |
175 | protected: | |
176 | void resizeEvent(QResizeEvent*) override; | |
177 | ||
e9213170 | 178 | private Q_SLOTS: |
873e8035 | 179 | void hover_point_changed(const QPoint &hp); |
4b0af0b6 JS |
180 | |
181 | // Resets the 'tick_position_cache_'. | |
182 | void invalidate_tick_position_cache(); | |
ccdd3ef5 JH |
183 | }; |
184 | ||
1573bf16 | 185 | } // namespace trace |
f4e57597 | 186 | } // namespace views |
ccdd3ef5 JH |
187 | } // namespace pv |
188 | ||
f4e57597 | 189 | #endif // PULSEVIEW_PV_VIEWS_TRACEVIEW_RULER_HPP |