edu.mines.jtk.mosaic
Enum PlotPanelPixels3.Orientation

java.lang.Object
  java.lang.Enum<PlotPanelPixels3.Orientation>
      edu.mines.jtk.mosaic.PlotPanelPixels3.Orientation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PlotPanelPixels3.Orientation>

Enclosing class:

PlotPanelPixels3

public static enum PlotPanelPixels3.Orientation
extends java.lang.Enum<PlotPanelPixels3.Orientation>

Orientations of the plot panel are defined by the orientation of the tile in the lower-left corner of the 2x2 mosaic. The four possible orientations are X1DOWN_X2RIGHT, X1DOWN_X3RIGHT, X1RIGHT_X2UP, and X1RIGHT_X3UP. The other two tiles are oriented so that they share axes with the lower-left tile.

The orientations of the x2 and x3 axes can be determined automatically from that of the x1 axis to minimize the size of the empty tile in the upper-right corner. The two possible orientations of the x1 axis are X1DOWN and X1RIGHT. If one of these is specified, then one of the other four orientations will automatically be chosen accordingly.

The default orientation is X1DOWN, which will result in either an X1DOWN_X2RIGHT or X1DOWN_X3RIGHT orientation being used.

Enum Constant Summary

X1DOWN

X1DOWN_X2RIGHT

X1DOWN_X3RIGHT

X1RIGHT

X1RIGHT_X2UP

X1RIGHT_X3UP

Method Summary

static PlotPanelPixels3.Orientation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PlotPanelPixels3.Orientation[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

X1DOWN

public static final PlotPanelPixels3.Orientation X1DOWN

X1DOWN_X2RIGHT

public static final PlotPanelPixels3.Orientation X1DOWN_X2RIGHT

X1DOWN_X3RIGHT

public static final PlotPanelPixels3.Orientation X1DOWN_X3RIGHT

X1RIGHT

public static final PlotPanelPixels3.Orientation X1RIGHT

X1RIGHT_X2UP

public static final PlotPanelPixels3.Orientation X1RIGHT_X2UP

X1RIGHT_X3UP

public static final PlotPanelPixels3.Orientation X1RIGHT_X3UP

Method Detail

values

public static final PlotPanelPixels3.Orientation[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(PlotPanelPixels3.Orientation c : PlotPanelPixels3.Orientation.values())
        System.out.println(c);

Returns:

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

valueOf

public static PlotPanelPixels3.Orientation 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