agi.foundation.graphics

(agi.foundation.graphics-2024r3.jar)

Enum KmlNetworkLinkViewRefreshMode

java.lang.Object

java.lang.Enum<KmlNetworkLinkViewRefreshMode>

agi.foundation.graphics.KmlNetworkLinkViewRefreshMode

All Implemented Interfaces:

Enumeration, Serializable, Comparable<KmlNetworkLinkViewRefreshMode>

public enum KmlNetworkLinkViewRefreshMode
extends Enum<KmlNetworkLinkViewRefreshMode>
implements Enumeration

Defines the options available for a KmlNetworkLink's ViewRefreshMode property.

Enum Constant Summary

Enum Constants

Enum Constant and Description
NEVER Do not refresh the network link when the camera's view changes.
ON_REGION Refreshes the network link when the region associated with this link becomes active.
ON_REQUEST Only refresh the network link when it is explicitly refreshed by calling the KmlNetworkLink.refresh() method.
ON_STOP Refresh the network link after camera view movement stops for the duration specified by ViewRefreshTime (get).

Method Summary

Modifier and Type	Method and Description
static KmlNetworkLinkViewRefreshMode	getDefault() Get the enum constant that is considered to be the default.
static KmlNetworkLinkViewRefreshMode	getFromValue(int value) Get the enum constant that is associated with the given numeric value.
int	getValue() Get the numeric value associated with this enum constant.
static KmlNetworkLinkViewRefreshMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static KmlNetworkLinkViewRefreshMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEVER

public static final KmlNetworkLinkViewRefreshMode NEVER

Do not refresh the network link when the camera's view changes.

ON_REQUEST

public static final KmlNetworkLinkViewRefreshMode ON_REQUEST

Only refresh the network link when it is explicitly refreshed by calling the KmlNetworkLink.refresh() method.

ON_STOP

public static final KmlNetworkLinkViewRefreshMode ON_STOP

Refresh the network link after camera view movement stops for the duration specified by ViewRefreshTime (get).

ON_REGION

public static final KmlNetworkLinkViewRefreshMode ON_REGION

Refreshes the network link when the region associated with this link becomes active.

Method Detail

values

public static KmlNetworkLinkViewRefreshMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KmlNetworkLinkViewRefreshMode c : KmlNetworkLinkViewRefreshMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static KmlNetworkLinkViewRefreshMode valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

Get the numeric value associated with this enum constant.

Specified by:

getValue in interface Enumeration

Returns:

A numeric value.

getFromValue

@Nonnull
public static KmlNetworkLinkViewRefreshMode getFromValue(int value)

Get the enum constant that is associated with the given numeric value.

Parameters:

value - a numeric value.

Returns:

The enum constant associated with value.

getDefault

@Nonnull
public static KmlNetworkLinkViewRefreshMode getDefault()

Get the enum constant that is considered to be the default.

Returns:

The default enum constant.