agi.foundation.cesium

(agi.foundation.cesium-2023r2.jar)

Enum CesiumVerticalOrigin

java.lang.Object

java.lang.Enum<CesiumVerticalOrigin>

agi.foundation.cesium.CesiumVerticalOrigin

All Implemented Interfaces:

Enumeration, Serializable, Comparable<CesiumVerticalOrigin>

public enum CesiumVerticalOrigin
extends Enum<CesiumVerticalOrigin>
implements Enumeration

The vertical origin of an item relative to its position.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BASELINE If the object contains text, the origin is at the baseline of the text, otherwise the origin is at the bottom of the object.
BOTTOM The bottom of the item is located at the position.
CENTER The item is at the vertical center between CesiumVerticalOrigin.BASELINE and CesiumVerticalOrigin.TOP.
TOP The top of the item is located at the position.

Method Summary

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

BOTTOM

public static final CesiumVerticalOrigin BOTTOM

The bottom of the item is located at the position.

CENTER

public static final CesiumVerticalOrigin CENTER

The item is at the vertical center between CesiumVerticalOrigin.BASELINE and CesiumVerticalOrigin.TOP.

TOP

public static final CesiumVerticalOrigin TOP

The top of the item is located at the position.

BASELINE

public static final CesiumVerticalOrigin BASELINE

If the object contains text, the origin is at the baseline of the text, otherwise the origin is at the bottom of the object.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.