Class that zooms faster if scroll events happen very close together. More...
#include <zoom_controller.h>
Classes | |
| class | TIMESTAMP_PROVIDER |
Public Types | |
| using | TIMEOUT = std::chrono::milliseconds |
| The type of the acceleration timeout. | |
| using | CLOCK = std::chrono::steady_clock |
| The clock used for the timestamp (guaranteed to be monotonic). | |
| using | TIME_PT = std::chrono::time_point<CLOCK> |
| The type of the time stamps. | |
Public Member Functions | |
| ACCELERATING_ZOOM_CONTROLLER (double aScale=DEFAULT_ACCELERATION_SCALE, const TIMEOUT &aAccTimeout=DEFAULT_TIMEOUT, TIMESTAMP_PROVIDER *aTimestampProv=nullptr) | |
| double | GetScaleForRotation (int aRotation) override |
| Get the scale factor produced by a given mousewheel rotation. | |
| TIMEOUT | GetTimeout () const |
| void | SetTimeout (const TIMEOUT &aNewTimeout) |
Static Public Attributes | |
| static constexpr TIMEOUT | DEFAULT_TIMEOUT = std::chrono::milliseconds( 500 ) |
| The default timeout, after which a another scroll will not be accelerated. | |
| static constexpr double | DEFAULT_ACCELERATION_SCALE = 5.0 |
| The default minimum step factor for accelerating controller. | |
Private Attributes | |
| TIMESTAMP_PROVIDER * | m_timestampProv |
| The timestamp provider to use (might be provided externally). | |
| std::unique_ptr< TIMESTAMP_PROVIDER > | m_ownTimestampProv |
| Any provider owned by this class (the default one, if used). | |
| TIME_PT | m_prevTimestamp |
| The timestamp of the previous event. | |
| TIMEOUT | m_accTimeout |
| The timeout value. | |
| bool | m_prevRotationPositive = false |
| Previous rotation was positive. | |
| double | m_scale |
| A multiplier for the minimum zoom step size. | |
Detailed Description
Class that zooms faster if scroll events happen very close together.
Definition at line 62 of file zoom_controller.h.
Member Typedef Documentation
◆ CLOCK
| using KIGFX::ACCELERATING_ZOOM_CONTROLLER::CLOCK = std::chrono::steady_clock |
The clock used for the timestamp (guaranteed to be monotonic).
Definition at line 69 of file zoom_controller.h.
◆ TIME_PT
| using KIGFX::ACCELERATING_ZOOM_CONTROLLER::TIME_PT = std::chrono::time_point<CLOCK> |
The type of the time stamps.
Definition at line 72 of file zoom_controller.h.
◆ TIMEOUT
| using KIGFX::ACCELERATING_ZOOM_CONTROLLER::TIMEOUT = std::chrono::milliseconds |
The type of the acceleration timeout.
Definition at line 66 of file zoom_controller.h.
Constructor & Destructor Documentation
◆ ACCELERATING_ZOOM_CONTROLLER()
| ACCELERATING_ZOOM_CONTROLLER::ACCELERATING_ZOOM_CONTROLLER | ( | double | aScale = DEFAULT_ACCELERATION_SCALE, |
| const TIMEOUT & | aAccTimeout = DEFAULT_TIMEOUT, | ||
| TIMESTAMP_PROVIDER * | aTimestampProv = nullptr ) |
- Parameters
-
aAccTimeout the timeout - if a scroll happens within this timeframe, the zoom will be faster. aTimestampProv a provider for timestamps. If null, a default will be provided, which is the main steady_clock (this is probably what you want for real usage).
Definition at line 54 of file zoom_controller.cpp.
References m_accTimeout, m_ownTimestampProv, m_prevTimestamp, m_scale, and m_timestampProv.
Member Function Documentation
◆ GetScaleForRotation()
|
overridevirtual |
Get the scale factor produced by a given mousewheel rotation.
- Parameters
-
aRotation rotation of the mouse wheel (this comes from wxMouseEvent::GetWheelRotation()).
- Returns
- the scale factor to scroll by.
Implements KIGFX::ZOOM_CONTROLLER.
Definition at line 73 of file zoom_controller.cpp.
References m_accTimeout, m_prevRotationPositive, m_prevTimestamp, m_scale, m_timestampProv, and traceZoomScroll.
Referenced by BOOST_AUTO_TEST_CASE().
◆ GetTimeout()
|
inline |
Definition at line 107 of file zoom_controller.h.
References m_accTimeout.
◆ SetTimeout()
|
inline |
Definition at line 112 of file zoom_controller.h.
References m_accTimeout.
Member Data Documentation
◆ DEFAULT_ACCELERATION_SCALE
|
staticconstexpr |
The default minimum step factor for accelerating controller.
Definition at line 78 of file zoom_controller.h.
Referenced by BOOST_AUTO_TEST_CASE().
◆ DEFAULT_TIMEOUT
|
staticconstexpr |
The default timeout, after which a another scroll will not be accelerated.
Definition at line 75 of file zoom_controller.h.
◆ m_accTimeout
|
private |
The timeout value.
Definition at line 128 of file zoom_controller.h.
Referenced by ACCELERATING_ZOOM_CONTROLLER(), GetScaleForRotation(), GetTimeout(), and SetTimeout().
◆ m_ownTimestampProv
|
private |
Any provider owned by this class (the default one, if used).
Definition at line 122 of file zoom_controller.h.
Referenced by ACCELERATING_ZOOM_CONTROLLER().
◆ m_prevRotationPositive
|
private |
Previous rotation was positive.
Definition at line 131 of file zoom_controller.h.
Referenced by GetScaleForRotation().
◆ m_prevTimestamp
|
private |
The timestamp of the previous event.
Definition at line 125 of file zoom_controller.h.
Referenced by ACCELERATING_ZOOM_CONTROLLER(), and GetScaleForRotation().
◆ m_scale
|
private |
A multiplier for the minimum zoom step size.
Definition at line 134 of file zoom_controller.h.
Referenced by ACCELERATING_ZOOM_CONTROLLER(), and GetScaleForRotation().
◆ m_timestampProv
|
private |
The timestamp provider to use (might be provided externally).
Definition at line 119 of file zoom_controller.h.
Referenced by ACCELERATING_ZOOM_CONTROLLER(), and GetScaleForRotation().
The documentation for this class was generated from the following files:
