Luciad.Controllers.RotateEventHandler Class Reference

Handler that translates drag gesture events to a rotate operation. More...

Inheritance diagram for Luciad.Controllers.RotateEventHandler:

Public Member Functions
	RotateEventHandler ()
	Creates a new instance. More...
void	Dispose ()
override bool	Equals (object obj)
override int	GetHashCode ()
Luciad.Controllers.EventResult	OnDragEvent (Luciad.Input.DragEvent dragEvent, Luciad.Maps.Map map)
	Rotates the map's camera following the drag direction. More...

Properties
bool	IsPitchEnabled [get, set]
	Whether the RotateEventHandler can change the pitch of the camera. More...
bool	IsYawEnabled [get, set]
	Whether the RotateEventHandler can change the yaw of the camera. More...

Detailed Description

Handler that translates drag gesture events to a rotate operation.

Rotation is done using a MapNavigator.RotateAction, please check this class documentation for more information on how the rotation is performed.

Since

2020.1

Constructor & Destructor Documentation

RotateEventHandler()

Luciad.Controllers.RotateEventHandler.RotateEventHandler ( )

inline

Creates a new instance.

Member Function Documentation

Dispose()

void Luciad.Controllers.RotateEventHandler.Dispose ( )

inline

Equals()

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

inline

GetHashCode()

override int Luciad.Controllers.RotateEventHandler.GetHashCode ( )

inline

OnDragEvent()

Luciad.Controllers.EventResult Luciad.Controllers.RotateEventHandler.OnDragEvent ( Luciad.Input.DragEvent  dragEvent, Luciad.Maps.Map  map  )

inline

Rotates the map's camera following the drag direction.

The drag event is consumed only if the sequence of events is the following : a EventStatus.Start event, 0 or more EventStatus.InProgress event and finally a EventStatus.End event. If the sequence is not correct, this method returns EventResult.NotConsumed.

Parameters

dragEvent	a drag event. Cannot be null.
map	the map. Cannot be null.

Returns

whether the drag event is consumed or not.

Exceptions

System.ArgumentNullException

when passing null for the map or the event.

Property Documentation

IsPitchEnabled

bool Luciad.Controllers.RotateEventHandler.IsPitchEnabled

getset

Whether the RotateEventHandler can change the pitch of the camera.

[get]

Returns whether the RotateEventHandler can change the pitch of the camera. The default value is true.

[set]

Sets whether the RotateEventHandler can change the pitch of the camera. If true, that means that the vertical variations of the drag events locations are considered. This is useful only if the map is 3D.

Since

2021.1

See also

setPitchEnabled

IsYawEnabled

bool Luciad.Controllers.RotateEventHandler.IsYawEnabled

getset

Whether the RotateEventHandler can change the yaw of the camera.

[get]

Returns whether the RotateEventHandler can change the yaw of the camera. The default value is true.

[set]

Sets whether the RotateEventHandler can change the yaw of the camera. If true, that means that the horizontal variations of the drag events locations are considered. This is useful only if the map is 3D.

Since

2021.1

See also

setYawEnabled