org.pepsoft.worldpainter.layers.groundcover

Enum GroundCoverLayer.LayerAnchor

java.lang.Object

java.lang.Enum<GroundCoverLayer.LayerAnchor>

org.pepsoft.worldpainter.layers.groundcover.GroundCoverLayer.LayerAnchor

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GroundCoverLayer.LayerAnchor>

Enclosing class:

GroundCoverLayer

public static enum GroundCoverLayer.LayerAnchor
extends java.lang.Enum<GroundCoverLayer.LayerAnchor>

The anchor relative to which the layers of a layered material should be placed. Only applies to layered materials.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BEDROCK Layers relative to height 0.
TERRAIN The bottom of the layers should be aligned with the height of the terrain.
TOP_OF_LAYER The top of the layers should be aligned with the top of the ground cover layer.

Method Summary

Modifier and Type	Method and Description
static GroundCoverLayer.LayerAnchor	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GroundCoverLayer.LayerAnchor[]	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

BEDROCK

public static final GroundCoverLayer.LayerAnchor BEDROCK

Layers relative to height 0. This is the default and previously the only option.

TERRAIN

public static final GroundCoverLayer.LayerAnchor TERRAIN

The bottom of the layers should be aligned with the height of the terrain.

TOP_OF_LAYER

public static final GroundCoverLayer.LayerAnchor TOP_OF_LAYER

The top of the layers should be aligned with the top of the ground cover layer.

Method Detail

values

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

Returns:

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

valueOf

public static GroundCoverLayer.LayerAnchor valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null