main.cesium.VRButtonViewModel.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)
package cesium
/**
* The view model for [VRButton].
* @see Online Documentation
*
* @constructor
* @param [scene] The scene.
* @property [vrElement] The element or id to be placed into VR mode.
* Default value - `document.body`
* @see Online Documentation
*/
@JsName("\$cesium__VRButtonViewModel")
external class VRButtonViewModel(
scene: Scene,
var vrElement: org.w3c.dom.Element = definedExternally,
) {
/**
* Gets whether or not VR mode is active.
* @see Online Documentation
*/
var isVRMode: Boolean
/**
* Gets or sets whether or not VR functionality should be enabled.
* @see Online Documentation
*/
var isVREnabled: Boolean
/**
* Gets the tooltip. This property is observable.
* @see Online Documentation
*/
var tooltip: String
/**
* Gets the Command to toggle VR mode.
* @see Online Documentation
*/
var command: Command
/**
* @return true if the object has been destroyed, false otherwise.
* @see Online Documentation
*/
fun isDestroyed(): Boolean
/**
* Destroys the view model. Should be called to
* properly clean up the view model when it is no longer needed.
* @see Online Documentation
*/
fun destroy()
}