org.cesiumjs.cs.widgets

Class HomeButton

java.lang.Object

org.cesiumjs.cs.widgets.HomeButton

@JsType(isNative=true,
        namespace="Cesium",
        name="HomeButton")
public class HomeButton
extends Object

A single button widget for returning to the default camera view of the current scene.

Field Summary

Fields

Modifier and Type	Field and Description
com.google.gwt.dom.client.Element	container Gets the parent container.
HomeButtonViewModel	viewModel Gets the view model.

Constructor Summary

Constructors

Constructor and Description
HomeButton(com.google.gwt.dom.client.Element container, Scene scene, Number duration) A single button widget for returning to the default camera view of the current scene.

Method Summary

Modifier and Type	Method and Description
void	destroy() Destroys the widget.
boolean	isDestroyed()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

container

@JsProperty
public com.google.gwt.dom.client.Element container

Gets the parent container.

viewModel

@JsProperty
public HomeButtonViewModel viewModel

Gets the view model.

Constructor Detail

HomeButton

@JsConstructor
public HomeButton(com.google.gwt.dom.client.Element container,
                                 Scene scene,
                                 Number duration)

A single button widget for returning to the default camera view of the current scene.

Parameters:

container - The DOM element or ID that will contain the widget.

scene - The Scene instance to use.

duration - The time, in seconds, it takes to complete the camera flight home. Optional.

Method Detail

destroy

@JsMethod
public void destroy()

Destroys the widget. Should be called if permanently removing the widget from the layout.

isDestroyed

@JsMethod
public boolean isDestroyed()

Returns:

true if the object has been destroyed, false otherwise.