agi.foundation.graphics.advanced

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

Enum MarkerBatchUnit

java.lang.Object

java.lang.Enum<MarkerBatchUnit>

agi.foundation.graphics.advanced.MarkerBatchUnit

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MarkerBatchUnit>

public enum MarkerBatchUnit
extends Enum<MarkerBatchUnit>
implements Enumeration

The unit for marker sizes in a marker batch.

See Also:

Marker Batch Primitive topic, MarkerBatchPrimitive, MarkerBatchPrimitive.Size (get), MarkerBatchPrimitiveOptionalParameters.SetSizes

Enum Constant Summary

Enum Constants

Enum Constant and Description
METERS The size of a marker is defined in meters.
PIXELS The size of a marker is defined in pixels.

Method Summary

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

PIXELS

public static final MarkerBatchUnit PIXELS

The size of a marker is defined in pixels. As the camera zooms in and out the size of the marker doesn't change.

METERS

public static final MarkerBatchUnit METERS

The size of a marker is defined in meters.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.