main.cesium.EventHelper.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* A convenience object that simplifies the common pattern of attaching event listeners
* to several events, then removing all those listeners at once later, for example, in
* a destroy method.
* ```
* var helper = new EventHelper();
*
* helper.add(someObject.event, listener1, this);
* helper.add(otherObject.event, listener2, this);
*
* // later...
* helper.removeAll();
* ```
* @see Online Documentation
*/
@JsName("\$cesium__EventHelper")
external class EventHelper {
/**
* Adds a listener to an event, and records the registration to be cleaned up later.
* @param [event] The event to attach to.
* @param [listener] The function to be executed when the event is raised.
* @param [scope] An optional object scope to serve as the `this`
* pointer in which the listener function will execute.
* @return A function that will remove this event listener when invoked.
* @see Online Documentation
*/
fun add(
event: Event,
listener: () -> Unit,
scope: Any? = definedExternally,
): RemoveCallback
/**
* Unregisters all previously added listeners.
* @see Online Documentation
*/
fun removeAll()
}