ScreenSpaceEventHandler

ScreenSpaceEventHandler

new

Handles user input events. Custom functions can be added to be executed on when the user enters input.

Parameters:
Name Type Description
element DOC_TBA The element to add events to. Defaults to document.
Source:

Methods

Removes listeners held by this object.

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.
Returns:
Example
handler = handler && handler.destroy();
See:

Returns the function to be executed on an input event.

Parameters:
Name Type Argument Description
type Enumeration The ScreenSpaceEventType of input event.
modifier Enumeration <optional>
A KeyboardEventModifier key that is held when a type event occurs.
Throws:
DeveloperError : type is required.
See:

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:
Boolean true if this object was destroyed; otherwise, false.
See:

Removes the function to be executed on an input event.

Parameters:
Name Type Argument Description
type Enumeration The ScreenSpaceEventType of input event.
modifier Enumeration <optional>
A KeyboardEventModifier key that is held when a type event occurs.
Throws:
DeveloperError : type is required.
See:

Set a function to be executed on an input event.

Parameters:
Name Type Argument Description
action Function Function to be executed when the input event occurs.
type Enumeration The ScreenSpaceEventType of input event.
modifier Enumeration <optional>
A KeyboardEventModifier key that is held when a type event occurs.
Throws:
See: