net.talvi.puffinplot.plots

Enum Direction

java.lang.Object

java.lang.Enum<Direction>

net.talvi.puffinplot.plots.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>

public enum Direction
extends java.lang.Enum<Direction>

A representation of a two-dimensional perpendicular direction. That is, left, right, up, or down, or the equivalent compass point.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN down or south
LEFT left or west
RIGHT right or east
UP up or north

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCompassDir()
java.lang.String	getLetter()
Direction	opposite()
static Direction	safeDirection(java.awt.geom.Point2D centre, java.util.Collection<java.awt.geom.Point2D> others) Given a "central" point and a collection of "peripheral" points, safeDirection attempts to find a quadrant containing no peripheral points.
static Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Direction[]	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

RIGHT

public static final Direction RIGHT

right or east

UP

public static final Direction UP

up or north

LEFT

public static final Direction LEFT

left or west

DOWN

public static final Direction DOWN

down or south

Method Detail

values

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

Returns:

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

valueOf

public static Direction 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

opposite

public Direction opposite()

Returns:

the opposite direction to this direction

getCompassDir

public java.lang.String getCompassDir()

Returns:

a one-letter string (N, S, E, W) corresponding to this direction's compass point

getLetter

public java.lang.String getLetter()

Returns:

a one-letter string (U, D, L, R) corresponding to this direction

safeDirection

public static Direction safeDirection(java.awt.geom.Point2D centre,
                                      java.util.Collection<java.awt.geom.Point2D> others)

Given a "central" point and a collection of "peripheral" points, safeDirection attempts to find a quadrant containing no peripheral points. It is intended for use with label placement: if safeDirection is called with a point's two (joined) neighbours as the "others", it will return a direction where a label can be placed without overlapping the line. While this method can be called with any number of "others", a good solution cannot be guaranteed when more than two other points are provided.

Parameters:

centre - a central point

others - other points

Returns:

the direction of a quadrant (as seen from the central point) which, if possible, contains none of the other points