org.cesiumjs.cs.core

Class ScreenSpaceEventHandler

java.lang.Object

org.cesiumjs.cs.core.ScreenSpaceEventHandler

@JsType(isNative=true,
        namespace="Cesium",
        name="ScreenSpaceEventHandler")
public class ScreenSpaceEventHandler
extends Object

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ScreenSpaceEventHandler.Listener<T>

Field Summary

Fields

Modifier and Type	Field and Description
static int	mouseEmulationIgnoreMilliseconds 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.
static int	touchHoldDelayMilliseconds The amount of time, in milliseconds, before a touch on the screen becomes a touch and hold.

Constructor Summary

Constructors

Constructor and Description
ScreenSpaceEventHandler(com.google.gwt.dom.client.CanvasElement element) Handles user input events.

Method Summary

Modifier and Type	Method and Description
void	destroy() Removes listeners held by this object.
Function	getInputAction(Number type) Returns the function to be executed on an input event.
Function	getInputAction(Number type, Number modifier) Returns the function to be executed on an input event.
boolean	isDestroyed() Returns true if this object was destroyed; otherwise, false.
void	removeInputAction(Number type) Removes the function to be executed on an input event.
void	removeInputAction(Number type, Number modifier) Removes the function to be executed on an input event.
void	setInputAction(ScreenSpaceEventHandler.Listener action, Number type) Set a function to be executed on an input event.
void	setInputAction(ScreenSpaceEventHandler.Listener action, Number type, Number modifier) Set a function to be executed on an input event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

mouseEmulationIgnoreMilliseconds

@JsProperty
public static int mouseEmulationIgnoreMilliseconds

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: 800

touchHoldDelayMilliseconds

@JsProperty
public static int touchHoldDelayMilliseconds

The amount of time, in milliseconds, before a touch on the screen becomes a touch and hold. Default: 1500

Constructor Detail

ScreenSpaceEventHandler

@JsConstructor
public ScreenSpaceEventHandler(com.google.gwt.dom.client.CanvasElement element)

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

Parameters:

element - The element to add events to. Default: document

Method Detail

destroy

@JsMethod
public void 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.

See Also:

isDestroyed()

getInputAction

@JsMethod
public Function getInputAction(Number type)

Returns the function to be executed on an input event.

Parameters:

type - The ScreenSpaceEventType of input event.

Returns:

Returns the function to be executed on an input event.

See Also:

setInputAction(org.cesiumjs.cs.core.ScreenSpaceEventHandler.Listener, java.lang.Number), removeInputAction(java.lang.Number)

getInputAction

@JsMethod
public Function getInputAction(Number type,
                                         Number modifier)

Returns the function to be executed on an input event.

Parameters:

type - The ScreenSpaceEventType of input event.

modifier - A KeyboardEventModifier key that is held when a type event occurs.

Returns:

Returns the function to be executed on an input event.

See Also:

setInputAction(org.cesiumjs.cs.core.ScreenSpaceEventHandler.Listener, java.lang.Number), removeInputAction(java.lang.Number)

isDestroyed

@JsMethod
public boolean 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:

true if this object was destroyed; otherwise, false.

See Also:

destroy()

removeInputAction

@JsMethod
public void removeInputAction(Number type)

Removes the function to be executed on an input event.

Parameters:

type - The ScreenSpaceEventType of input event.

See Also:

setInputAction(org.cesiumjs.cs.core.ScreenSpaceEventHandler.Listener, java.lang.Number)

removeInputAction

@JsMethod
public void removeInputAction(Number type,
                                        Number modifier)

Removes the function to be executed on an input event.

Parameters:

type - The ScreenSpaceEventType of input event.

modifier - A KeyboardEventModifier key that is held when a type event occurs.

See Also:

getInputAction(java.lang.Number), setInputAction(org.cesiumjs.cs.core.ScreenSpaceEventHandler.Listener, java.lang.Number)

setInputAction

@JsMethod
public void setInputAction(ScreenSpaceEventHandler.Listener action,
                                     Number type)

Set a function to be executed on an input event.

Parameters:

action - Function to be executed when the input event occurs.

type - The ScreenSpaceEventType of input event.

See Also:

getInputAction(java.lang.Number), removeInputAction(java.lang.Number)

setInputAction

@JsMethod
public void setInputAction(ScreenSpaceEventHandler.Listener action,
                                     Number type,
                                     Number modifier)

Set a function to be executed on an input event.

Parameters:

action - Function to be executed when the input event occurs.

type - The ScreenSpaceEventType of input event.

modifier - A KeyboardEventModifier key that is held when a type event occurs.

See Also:

getInputAction(java.lang.Number), removeInputAction(java.lang.Number)