![]() |
LuciadCPillar C# 2024.1.02
|
This class generates high-level touch gesture events from low-level input events. More...
Public Member Functions | |
TouchGestureRecognizer (Luciad.Input.IInputEventCallback callback, Luciad.Concurrent.ITaskScheduler taskScheduler) | |
Creates a TouchGestureRecognizer The generated high level IInputEvent s are passed to the given callback on the UI thread. More... | |
void | Dispose () |
override bool | Equals (object obj) |
override int | GetHashCode () |
void | OnTouchEvent (Luciad.Input.Touch.TouchPointEvent touchPointEvent) |
Entry point for the touch events of the gesture recognizer. More... | |
Properties | |
double | DisplayScale [get, set] |
The display scale factor. More... | |
double | Dpi [get, set] |
The display pixel density in dots per inch. More... | |
Luciad.Input.ScreenDistance | DragThreshold [get, set] |
The screen distance that is used as threshold to detect if a drag is performed. More... | |
uint | LongPressThreshold [get, set] |
The threshold to reach (in milliseconds) before a long press event is sent. More... | |
uint | MultiTapInterval [get, set] |
The interval (in milliseconds) used to detect multiple taps. More... | |
Luciad.Input.ScreenDistance | MultiTapThreshold [get, set] |
The screen distance threshold used to detect multiple taps. More... | |
This class generates high-level touch gesture events from low-level input events.
High level events are subclasses of IInputEvent
such as TouchTapEvent
. Sequences of low level events are used to create those high level events.
For example, a touch press + movement of the touch point (possibly multiple times) sequence is recognized as a touch drag gesture. A touch press + a touch release sequence is recognized as a touch tap 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 TouchGestureRecognizer
is optional. 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 IInputEvent
instances.
The events passed to this class are expected to be defined in device independent pixels.
|
inline |
Creates a TouchGestureRecognizer
The generated high level IInputEvent
s are passed to the given callback on the UI thread.
For certain events, like for example a long press, an internal timer is used to determine when an IInputEvent
needs to be sent. Due to the use of a timer, it is possible that some work is done on a different thread than the UI thread. The task scheduler can be used to apply the result of the timer on the UI thread.
callback | the callback that receive generated IInputEvent s. Can not be null . |
taskScheduler | a scheduler allowing the caller to receive some IInputEvent s on another thread and resolve them on the UI thread. Can be null . If null , some events won't be emitted. |
System.ArgumentNullException | If callback is null . |
|
inline |
|
inline |
|
inline |
|
inline |
Entry point for the touch events of the gesture recognizer.
touchPointEvent | the TouchPointEvent object containing a collection of TouchPoint s. |
|
getset |
The display scale factor.
Returns the display scale factor.
Sets the display scale factor. If no value is provided, a scale factor of 1.0 is assumed.
|
getset |
The display pixel density in dots per inch.
Returns the display pixel density in dots per inch.
Sets the display pixel density in dots per inch. If no value is provided, the platform standard pixel density is assumed.
|
getset |
The screen distance that is used as threshold to detect if a drag is performed.
Returns the screen distance that is used as threshold to detect if a drag is performed.
Sets the screen distance that is used as threshold to detect if a drag is performed. It means that the input has to move at least that distance before it can be detected as a drag gesture.
The default drag threshold is a screen distance of 5 mm.
|
getset |
The threshold to reach (in milliseconds) before a long press event is sent.
Returns the threshold to reach (in milliseconds) before a long press event is sent.
Sets the threshold to reach (in milliseconds) before a long press event is sent. The default is 700 ms.
|
getset |
The interval (in milliseconds) used to detect multiple taps.
Returns the interval (in milliseconds) used to detect multiple taps.
Sets the interval (in milliseconds) used to detect multiple taps. The default is 400 ms.
If the interval is set to 0, no multiple taps will be detected.
|
getset |
The screen distance threshold used to detect multiple taps.
Returns the screen distance threshold used to detect multiple taps.
Sets the screen distance threshold used to detect multiple taps. It means that consecutive taps need to be as close as that distance in order to generate an event for a multiple tap.