agi.foundation.graphics.advanced

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

Enum Origin

java.lang.Object

java.lang.Enum<Origin>

agi.foundation.graphics.advanced.Origin

All Implemented Interfaces:

Enumeration, Serializable, Comparable<Origin>

public enum Origin
extends Enum<Origin>
implements Enumeration

Vertical and horizontal origin.

See Also:

MarkerBatchPrimitive

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_CENTER The object's origin is its bottom, center point.
BOTTOM_LEFT The object's origin is its bottom, left corner.
BOTTOM_RIGHT The object's origin is its bottom, right corner.
CENTER The object's origin is its center.
CENTER_LEFT The object's origin is its center, left point.
CENTER_RIGHT The object's origin is its center, right point.
TOP_CENTER The object's origin is its top, center point.
TOP_LEFT The object's origin is its top, left corner.
TOP_RIGHT The object's origin is its top, right corner.

Method Summary

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

public static final Origin BOTTOM_LEFT

The object's origin is its bottom, left corner.

BOTTOM_CENTER

public static final Origin BOTTOM_CENTER

The object's origin is its bottom, center point.

BOTTOM_RIGHT

public static final Origin BOTTOM_RIGHT

The object's origin is its bottom, right corner.

CENTER_LEFT

public static final Origin CENTER_LEFT

The object's origin is its center, left point.

CENTER

public static final Origin CENTER

The object's origin is its center.

CENTER_RIGHT

public static final Origin CENTER_RIGHT

The object's origin is its center, right point.

TOP_LEFT

public static final Origin TOP_LEFT

The object's origin is its top, left corner.

TOP_CENTER

public static final Origin TOP_CENTER

The object's origin is its top, center point.

TOP_RIGHT

public static final Origin TOP_RIGHT

The object's origin is its top, right corner.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.