org.pepsoft.worldpainter.layers.tunnel

Enum TunnelLayer.LayerMode

java.lang.Object

java.lang.Enum<TunnelLayer.LayerMode>

org.pepsoft.worldpainter.layers.tunnel.TunnelLayer.LayerMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TunnelLayer.LayerMode>

Enclosing class:

TunnelLayer

public static enum TunnelLayer.LayerMode
extends java.lang.Enum<TunnelLayer.LayerMode>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAVE In cave mode this layer will carve out a void dictated by the floor and roof level settings and apply the floor features to the terrain at the bottom of the void and the roof features, if any, to the terrain above the void, if any.
FLOATING In floating mode this layer will not carve out a void but place terrain at the level of the floor dimension, to the depth dictated by the roof level settings.

Method Summary

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

CAVE

public static final TunnelLayer.LayerMode CAVE

In cave mode this layer will carve out a void dictated by the floor and roof level settings and apply the floor features to the terrain at the bottom of the void and the roof features, if any, to the terrain above the void, if any.

FLOATING

public static final TunnelLayer.LayerMode FLOATING

In floating mode this layer will not carve out a void but place terrain at the level of the floor dimension, to the depth dictated by the roof level settings. It will apply the floor features to the top of the terrain and the roof features, if any, to the bottom of the terrain. In this mode the layer must always have a floor dimension, since it dictates the height of the floor. TODO: explore non-dimension floor level modes?

Method Detail

values

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

Returns:

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

valueOf

public static TunnelLayer.LayerMode 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