new HomeButtonViewModel
The view model for HomeButton.
Parameters:
| Name | Type | Argument | Default | Description |
|---|---|---|---|---|
scene |
Scene | The scene instance to use. | ||
transitioner |
SceneTransitioner |
<optional> |
The scene transitioner instance to use. | |
ellipsoid |
Ellipsoid |
<optional> |
Ellipsoid.WGS84 | The ellipsoid to be viewed when in home position. |
flightDuration |
Number |
<optional> |
The duration of the camera flight in milliseconds |
Throws:
DeveloperError
: scene is required.
Members
-
command :Command
-
Gets the Command that is executed when the button is clicked.
-
ellipsoid :Ellipsoid
-
Gets the ellipsoid to be viewed when in home position.
-
flightDuration :Number
-
Gets or sets the the duration of the camera flight in milliseconds. A value of zero causes the camera to instantly switch to home view.
-
scene :Scene
-
Gets the scene to control.
-
sceneTransitioner :SceneTransitioner
-
Gets the scene transitioner being used by the scene. If a transitioner is assigned, any running morphs will be completed when the home button is pressed. The transitioner must be using the same Scene instance as the scene property.
-
tooltip :String
-
Gets or sets the tooltip. This property is observable.