agi.foundation.graphics.imaging

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

Enum RasterOrientation

java.lang.Object

java.lang.Enum<RasterOrientation>

agi.foundation.graphics.imaging.RasterOrientation

All Implemented Interfaces:

Enumeration, Serializable, Comparable<RasterOrientation>

public enum RasterOrientation
extends Enum<RasterOrientation>
implements Enumeration

The vertical orientation of the raster.

See Also:

RasterAttributes, Rasters and Filtering topic

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM_TO_TOP The raster has a bottom to top orientation.
TOP_TO_BOTTOM The raster has a top to bottom orientation.

Method Summary

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

TOP_TO_BOTTOM

public static final RasterOrientation TOP_TO_BOTTOM

The raster has a top to bottom orientation.

BOTTOM_TO_TOP

public static final RasterOrientation BOTTOM_TO_TOP

The raster has a bottom to top orientation.

Method Detail

values

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

Returns:

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

valueOf

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

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

Returns:

The default enum constant.