Direction

java.lang.Object
- java.lang.Enum<Direction>
- - aic2024.user.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Direction>
```
public enum Direction
extends java.lang.Enum<Direction>
```
Class that contains all the directions in which a unit can move.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`EAST` East direction.
`NORTH` North direction.
`NORTHEAST` Northeast direction.
`NORTHWEST` Northwest direction.
`SOUTH` South direction.
`SOUTHEAST` Southeast direction.
`SOUTHWEST` Southwest direction.
`WEST` West direction.
`ZERO` Zero direction.

Field Summary

Fields
Modifier and Type Field and Description

int dx
x-coordinate of this direction.

int dy
y-coordinate of this direction.

Fields
Modifier and Type	Field and Description
`int`	`dx` x-coordinate of this direction.
`int`	`dy` y-coordinate of this direction.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Direction`	`getDirection(int dx, int dy)` Computes the direction that moves the closest from (0,0) to (dx,dy).
`boolean`	`isEqual(Direction dir)` Returns if this direction is equal to target direction.
`float`	`length()` Returns the euclidean norm of this direction.
`Direction`	`opposite()` Returns the opposite direction.
`Direction`	`rotateLeft()` Returns the direction obtained by rotating this direction 45 degrees to the left.
`Direction`	`rotateRight()` Returns the direction obtained by rotating this direction 45 degrees to the right.
`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
  - NORTH
```
public static final Direction NORTH
```
    North direction.
  - NORTHWEST
```
public static final Direction NORTHWEST
```
    Northwest direction.
  - WEST
```
public static final Direction WEST
```
    West direction.
  - SOUTHWEST
```
public static final Direction SOUTHWEST
```
    Southwest direction.
  - SOUTH
```
public static final Direction SOUTH
```
    South direction.
  - SOUTHEAST
```
public static final Direction SOUTHEAST
```
    Southeast direction.
  - EAST
```
public static final Direction EAST
```
    East direction.
  - NORTHEAST
```
public static final Direction NORTHEAST
```
    Northeast direction.
  - ZERO
```
public static final Direction ZERO
```
    Zero direction.
- Field Detail
  - dx
```
public final int dx
```
    x-coordinate of this direction.
  - dy
```
public final int dy
```
    y-coordinate of 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
  - isEqual
```
public boolean isEqual(Direction dir)
```
    Returns if this direction is equal to target direction. It costs 1 energy.
    
    Parameters:
    
    dir - Given direction.
    
    Returns:
    
    if this direction is equal to target direction.
  - rotateLeft
```
public Direction rotateLeft()
```
    Returns the direction obtained by rotating this direction 45 degrees to the left. It costs 1 energy.
    
    Returns:
    
    the direction obtained by rotating this direction 45 degrees to the left.
  - rotateRight
```
public Direction rotateRight()
```
    Returns the direction obtained by rotating this direction 45 degrees to the right. It costs 1 energy.
    
    Returns:
    
    the direction obtained by rotating this direction 45 degrees to the right.
  - opposite
```
public Direction opposite()
```
    Returns the opposite direction. It costs 1 energy.
    
    Returns:
    
    the opposite direction.
  - length
```
public float length()
```
    Returns the euclidean norm of this direction. It costs 2 energy.
    
    Returns:
    
    the euclidean norm of this direction.
  - getDirection
```
public static Direction getDirection(int dx,
                                     int dy)
```
    Computes the direction that moves the closest from (0,0) to (dx,dy). It costs 5 energy.
    
    Parameters:
    
    dx - x-coordinate of the target
    
    dy - y-coordinate of the target
    
    Returns:
    
    the direction that moves the closest from (0,0) to (dx,dy).

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

NORTH

NORTHWEST

WEST

SOUTHWEST

SOUTH

SOUTHEAST

EAST

NORTHEAST

ZERO

Field Detail

dx

dy

Method Detail

values

valueOf

isEqual

rotateLeft

rotateRight

opposite

length

getDirection