agi.foundation.cesium

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

Enum CesiumImageFormat

java.lang.Object

java.lang.Enum<CesiumImageFormat>

agi.foundation.cesium.CesiumImageFormat

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CesiumImageFormat>

public enum CesiumImageFormat
extends Enum<CesiumImageFormat>
implements Enumeration

The format of an image to be embedded in a CZML stream.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BMP The image is in bitmap (BMP) format.
GIF The image is in Graphics Interchange Format (GIF) format.
JPEG The image is in Joint Photographic Experts Group (JPEG) format.
PNG The image is in Portable Network Graphics (PNG) format.

Method Summary

Modifier and Type	Method and Description
static CesiumImageFormat	getDefault() Get the enum constant that is considered to be the default.
static CesiumImageFormat	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 CesiumImageFormat	valueOf(String name) Returns the enum constant of this type with the specified name.
static CesiumImageFormat[]	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

PNG

public static final CesiumImageFormat PNG

The image is in Portable Network Graphics (PNG) format.

JPEG

public static final CesiumImageFormat JPEG

The image is in Joint Photographic Experts Group (JPEG) format.

GIF

public static final CesiumImageFormat GIF

The image is in Graphics Interchange Format (GIF) format.

BMP

public static final CesiumImageFormat BMP

The image is in bitmap (BMP) format.

Method Detail

values

public static CesiumImageFormat[] 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 (CesiumImageFormat c : CesiumImageFormat.values())
    System.out.println(c);

Returns:

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

valueOf

public static CesiumImageFormat 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 CesiumImageFormat 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 CesiumImageFormat getDefault()

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

Returns:

The default enum constant.