Module com.esri.arcgisruntime

Package com.esri.arcgisruntime.ogc.kml

Enum Class KmlTourStatus

java.lang.Object

java.lang.Enum<KmlTourStatus>

com.esri.arcgisruntime.ogc.kml.KmlTourStatus

All Implemented Interfaces:

Serializable, Comparable<KmlTourStatus>, Constable

public enum KmlTourStatus
extends Enum<KmlTourStatus>

KML tour execution status.

Since:

100.5.0

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COMPLETED	State of tour when it is completed in a SceneView.
INITIALIZED	State of the tour when it is associated with a KmlTourController and the tour is ready to be executed in a SceneView.
INITIALIZING	State of the tour when it is associated with a KmlTourController.
NOT_INITIALIZED	The KML tour is not initialized.
PAUSED	State of the tour when it is paused in a SceneView.
PLAYING	State of the tour when it is being played in a SceneView.

Method Summary

Modifier and Type	Method	Description
static KmlTourStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static KmlTourStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_INITIALIZED

public static final KmlTourStatus NOT_INITIALIZED

The KML tour is not initialized. State of the tour after the tour is created. This is the default status.

Set the tour on a tour controller to initialize it. Also, this event is raised when a tour is reset.

Since:

100.5.0

INITIALIZING

public static final KmlTourStatus INITIALIZING

State of the tour when it is associated with a KmlTourController.

This event is raised as soon as a KML tour is set on a tour controller.

Since:

100.5.0

INITIALIZED

public static final KmlTourStatus INITIALIZED

State of the tour when it is associated with a KmlTourController and the tour is ready to be executed in a SceneView.

This event is raised when a KML tour is successfully initialized. If initialization fails, the status is set to not initialized.

Since:

100.5.0

PLAYING

public static final KmlTourStatus PLAYING

State of the tour when it is being played in a SceneView.

This event is raised when a KML tour starts playing.

Since:

100.5.0

PAUSED

public static final KmlTourStatus PAUSED

State of the tour when it is paused in a SceneView.

This event is raised when a KML tour is paused.

Since:

100.5.0

COMPLETED

public static final KmlTourStatus COMPLETED

State of tour when it is completed in a SceneView.

This event is raised when a KML tour is completed.

Since:

100.5.0

Method Details

values

public static KmlTourStatus[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static KmlTourStatus valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null