Direction (squidlib-util 3.0.6 API)

java.lang.Object
- java.lang.Enum<Direction>
- - squidpony.squidgrid.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>
```
public enum Direction
extends java.lang.Enum<Direction>
```
Represents the eight grid directions and the deltaX, deltaY values associated with those directions. The grid referenced has x positive to the right and y positive downwards on screen.

Enum Constant Summary

Enum Constants
Enum Constant and Description

DOWN

DOWN_LEFT

DOWN_RIGHT

LEFT

NONE

RIGHT

UP

UP_LEFT

UP_RIGHT

Enum Constants
Enum Constant and Description
`DOWN`
`DOWN_LEFT`
`DOWN_RIGHT`
`LEFT`
`NONE`
`RIGHT`
`UP`
`UP_LEFT`
`UP_RIGHT`

Field Summary

Fields
Modifier and Type	Field and Description
`static Direction[]`	`CARDINALS` An array which holds only the four cardinal directions.
`static Direction[]`	`CARDINALS_CLOCKWISE` An array which holds only the four cardinal directions in clockwise order.
`static Direction[]`	`CARDINALS_COUNTERCLOCKWISE` An array which holds only the four cardinal directions in counter-clockwise order.
`static Direction[]`	`CLOCKWISE` An array which holds all eight OUTWARDS directions in clockwise order.
`static Direction[]`	`COUNTERCLOCKWISE` An array which holds all eight OUTWARDS directions in counter-clockwise order.
`int`	`deltaX` The x coordinate difference for this direction.
`int`	`deltaY` The y coordinate difference for this direction.
`static Direction[]`	`DIAGONALS` An array which holds only the four diagonal directions.
`static Direction[]`	`OUTWARDS` An array which holds all eight OUTWARDS directions.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Direction`	`clockwise()` Returns the Direction one step clockwise including diagonals.
`Direction`	`counterClockwise()` Returns the Direction one step counterclockwise including diagonals.
`static Direction`	`getCardinalDirection(int x, int y)` Returns the direction that most closely matches the input.
`static Direction`	`getDirection(int x, int y)` Returns the direction that most closely matches the input.
`static Direction`	`getRoughDirection(int x, int y)` Gets an estimate at the correct direction that a position lies in given the distance towards it on the x and y axes.
`boolean`	`hasDown()`
`boolean`	`hasLeft()`
`boolean`	`hasRight()`
`boolean`	`hasUp()`
`boolean`	`isCardinal()`
`boolean`	`isDiagonal()`
`Direction`	`opposite()` Returns the direction directly opposite of this one.
`static Direction`	`toGoTo(Coord from, Coord to)`
`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
  - UP
```
public static final Direction UP
```
  - DOWN
```
public static final Direction DOWN
```
  - LEFT
```
public static final Direction LEFT
```
  - RIGHT
```
public static final Direction RIGHT
```
  - UP_LEFT
```
public static final Direction UP_LEFT
```
  - UP_RIGHT
```
public static final Direction UP_RIGHT
```
  - DOWN_LEFT
```
public static final Direction DOWN_LEFT
```
  - DOWN_RIGHT
```
public static final Direction DOWN_RIGHT
```
  - NONE
```
public static final Direction NONE
```
- Field Detail
  - CARDINALS
```
public static final Direction[] CARDINALS
```
    An array which holds only the four cardinal directions.
  - CARDINALS_CLOCKWISE
```
public static final Direction[] CARDINALS_CLOCKWISE
```
    An array which holds only the four cardinal directions in clockwise order.
  - CARDINALS_COUNTERCLOCKWISE
```
public static final Direction[] CARDINALS_COUNTERCLOCKWISE
```
    An array which holds only the four cardinal directions in counter-clockwise order.
  - DIAGONALS
```
public static final Direction[] DIAGONALS
```
    An array which holds only the four diagonal directions.
  - OUTWARDS
```
public static final Direction[] OUTWARDS
```
    An array which holds all eight OUTWARDS directions.
  - CLOCKWISE
```
public static final Direction[] CLOCKWISE
```
    An array which holds all eight OUTWARDS directions in clockwise order.
  - COUNTERCLOCKWISE
```
public static final Direction[] COUNTERCLOCKWISE
```
    An array which holds all eight OUTWARDS directions in counter-clockwise order.
  - deltaX
```
public final int deltaX
```
    The x coordinate difference for this direction.
  - deltaY
```
public final int deltaY
```
    The y coordinate difference for this direction.
- 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
  - getDirection
```
public static Direction getDirection(int x,
                                     int y)
```
    Returns the direction that most closely matches the input. This can be any direction, including cardinal and diagonal directions as well as NONE in the case that x and y are both 0.
    This can be used to get the primary intercardinal direction from an origin point to an event point, such as a mouse click on a grid. If the point given is exactly on a boundary between directions then the direction clockwise is returned.
    
    Parameters:
    
    x - the x position relative to the origin (0,0)
    
    y - the y position relative to the origin (0,0)
    
    Returns:
    
    the closest matching Direction enum, which may be NONE
  - getRoughDirection
```
public static Direction getRoughDirection(int x,
                                          int y)
```
    Gets an estimate at the correct direction that a position lies in given the distance towards it on the x and y axes. If x and y are both between -1 and 1 inclusive, this will always be accurate, and should be faster than getDirection(int, int) by avoiding trigonometry or any other math on doubles. If at least one of x or y is 0, then this will also be accurate and will produce either a cardinal direction or NONE if both are 0. If x and y are both non-zero, this will always produce a diagonal, even if a cardinal direction should be more accurate; this behavior may sometimes be desirable to detect when some position is even slightly off from a true cardinal direction.
    
    Parameters:
    
    x - the x position relative to the origin (0,0)
    
    y - the y position relative to the origin (0,0)
    
    Returns:
    
    the Direction that x,y lies in, roughly; will always be accurate for arguments between -1 and 1 inclusive
  - getCardinalDirection
```
public static Direction getCardinalDirection(int x,
                                             int y)
```
    Returns the direction that most closely matches the input. This can be any of the four cardinal directions as well as NONE in the case that x and y are both 0.
    This can be used to get the primary cardinal direction from an origin point to an event point, such as a mouse click on a grid. If the point given is directly diagonal then the direction clockwise is returned.
    This method returned an incorrect value for several years (the bug was found on April 28, 2020 but the method hadn't been modified for a long time), and other code in SquidLib had workarounds in use before the bug was fixed. The nature of the bug was simply that UP was returned when DOWN should have been, and vice versa; the workaround used in various places was to negate y. Now you should no longer have to negate y or treat it differently than x, and earlier code should account for the vertical axis being corrected.
    
    Parameters:
    
    x - the x position relative to the origin (0,0)
    
    y - the y position relative to the origin (0,0)
    
    Returns:
    
    the closest matching cardinal Direction enum, which may also be NONE
  - toGoTo
```
public static Direction toGoTo(Coord from,
                               Coord to)
```
    Parameters:
    
    from - The starting point.
    
    to - The desired point to reach.
    
    Returns:
    
    The direction to follow to go from from to to. It can be cardinal or diagonal.
  - clockwise
```
public Direction clockwise()
```
    Returns the Direction one step clockwise including diagonals. If considering only Cardinal directions, calling this twice will get the next clockwise cardinal direction.
    
    Returns:
  - counterClockwise
```
public Direction counterClockwise()
```
    Returns the Direction one step counterclockwise including diagonals. If considering only Cardinal directions, calling this twice will get the next counterclockwise cardinal direction.
    
    Returns:
  - opposite
```
public Direction opposite()
```
    Returns the direction directly opposite of this one.
    
    Returns:
  - isDiagonal
```
public boolean isDiagonal()
```
    Returns:
    
    Whether this is a diagonal move.
  - isCardinal
```
public boolean isCardinal()
```
    Returns:
    
    Whether this is a cardinal-direction move.
  - hasUp
```
public boolean hasUp()
```
    Returns:
    
    true if this has an upward component.
  - hasDown
```
public boolean hasDown()
```
    Returns:
    
    true if this has a downward component.
  - hasLeft
```
public boolean hasLeft()
```
    Returns:
    
    true if this has a left component.
  - hasRight
```
public boolean hasRight()
```
    Returns:
    
    true if this has a right component.

Enum Direction

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

UP

DOWN

LEFT

RIGHT

UP_LEFT

UP_RIGHT

DOWN_LEFT

DOWN_RIGHT

NONE

Field Detail

CARDINALS

CARDINALS_CLOCKWISE

CARDINALS_COUNTERCLOCKWISE

DIAGONALS

OUTWARDS

CLOCKWISE

COUNTERCLOCKWISE

deltaX

deltaY

Method Detail

values

valueOf

getDirection

getRoughDirection

getCardinalDirection

toGoTo

clockwise

counterClockwise

opposite

isDiagonal

isCardinal

hasUp

hasDown

hasLeft

hasRight