Direction2D

All Implemented Interfaces:

java.io.Serializable , kotlin.Comparable
```
public enum Direction2D
extends Enum<Direction2D>
                    
```
Cardinal and intercardinal directions indicating a movement.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final Direction2D`	`flipped`
`private final Direction2D`	`flippedX`
`private final Direction2D`	`flippedY`
`private final Integer`	`x`
`private final Integer`	`y`
`private final String`	`name`
`private final Integer`	`ordinal`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description
`NORTHWEST`
`SOUTHWEST`
`SOUTHEAST`
`NORTHEAST`
`WEST`
`EAST`
`SOUTH`
`NORTH`
`NONE`

Method Summary

Modifier and Type	Method	Description
`final Direction2D`	`plus(Direction2D other)`	Sums with a direction.
`final Direction2D`	`minus(Direction2D other)`	Subtracts with a direction.
`final Point`	`times(Integer scalar)`	Multiplies by a scalar.
`final Boolean`	`contains(Direction2D other)`	Returns whether this direction contains other.
`final Direction2D`	`getFlipped()`
`final Direction2D`	`getFlippedX()`
`final Direction2D`	`getFlippedY()`
`final Integer`	`getX()`
`final Integer`	`getY()`
`final String`	`getName()`
`final Integer`	`getOrdinal()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - plus
```
 final Direction2D plus(Direction2D other)
```
    Sums with a direction.
  - minus
```
 final Direction2D minus(Direction2D other)
```
    Subtracts with a direction.
  - times
```
 final Point times(Integer scalar)
```
    Multiplies by a scalar.
  - contains
```
 final Boolean contains(Direction2D other)
```
    Returns whether this direction contains other. Specifically, a direction "D" contains another if D Direction2D.plus equals D. For example, NORTHEAST contains NORTH and EAST, but not WEST. All directions contain NONE. NONE contains only NONE.
  - getFlipped
```
 final Direction2D getFlipped()
```
  - getFlippedX
```
 final Direction2D getFlippedX()
```
  - getFlippedY
```
 final Direction2D getFlippedY()
```
  - getX
```
 final Integer getX()
```
  - getY
```
 final Integer getY()
```
  - getName
```
 final String getName()
```
  - getOrdinal
```
 final Integer getOrdinal()
```