Handles user input events. Custom functions can be added to be executed on
when the user enters input.
Name | Type | Default | Description |
---|---|---|---|
element |
HTMLCanvasElement |
document
|
optional The element to add events to. |
Members
The amount of time, in milliseconds, that mouse events will be disabled after
receiving any touch events, such that any emulated mouse events will be ignored.
-
Default Value:
800
The amount of time, in milliseconds, before a touch on the screen becomes a
touch and hold.
-
Default Value:
1500
Methods
Removes listeners held by this object.
Once an object is destroyed, it should not be used; calling any function other than
Once an object is destroyed, it should not be used; calling any function other than
isDestroyed
will result in a DeveloperError
exception. Therefore,
assign the return value (undefined
) to the object as done in the example.
Throws:
-
DeveloperError : This object was destroyed, i.e., destroy() was called.
Example:
handler = handler && handler.destroy();
See:
getInputAction(type, modifier) → ScreenSpaceEventHandler.PositionedEventCallback|ScreenSpaceEventHandler.MotionEventCallback|ScreenSpaceEventHandler.WheelEventCallback|ScreenSpaceEventHandler.TwoPointEventCallback|ScreenSpaceEventHandler.TwoPointMotionEventCallback
Returns the function to be executed on an input event.
Name | Type | Description |
---|---|---|
type |
ScreenSpaceEventType | The ScreenSpaceEventType of input event. |
modifier |
KeyboardEventModifier |
optional
A KeyboardEventModifier key that is held when a type
event occurs. |
Returns:
The function to be executed on an input event.
Returns true if this object was destroyed; otherwise, false.
If this object was destroyed, it should not be used; calling any function other than
If this object was destroyed, it should not be used; calling any function other than
isDestroyed
will result in a DeveloperError
exception.
Returns:
true
if this object was destroyed; otherwise, false
.
Removes the function to be executed on an input event.
Name | Type | Description |
---|---|---|
type |
ScreenSpaceEventType | The ScreenSpaceEventType of input event. |
modifier |
KeyboardEventModifier |
optional
A KeyboardEventModifier key that is held when a type
event occurs. |
Set a function to be executed on an input event.
Name | Type | Description |
---|---|---|
action |
ScreenSpaceEventHandler.PositionedEventCallback | ScreenSpaceEventHandler.MotionEventCallback | ScreenSpaceEventHandler.WheelEventCallback | ScreenSpaceEventHandler.TwoPointEventCallback | ScreenSpaceEventHandler.TwoPointMotionEventCallback | Function to be executed when the input event occurs. |
type |
ScreenSpaceEventType | The ScreenSpaceEventType of input event. |
modifier |
KeyboardEventModifier |
optional
A KeyboardEventModifier key that is held when a type
event occurs. |
Type Definitions
An Event that starts at one position and ends at another.
Properties:
Name | Type | Description |
---|---|---|
startPosition |
Cartesian2 | |
endPosition |
Cartesian2 |
Name | Type | Description |
---|---|---|
event |
ScreenSpaceEventHandler.MotionEvent | The event which triggered the listener |
An Event that occurs at a single position on screen.
Properties:
Name | Type | Description |
---|---|---|
position |
Cartesian2 |
Name | Type | Description |
---|---|---|
event |
ScreenSpaceEventHandler.PositionedEvent | The event which triggered the listener |
An Event that occurs at a two positions on screen.
Properties:
Name | Type | Description |
---|---|---|
position1 |
Cartesian2 | |
position2 |
Cartesian2 |
Name | Type | Description |
---|---|---|
event |
ScreenSpaceEventHandler.TwoPointEvent | The event which triggered the listener |
An Event that starts at a two positions on screen and moves to two other positions.
Properties:
Name | Type | Description |
---|---|---|
position1 |
Cartesian2 | |
position2 |
Cartesian2 | |
previousPosition1 |
Cartesian2 | |
previousPosition2 |
Cartesian2 |
Name | Type | Description |
---|---|---|
event |
ScreenSpaceEventHandler.TwoPointMotionEvent | The event which triggered the listener |
Name | Type | Description |
---|---|---|
delta |
number | The amount that the mouse wheel moved |