Luciad.Input.Mouse.MouseGestureRecognizer Class Reference

This class generates high-level mouse gesture events from low-level input events. More...

Inheritance diagram for Luciad.Input.Mouse.MouseGestureRecognizer:

Public Member Functions
	MouseGestureRecognizer (Luciad.Input.IInputEventCallback callback)
void	Dispose ()
void	OnKeyEvent (Luciad.Input.KeyEvent keyEvent)
	Entry point for the key events of the gesture recognizer. More...
void	OnMouseMoveEvent (Luciad.Input.Mouse.MouseMoveEvent mouseMoveEvent)
	Entry point for the mouse move events of the gesture recognizer. More...
void	OnMousePressedEvent (Luciad.Input.Mouse.MousePressedEvent mousePressedEvent)
	Entry point for the mouse pressed events of the gesture recognizer. More...
void	OnMouseReleasedEvent (Luciad.Input.Mouse.MouseReleasedEvent mouseReleasedEvent)
	Entry point for the mouse released events of the gesture recognizer. More...
void	OnScrollEvent (Luciad.Input.ScrollEvent scrollEvent)
	Entry point for the scroll events of the gesture recognizer. More...

Properties
double	DisplayScale [get, set]
double	Dpi [get, set]
Luciad.Input.ScreenDistance	DragThreshold [get, set]
uint	MultiClickInterval [get, set]

Detailed Description

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. 2022.0

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseGestureRecognizer.

Constructor & Destructor Documentation

MouseGestureRecognizer()

Luciad.Input.Mouse.MouseGestureRecognizer.MouseGestureRecognizer ( Luciad.Input.IInputEventCallback  callback )

inline

Member Function Documentation

Dispose()

void Luciad.Input.Mouse.MouseGestureRecognizer.Dispose ( )

inline

OnKeyEvent()

void Luciad.Input.Mouse.MouseGestureRecognizer.OnKeyEvent ( Luciad.Input.KeyEvent  keyEvent )

inline

Entry point for the key events of the gesture recognizer.

keyEvent

the low level key event.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseGestureRecognizer::onKeyEvent.

OnMouseMoveEvent()

void Luciad.Input.Mouse.MouseGestureRecognizer.OnMouseMoveEvent ( Luciad.Input.Mouse.MouseMoveEvent  mouseMoveEvent )

inline

Entry point for the mouse move events of the gesture recognizer.

mouseMoveEvent

the low level mouse move event.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseGestureRecognizer::onMouseMoveEvent.

OnMousePressedEvent()

void Luciad.Input.Mouse.MouseGestureRecognizer.OnMousePressedEvent ( Luciad.Input.Mouse.MousePressedEvent  mousePressedEvent )

inline

Entry point for the mouse pressed events of the gesture recognizer.

mousePressedEvent

the low level mouse press event.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseGestureRecognizer::onMousePressedEvent.

OnMouseReleasedEvent()

void Luciad.Input.Mouse.MouseGestureRecognizer.OnMouseReleasedEvent ( Luciad.Input.Mouse.MouseReleasedEvent  mouseReleasedEvent )

inline

Entry point for the mouse released events of the gesture recognizer.

mouseReleasedEvent

the low level mouse released event.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseGestureRecognizer::onMouseReleasedEvent.

OnScrollEvent()

void Luciad.Input.Mouse.MouseGestureRecognizer.OnScrollEvent ( Luciad.Input.ScrollEvent  scrollEvent )

inline

Entry point for the scroll events of the gesture recognizer.

scrollEvent

the low level mouse scroll event.

Warning

C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::MouseGestureRecognizer::onScrollEvent.

Property Documentation

DisplayScale

double Luciad.Input.Mouse.MouseGestureRecognizer.DisplayScale

getset

Dpi

double Luciad.Input.Mouse.MouseGestureRecognizer.Dpi

getset

DragThreshold

Luciad.Input.ScreenDistance Luciad.Input.Mouse.MouseGestureRecognizer.DragThreshold

getset

MultiClickInterval

uint Luciad.Input.Mouse.MouseGestureRecognizer.MultiClickInterval

getset