Luciad.Controllers.HoverEventHandler Class Reference

Handler that translates hover gesture events to a hovering operation. More...

Inheritance diagram for Luciad.Controllers.HoverEventHandler:

Public Member Functions
	HoverEventHandler ()
	Creates a new instance. More...
void	Dispose ()
override bool	Equals (object obj)
override int	GetHashCode ()
Luciad.Controllers.EventResult	OnMouseMoveEvent (Luciad.Input.Mouse.MouseMoveEvent moveEvent, Luciad.Maps.Map map)
	Changes the FeatureState.hover() state of features located under the mouse position. More...

Properties
uint	Margin [get, set]
	The margin used to detect if a feature is considered under the cursor or not. More...

Detailed Description

Handler that translates hover gesture events to a hovering operation.

Features under the cursor will have their FeatureState.hover() state updated.

Since

2020.1

Constructor & Destructor Documentation

HoverEventHandler()

Luciad.Controllers.HoverEventHandler.HoverEventHandler ( )

inline

Creates a new instance.

Member Function Documentation

Dispose()

void Luciad.Controllers.HoverEventHandler.Dispose ( )

inline

Equals()

override bool Luciad.Controllers.HoverEventHandler.Equals ( object  obj )

inline

GetHashCode()

override int Luciad.Controllers.HoverEventHandler.GetHashCode ( )

inline

OnMouseMoveEvent()

Luciad.Controllers.EventResult Luciad.Controllers.HoverEventHandler.OnMouseMoveEvent ( Luciad.Input.Mouse.MouseMoveEvent  moveEvent, Luciad.Maps.Map  map  )

inline

Changes the FeatureState.hover() state of features located under the mouse position.

Parameters

moveEvent	a move event. Cannot be null.
map	the map. Cannot be null.

Returns

whether the move event is consumed or not. Always EventResult.Consumed.

Exceptions

System.ArgumentNullException

when passing null for the map or the event.

See also

HoverEventHandler.Margin for the margin applied to the mouse position to detect which features are considered.

Property Documentation

Margin

uint Luciad.Controllers.HoverEventHandler.Margin

getset

The margin used to detect if a feature is considered under the cursor or not.

[get]

Returns the margin used to detect if a feature is considered under the cursor or not. The default value is 5 pixels.

[set]

Sets the margin used to detect if a feature is considered under the cursor or not. This margin is expressed in device independent pixels. By default, the margin is 5 pixels.