SceneTransitioner

SceneTransitioner

new SceneTransitioner

Transitions the scene among available modes. The transitions can either be instantaneous or animated.

Parameters:
Name Type Argument Default Description
scene Scene The scene to be transitioned.
ellipsoid Ellipsoid <optional>
Ellipsoid.WGS84 The ellipsoid to be transitioned.
Throws:
DeveloperError : scene is required.
See:

Members

completeMorphOnUserInput :Boolean

Gets or sets whether or not to instantly complete the transition animation on user input.

morphDuration :Number

Gets or sets the amount of time, in milliseconds, for transition animations to complete.

onTransitionComplete :Event

Gets the event fired at the completion of a transition.

onTransitionStart :Event

Gets the event fired at the beginning of a transition.

Methods

completeMorph

Instantly completes an active transition.

Throws:
DeveloperError : completeMorph can only be called during a transition.

destroy

Once an object is destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception. Therefore, assign the return value (undefined) to the object as done in the example.

Throws:
DeveloperError : This object was destroyed, i.e., destroy() was called.
Example
transitioner = transitioner && transitioner.destroy();

getEllipsoid

Returns:
Ellipsoid The ellipsoid to be transitioned.

getScene

Returns:
Scene The scene to be transitioned.

isDestroyed

Returns true if this object was destroyed; otherwise, false.

If this object was destroyed, it should not be used; calling any function other than isDestroyed will result in a DeveloperError exception.

Returns:
Boolean true if this object was destroyed; otherwise, false.

morphTo2D

Asynchronously transitions the scene to 2D.

morphTo3D

Asynchronously transitions the scene to 3D.

morphToColumbusView

Asynchronously transitions the scene to Columbus View.

to2D

Instantly transitions the scene to 2D.

to3D

Instantly transitions the scene to 3D.

toColumbusView

Instantly transitions the scene to Columbus View.