main.cesium.ProjectionPicker.kt Maven / Gradle / Ivy

Go to download
// Automatically generated - do not modify!

@file:JsModule("cesium")
@file:JsNonModule

@file:Suppress(
    "EXTERNAL_CLASS_CONSTRUCTOR_PROPERTY_PARAMETER",
)

package cesium

/**
 * The ProjectionPicker is a single button widget for switching between perspective and orthographic projections.
 * ```
 * // In HTML head, include a link to the ProjectionPicker.css stylesheet,
 * // and in the body, include: 
 * // Note: This code assumes you already have a Scene instance.
 *
 * const projectionPicker = new ProjectionPicker('projectionPickerContainer', scene);
 * ```
 * @see Online Documentation
 *
 * @constructor
 * @property [container] The DOM element that will contain the widget.
 * @param [scene] The Scene instance to use.
 * @see Online Documentation
 */
external class ProjectionPicker(
    var container: org.w3c.dom.Element,
    scene: Scene,
) {
    /**
     * Gets the view model.
     * @see Online Documentation
     */
    var viewModel: ProjectionPickerViewModel

    /**
     * @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()
}