agi.foundation.graphics.advanced

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

Enum MarkerBatchSizeSource

java.lang.Object

java.lang.Enum<MarkerBatchSizeSource>

agi.foundation.graphics.advanced.MarkerBatchSizeSource

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MarkerBatchSizeSource>

public enum MarkerBatchSizeSource
extends Enum<MarkerBatchSizeSource>
implements Enumeration

Determines which marker batch property is used to size each marker 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
FROM_TEXTURE The size of each marker is the same as the size of its texture.
USER_DEFINED The size of each marker in the marker batch is user defined.

Method Summary

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

FROM_TEXTURE

public static final MarkerBatchSizeSource FROM_TEXTURE

The size of each marker is the same as the size of its texture. If the marker is not textured, the user defined size is used instead.

USER_DEFINED

public static final MarkerBatchSizeSource USER_DEFINED

The size of each marker in the marker batch is user defined. Either all markers have the same size (MarkerBatchPrimitive.Size (get)) or each marker has a user defined size (MarkerBatchPrimitiveOptionalParameters.SetSizes).

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.