 |
LuciadCPillar 2023.1.04
|
|
LuciadCPillar 2023.1.04
|
This class generates high-level mouse gesture events from low-level input events. More...
#include <luciad/input/mouse/MouseGestureRecognizer.h>
Public Member Functions | |
| MouseGestureRecognizer (std::shared_ptr< IInputEventCallback > callback) | |
Creates a MouseGestureRecognizer that passes the generated high level luciad::IInputEvents to the given callback. More... | |
| ~MouseGestureRecognizer () | |
| double | getDisplayScale () const |
| double | getDpi () const |
| ScreenDistance | getDragThreshold () const |
| size_t | getMultiClickInterval () const noexcept |
| Returns the interval used to detect multiple clicks (default is 400 ms). More... | |
| void | onKeyEvent (const KeyEvent &keyEvent) |
| Entry point for the key events of the gesture recognizer. More... | |
| void | onMouseMoveEvent (const MouseMoveEvent &mouseMoveEvent) |
| Entry point for the mouse move events of the gesture recognizer. More... | |
| void | onMousePressedEvent (const MousePressedEvent &mousePressedEvent) |
| Entry point for the mouse pressed events of the gesture recognizer. More... | |
| void | onMouseReleasedEvent (const MouseReleasedEvent &mouseReleasedEvent) |
| Entry point for the mouse released events of the gesture recognizer. More... | |
| void | onScrollEvent (const ScrollEvent &scrollEvent) |
| Entry point for the scroll events of the gesture recognizer. More... | |
| void | setDisplayScale (double scale) |
| Set the display scale factor. More... | |
| void | setDpi (double dpi) |
| Set the display pixel density in dots per inch. More... | |
| void | setDragThreshold (ScreenDistance threshold) |
| Sets the screen distance that is used as threshold to detect if a drag is performed. More... | |
| void | setMultiClickInterval (size_t interval) |
| Set the interval used to detect multiple clicks (default is 400 ms). More... | |
This class generates high-level mouse gesture events from low-level input events.
High level events are subclasses of luciad::IInputEvent such as luciad::MouseClickEvent. Low levels are used to create those high level events and are dropped afterwards.
For example, a mouse pressed + (possibly multiple) mouse moved + a mouse released sequence is recognized as a drag gesture. A mouse pressed + a mouse released sequence is recognized as a click gesture. This class is useful when adding integration with a platform that does not provide these more high-level events.
A typical use of such a class is to wire it to a UI framework specific class (such as Qt , see QQuickMapObject in the sample code) and make the controller react to the high level event instead of every low level event the framework can fire.
The use of the MouseGestureRecognizer is optional. Events containing MouseButton::unknown() as the mouse button are not processed. A controller implementation can use custom conversion code if needed, for example if you want to manage the low level events yourself and create other high level luciad::IInputEvent instances.
The events passed to this class are expected to be defined in device independent pixels.
|
explicit |
Creates a MouseGestureRecognizer that passes the generated high level luciad::IInputEvents to the given callback.
| callback | the callback that receive generated luciad::IInputEvents. Can not be nullptr. |
| luciad::NullArgumentException | If callback is nullptr. |
| luciad::MouseGestureRecognizer::~MouseGestureRecognizer | ( | ) |
| double luciad::MouseGestureRecognizer::getDisplayScale | ( | ) | const |
| double luciad::MouseGestureRecognizer::getDpi | ( | ) | const |
| ScreenDistance luciad::MouseGestureRecognizer::getDragThreshold | ( | ) | const |
|
noexcept |
Returns the interval used to detect multiple clicks (default is 400 ms).
| void luciad::MouseGestureRecognizer::onKeyEvent | ( | const KeyEvent & | keyEvent | ) |
Entry point for the key events of the gesture recognizer.
| keyEvent | the low level key event. |
| void luciad::MouseGestureRecognizer::onMouseMoveEvent | ( | const MouseMoveEvent & | mouseMoveEvent | ) |
Entry point for the mouse move events of the gesture recognizer.
| mouseMoveEvent | the low level mouse move event. |
| void luciad::MouseGestureRecognizer::onMousePressedEvent | ( | const MousePressedEvent & | mousePressedEvent | ) |
Entry point for the mouse pressed events of the gesture recognizer.
| mousePressedEvent | the low level mouse press event. |
| void luciad::MouseGestureRecognizer::onMouseReleasedEvent | ( | const MouseReleasedEvent & | mouseReleasedEvent | ) |
Entry point for the mouse released events of the gesture recognizer.
| mouseReleasedEvent | the low level mouse released event. |
| void luciad::MouseGestureRecognizer::onScrollEvent | ( | const ScrollEvent & | scrollEvent | ) |
Entry point for the scroll events of the gesture recognizer.
| scrollEvent | the low level mouse scroll event. |
| void luciad::MouseGestureRecognizer::setDisplayScale | ( | double | scale | ) |
Set the display scale factor.
If no value is provided, a scale factor of 1.0 is assumed.
| scale | the display scale factor (adimensional scale value) |
| void luciad::MouseGestureRecognizer::setDpi | ( | double | dpi | ) |
Set the display pixel density in dots per inch.
If no value is provided, the platform standard pixel density is assumed.
| dpi | the pixel density in dots per inch |
| void luciad::MouseGestureRecognizer::setDragThreshold | ( | ScreenDistance | threshold | ) |
Sets the screen distance that is used as threshold to detect if a drag is performed.
It means that the mouse cursor has to move at least that amount of pixels before it can be detected as a drag gesture.
The default value in device independent pixels is 2 pixels.
| threshold | the threshold |
| void luciad::MouseGestureRecognizer::setMultiClickInterval | ( | size_t | interval | ) |
Set the interval used to detect multiple clicks (default is 400 ms).
| interval | the maximum time (in milliseconds) between multiple clicks. If the interval is set to 0, no multiple clicks will be detected. |
1.9.4