agi.foundation.graphics.advanced

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

Enum MarkerBatchSortOrder

java.lang.Object

java.lang.Enum<MarkerBatchSortOrder>

agi.foundation.graphics.advanced.MarkerBatchSortOrder

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MarkerBatchSortOrder>

public enum MarkerBatchSortOrder
extends Enum<MarkerBatchSortOrder>
implements Enumeration

The order in which markers in a marker batch are sorted before rendering.

See Also:

Marker Batch Primitive topic, MarkerBatchPrimitive

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK_TO_FRONT The markers are sorted in back to front order before rendering.
BY_TEXTURE The markers are sorted by texture.
FRONT_TO_BACK The markers are sorted in front to back order before rendering.

Method Summary

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

BACK_TO_FRONT

public static final MarkerBatchSortOrder BACK_TO_FRONT

The markers are sorted in back to front order before rendering. For overlapping translucent markers, this enables correct blending results. This may not perform as well as ByTexture, since the CPU has to sort the markers when the camera moves or a marker changes position.

FRONT_TO_BACK

public static final MarkerBatchSortOrder FRONT_TO_BACK

The markers are sorted in front to back order before rendering. For overlapping opaque markers, this can enable the GPU to quickly eliminate markers that are hidden behind other markers. In many cases, this may not perform as well as ByTexture, since the CPU has to sort the markers when the camera moves or a marker changes position.

BY_TEXTURE

public static final MarkerBatchSortOrder BY_TEXTURE

The markers are sorted by texture. This minimizes costly texture changes during rendering and does not require resorting when the camera moves or a marker changes position.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.