Luciad.Controllers.ZoomEventHandler Class Reference

Handler that translates scroll or click gesture events to a zoom operation. More...

Inheritance diagram for Luciad.Controllers.ZoomEventHandler:

Public Member Functions
	ZoomEventHandler ()
	Creates a new zoom event handler. More...
void	Dispose ()
override bool	Equals (object obj)
override int	GetHashCode ()
EventResult	OnClickEvent (Luciad.Input.ClickEvent clickEvent, Luciad.Maps.Map map, bool zoomIn, double zoomSpeed=1.0)
	Zooms towards or from the mouse position of a click. More...
EventResult	OnScrollEvent (Luciad.Input.ScrollEvent scrollEvent, Luciad.Maps.Map map, double zoomSpeed=1.0, bool invertZoomDirection=false)
	Applies a zoom towards or from the mouse position using the wheel uses the given zoom speed, with 1 being the default zoom speed. More...

Detailed Description

Handler that translates scroll or click gesture events to a zoom operation.

This is a reusable code block that a controller designer can use in its implementation.

Since

2020.1

Constructor & Destructor Documentation

ZoomEventHandler()

Luciad.Controllers.ZoomEventHandler.ZoomEventHandler ( )

inline

Creates a new zoom event handler.

Member Function Documentation

Dispose()

void Luciad.Controllers.ZoomEventHandler.Dispose ( )

inline

Equals()

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

inline

GetHashCode()

override int Luciad.Controllers.ZoomEventHandler.GetHashCode ( )

inline

OnClickEvent()

EventResult Luciad.Controllers.ZoomEventHandler.OnClickEvent ( Luciad.Input.ClickEvent  clickEvent, Luciad.Maps.Map  map, bool  zoomIn, double  zoomSpeed = 1.0  )

inline

Zooms towards or from the mouse position of a click.

Parameters

clickEvent	a click event, cannot be null.
map	the map, cannot be null.
zoomIn	true if zooming in, false otherwise.
zoomSpeed	the zoom speed. Must be a number greater than 0. Default value is 1.0.

Returns

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

Exceptions

System.ArgumentNullException

when passing null for the map or the event.

OnScrollEvent()

EventResult Luciad.Controllers.ZoomEventHandler.OnScrollEvent ( Luciad.Input.ScrollEvent  scrollEvent, Luciad.Maps.Map  map, double  zoomSpeed = 1.0, bool  invertZoomDirection = false  )

inline

Applies a zoom towards or from the mouse position using the wheel uses the given zoom speed, with 1 being the default zoom speed.

For example: 0.5 zooms twice as slow, 2 zooms twice as much. The direction of the scroll is used to determine the direction of this action.

Parameters

scrollEvent	a scroll event, cannot be null.
map	the map, cannot be null.
zoomSpeed	the zoom speed. Must be a number greater than 0. Default value is 1.0.
invertZoomDirection	to invert the zoom direction. By default, this method will zoom in when the verticals scrolling delta is positive, and zoom out when it is negative

Returns

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

Exceptions

System.ArgumentNullException

when passing null for the map or the event.