kotlin-cesium-engine/cesium.engine/ScreenSpaceEventHandler

ScreenSpaceEventHandler

open external class ScreenSpaceEventHandler(element: HTMLElement? = definedExternally)(source)

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 value - document

Constructors

ScreenSpaceEventHandler

constructor(element: HTMLElement? = definedExternally)

Types

Companion

external object Companion

MotionEvent

external interface MotionEvent

An Event that starts at one position and ends at another.

MotionEventCallback

typealias MotionEventCallback = (event: ScreenSpaceEventHandler.MotionEvent) -> Unit

PositionedEvent

external interface PositionedEvent

An Event that occurs at a single position on screen.

PositionedEventCallback

typealias PositionedEventCallback = (event: ScreenSpaceEventHandler.PositionedEvent) -> Unit

TwoPointEvent

external interface TwoPointEvent

An Event that occurs at a two positions on screen.

TwoPointEventCallback

typealias TwoPointEventCallback = (event: ScreenSpaceEventHandler.TwoPointEvent) -> Unit

TwoPointMotionEvent

external interface TwoPointMotionEvent

An Event that starts at a two positions on screen and moves to two other positions.

TwoPointMotionEventCallback

typealias TwoPointMotionEventCallback = (event: ScreenSpaceEventHandler.TwoPointMotionEvent) -> Unit

WheelEventCallback

typealias WheelEventCallback = (delta: Double) -> Unit

Functions

destroy

external fun destroy()

Removes listeners held by this object.

getInputAction

external fun getInputAction(type: ScreenSpaceEventType, modifiers: JsAny? = definedExternally): JsAny

Returns the function to be executed on an input event.

isDestroyed

external fun isDestroyed(): Boolean

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

removeInputAction

external fun removeInputAction(type: ScreenSpaceEventType, modifiers: JsAny? = definedExternally)

Removes the function to be executed on an input event.

setInputAction

external fun setInputAction(action: JsAny, type: ScreenSpaceEventType, modifiers: JsAny? = definedExternally)

Set a function to be executed on an input event.

ScreenSpaceEventHandler

Parameters

See also

Constructors

Types

Functions