agi.foundation.graphics.advanced

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

Enum MaintainAspectRatio

java.lang.Object

java.lang.Enum<MaintainAspectRatio>

agi.foundation.graphics.advanced.MaintainAspectRatio

All Implemented Interfaces:

Enumeration, Serializable, Comparable<MaintainAspectRatio>

public enum MaintainAspectRatio
extends Enum<MaintainAspectRatio>
implements Enumeration

Specifies whether the aspect ratio of a texture will be maintained during sizing of a screen overlay.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HEIGHT The aspect ratio of the texture is maintained based on the Height (get) property of the screen overlay.
NONE The aspect ratio of the texture is not maintained during sizing of the screen overlay.
WIDTH The aspect ratio of the texture is maintained based on the Width (get) property of the screen overlay.

Method Summary

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

NONE

public static final MaintainAspectRatio NONE

The aspect ratio of the texture is not maintained during sizing of the screen overlay.

WIDTH

public static final MaintainAspectRatio WIDTH

The aspect ratio of the texture is maintained based on the Width (get) property of the screen overlay. When used, the Height (get) property is ignored and the height is automatically calculated based on the aspect ratio of the texture and the overlay's Width (get) property.

HEIGHT

public static final MaintainAspectRatio HEIGHT

The aspect ratio of the texture is maintained based on the Height (get) property of the screen overlay. When used, the Width (get) property is ignored and the width is automatically calculated based on the aspect ratio of the texture and the overlay's Height (get) property.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.