agi.foundation.graphics.advanced

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

Enum ScreenOverlayPinningOrigin

java.lang.Object

java.lang.Enum<ScreenOverlayPinningOrigin>

agi.foundation.graphics.advanced.ScreenOverlayPinningOrigin

All Implemented Interfaces:

Enumeration, Serializable, Comparable<ScreenOverlayPinningOrigin>

public enum ScreenOverlayPinningOrigin
extends Enum<ScreenOverlayPinningOrigin>
implements Enumeration

Specifies the origin of the PinningPosition (get) of the screen overlay, as well as the direction of the horizontal and vertical axes for that pinning position. The pinning origin specifies the origin of the pinning position in the overlay's coordinate system.

Enum Constant Summary

Enum Constants

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

Method Summary

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

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

BOTTOM_CENTER

public static final ScreenOverlayPinningOrigin BOTTOM_CENTER

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

BOTTOM_RIGHT

public static final ScreenOverlayPinningOrigin BOTTOM_RIGHT

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

CENTER_LEFT

public static final ScreenOverlayPinningOrigin CENTER_LEFT

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

CENTER

public static final ScreenOverlayPinningOrigin CENTER

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

CENTER_RIGHT

public static final ScreenOverlayPinningOrigin CENTER_RIGHT

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

TOP_LEFT

public static final ScreenOverlayPinningOrigin TOP_LEFT

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

TOP_CENTER

public static final ScreenOverlayPinningOrigin TOP_CENTER

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

TOP_RIGHT

public static final ScreenOverlayPinningOrigin TOP_RIGHT

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

AUTOMATIC

public static final ScreenOverlayPinningOrigin AUTOMATIC

The pinning origin is automatically set to the origin of the overlay. For instance, if the origin of the overlay is ScreenOverlayOrigin.BottomLeft, the pinning origin will also be equivalent to ScreenOverlayPinningOrigin.BottomLeft.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.