agi.foundation.graphics

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

Enum PolylineType

java.lang.Object

java.lang.Enum<PolylineType>

agi.foundation.graphics.PolylineType

All Implemented Interfaces:

Enumeration, Serializable, Comparable<PolylineType>

public enum PolylineType
extends Enum<PolylineType>
implements Enumeration

Describes how to interpret positions defining a polyline.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LINE_STRIP After the first position, each additional position defines a line segment from the previous position to the current position.
LINES Every two positions define a line segment.
POINTS Lines are drawn as points.

Method Summary

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

LINES

public static final PolylineType LINES

Every two positions define a line segment. Line segments are not required to be connected to each other.

LINE_STRIP

public static final PolylineType LINE_STRIP

After the first position, each additional position defines a line segment from the previous position to the current position.

POINTS

public static final PolylineType POINTS

Lines are drawn as points.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.