main.cesium.HomeButton.kt Maven / Gradle / Ivy
The newest version!
// Automatically generated - do not modify!
@file:JsModule("cesium")
@file:Suppress(
"EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)
package cesium
/**
* A single button widget for returning to the default camera view of the current scene.
* @see Online Documentation
*
* @constructor
* @property [container] The DOM element that will contain the widget.
* @param [scene] The Scene instance to use.
* @param [duration] The time, in seconds, it takes to complete the camera flight home.
* @see Online Documentation
*/
external class HomeButton(
var container: org.w3c.dom.Element,
scene: Scene,
duration: Double? = definedExternally,
) {
/**
* Gets the view model.
* @see Online Documentation
*/
var viewModel: HomeButtonViewModel
/**
* @return true if the object has been destroyed, false otherwise.
* @see Online Documentation
*/
fun isDestroyed(): Boolean
/**
* Destroys the widget. Should be called if permanently
* removing the widget from layout.
* @see Online Documentation
*/
fun destroy()
}