agi.foundation.graphics.advanced

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

Enum ScreenOverlayOrigin

java.lang.Object

java.lang.Enum<ScreenOverlayOrigin>

agi.foundation.graphics.advanced.ScreenOverlayOrigin

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ScreenOverlayOrigin>

public enum ScreenOverlayOrigin
extends Enum<ScreenOverlayOrigin>
implements Enumeration

Specifies the origin of a screen overlay, as well as the direction of the horizontal and vertical axes. The origin specifies both the origin in the parent overlay's coordinate system and the origin within the overlay itself that is positioned.

See Also:

Screen Overlays topic - Origin

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_CENTER When the X and Y position are both set to 0, this value places the bottom edge of the overlay at its parent's bottom edge and the center of the overlay is horizontally centered within its parent.
BOTTOM_LEFT When the X and Y position are both set to 0, this value places the bottom, left corner of the overlay in its parent's bottom, left corner.
BOTTOM_RIGHT When the X and Y position are both set to 0, this value places the bottom, right corner of the overlay in its parent's bottom, right corner.
CENTER When the X and Y position are both set to 0, this value places the center of the overlay at its parent's center.
CENTER_LEFT When the X and Y position are both set to 0, this value places the left edge of the overlay at its parent's left edge and the center of the overlay is vertically centered within its parent.
CENTER_RIGHT When the X and Y position are both set to 0, this value places the right edge of the overlay at its parent's right edge and the center of the overlay is vertically centered within its parent.
TOP_CENTER When the X and Y position are both set to 0, this value places the top edge of the overlay at its parent's top edge and the center of the overlay is horizontally centered within its parent.
TOP_LEFT When the X and Y position are both set to 0, this value places the top, left corner of the overlay in its parent's top, left corner.
TOP_RIGHT When the X and Y position are both set to 0, this value places the top, right corner of the overlay in its parent's top, right corner.

Method Summary

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

When the X and Y position are both set to 0, this value places the bottom, left corner of the overlay in its parent's bottom, left corner. Increasing X values move the overlay to the right and increasing Y values move it up.

BOTTOM_CENTER

public static final ScreenOverlayOrigin BOTTOM_CENTER

When the X and Y position are both set to 0, this value places the bottom edge of the overlay at its parent's bottom edge and the center of the overlay is horizontally centered within its parent. Increasing X values move the overlay to the right and increasing Y values move it up.

BOTTOM_RIGHT

public static final ScreenOverlayOrigin BOTTOM_RIGHT

When the X and Y position are both set to 0, this value places the bottom, right corner of the overlay in its parent's bottom, right corner. Increasing X values move the overlay to the left and increasing Y values move it up.

CENTER_LEFT

public static final ScreenOverlayOrigin CENTER_LEFT

When the X and Y position are both set to 0, this value places the left edge of the overlay at its parent's left edge and the center of the overlay is vertically centered within its parent. Increasing X values move the overlay to the right and increasing Y values move it up.

CENTER

public static final ScreenOverlayOrigin CENTER

When the X and Y position are both set to 0, this value places the center of the overlay at its parent's center. Increasing X values move the overlay to the right and increasing Y values move it up.

CENTER_RIGHT

public static final ScreenOverlayOrigin CENTER_RIGHT

When the X and Y position are both set to 0, this value places the right edge of the overlay at its parent's right edge and the center of the overlay is vertically centered within its parent. Increasing X values move the overlay to the left and increasing Y values move it up.

TOP_LEFT

public static final ScreenOverlayOrigin TOP_LEFT

When the X and Y position are both set to 0, this value places the top, left corner of the overlay in its parent's top, left corner. Increasing X values move the overlay to the right and increasing Y values move it down.

TOP_CENTER

public static final ScreenOverlayOrigin TOP_CENTER

When the X and Y position are both set to 0, this value places the top edge of the overlay at its parent's top edge and the center of the overlay is horizontally centered within its parent. Increasing X values move the overlay to the right and increasing Y values move it down.

TOP_RIGHT

public static final ScreenOverlayOrigin TOP_RIGHT

When the X and Y position are both set to 0, this value places the top, right corner of the overlay in its parent's top, right corner. Increasing X values move the overlay to the left and increasing Y values move it down.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.