ScreenSpaceEventHandler

new ScreenSpaceEventHandler

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:

/Source/Core/ScreenSpaceEventHandler.js

Methods

destroy

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:

ScreenSpaceEventHandler#isDestroyed

getInputAction

Returns the function to be executed on an input event.

Parameters:

Name	Type	Description
`type`	Enumeration	The ScreenSpaceEventType of input event.
`modifier`	Enumeration	A KeyboardEventModifier key that is held when a `type` event occurs.

Throws:

DeveloperError : type is required.

See:

isDestroyed

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:

ScreenSpaceEventHandler#destroy

removeInputAction

Removes the function to be executed on an input event.

Parameters:

Name	Type	Description
`type`	Enumeration	The ScreenSpaceEventType of input event.
`modifier`	Enumeration	A KeyboardEventModifier key that is held when a `type` event occurs.

Throws:

DeveloperError : type is required.

See:

setInputAction

Set a function to be executed on an input event.

Parameters:

Name	Type	Description
`action`	Function	Function to be executed when the input event occurs.
`type`	Enumeration	The ScreenSpaceEventType of input event.
`modifier`	Enumeration	A KeyboardEventModifier key that is held when a `type` event occurs.

Throws:

DeveloperError : action is required.
DeveloperError : type is required.