Direction (Battlecode 2017)

java.lang.Object
- battlecode.common.Direction

```
public final class Direction
extends java.lang.Object
```
This class is an immutable representation of a direction in the battlecode world.

Field Summary

Fields
Modifier and Type	Field and Description
`static Direction`	`EAST` Direction that represents pointing east (right on screen).
`static Direction`	`NORTH` Direction that represents pointing north (up on screen).
`float`	`radians` The radians at which this direction is facing based off of the unit circle; i.e.
`static Direction`	`SOUTH` Direction that represents pointing south (down on screen).
`static Direction`	`WEST` Direction that represents pointing west (left on screen).

Constructor Summary

Constructors
Constructor and Description
`Direction(float radians)`
`Direction(float dx, float dy)` Creates a new Direction instance to represent the direction in which the vector created by dx and dy points.
`Direction(MapLocation start, MapLocation finish)` Creates a new Direction instance to represent the direction in which the vector from start to finish points.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`float`	`degreesBetween(Direction other)` Computes the angle between the given direction and this direction in degrees.
`boolean`	`equals(Direction other, float epsilon)` If two Directions are equal to each other, with an error range epsilon radians.
`boolean`	`equals(java.lang.Object other)` If another Direction equals this one.
`float`	`getAngleDegrees()` Computes the angle in degrees at which this direction faces.
`float`	`getDeltaX(float travelDist)` Computes the signed distance traveled on the x-axis when traveling travelDist units in this Direction.
`float`	`getDeltaY(float travelDist)` Computes the signed distance traveled on the y-axis when traveling travelDist units in this Direction.
`static Direction`	`getEast()` Creates a instance of Direction that represents pointing east (right on screen).
`static Direction`	`getNorth()` Creates a instance of Direction that represents pointing north (up on screen).
`static Direction`	`getSouth()` Creates a instance of Direction that represents pointing south (down on screen).
`static Direction`	`getWest()` Creates a instance of Direction that represents pointing west (left on screen).
`int`	`hashCode()`
`Direction`	`opposite()` Computes the direction opposite this one.
`float`	`radiansBetween(Direction other)` Computes the angle between the given direction and this direction in radians.
`Direction`	`rotateLeftDegrees(float angleDegrees)` Computes the direction angleDegrees to the left (counter-clockwise) of this one.
`Direction`	`rotateLeftRads(float angleRads)` Computes the direction angleRads (radians) to the left (counter-clockwise) of this one.
`Direction`	`rotateRightDegrees(float angleDegrees)` Computes the direction angleDegrees to the right (clockwise) of this one.
`Direction`	`rotateRightRads(float angleRads)` Computes the direction angleRads (radians) to the right (clockwise) of this one.
`java.lang.String`	`toString()`

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

- Field Detail
  - NORTH
```
public static final Direction NORTH
```
    Direction that represents pointing north (up on screen).
  - EAST
```
public static final Direction EAST
```
    Direction that represents pointing east (right on screen).
  - SOUTH
```
public static final Direction SOUTH
```
    Direction that represents pointing south (down on screen).
  - WEST
```
public static final Direction WEST
```
    Direction that represents pointing west (left on screen).
  - radians
```
public final float radians
```
    The radians at which this direction is facing based off of the unit circle; i.e. facing right would have 0.0 radians, up would have PI/2 radians, etc. Note: radians = (-Math.PI, Math.PI]
- Constructor Detail
  - Direction
```
public Direction(float radians)
```
    Parameters:
    
    radians - the radians at which you wish this direction to represent based off of the unit circle
  - Direction
```
public Direction(float dx,
                 float dy)
```
    Creates a new Direction instance to represent the direction in which the vector created by dx and dy points. Requires dx or dy to be non-zero.
    
    Parameters:
    
    dx - the x component of the vector
    
    dy - the y component of the vector
  - Direction
```
public Direction(MapLocation start,
                 MapLocation finish)
```
    Creates a new Direction instance to represent the direction in which the vector from start to finish points. Requires start and finish to not be the same location.
    
    Parameters:
    
    start - the starting point of the vector
    
    finish - the ending point of the vector
- Method Detail
  - equals
```
public boolean equals(java.lang.Object other)
```
    If another Direction equals this one. Realistically, you should never want to use this due to floating point rounding errors.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    
    other - Another Direction
    
    Returns:
    
    If the two Directions are equal
  - equals
```
public boolean equals(Direction other,
                      float epsilon)
```
    If two Directions are equal to each other, with an error range epsilon radians.
    
    Parameters:
    
    other - Another Direction.
    
    epsilon - Amount of error (in radians) to allow in the comparison
    
    Returns:
    
    If the two Directions are equal within error
  - getEast
```
public static Direction getEast()
```
    Creates a instance of Direction that represents pointing east (right on screen).
    
    Returns:
    
    Direction instance facing east.
    
    Bytecode cost:
    1
  - getNorth
```
public static Direction getNorth()
```
    Creates a instance of Direction that represents pointing north (up on screen).
    
    Returns:
    
    Direction instance facing north.
    
    Bytecode cost:
    1
  - getWest
```
public static Direction getWest()
```
    Creates a instance of Direction that represents pointing west (left on screen).
    
    Returns:
    
    Direction instance facing west.
    
    Bytecode cost:
    1
  - getSouth
```
public static Direction getSouth()
```
    Creates a instance of Direction that represents pointing south (down on screen).
    
    Returns:
    
    Direction instance facing south.
    
    Bytecode cost:
    1
  - getDeltaX
```
public float getDeltaX(float travelDist)
```
    Computes the signed distance traveled on the x-axis when traveling travelDist units in this Direction.
    
    Parameters:
    
    travelDist - the total distance to travel
    
    Returns:
    
    the signed distance traveled on the x-axis.
    
    Bytecode cost:
    1
  - getDeltaY
```
public float getDeltaY(float travelDist)
```
    Computes the signed distance traveled on the y-axis when traveling travelDist units in this Direction.
    
    Parameters:
    
    travelDist - the total distance to travel
    
    Returns:
    
    the signed distance traveled on the x-axis.
    
    Bytecode cost:
    1
  - getAngleDegrees
```
public float getAngleDegrees()
```
    Computes the angle in degrees at which this direction faces.
    
    Returns:
    
    the angle in degrees this direction faces.
    
    Bytecode cost:
    1
  - opposite
```
public Direction opposite()
```
    Computes the direction opposite this one.
    
    Returns:
    
    the direction pointing in the opposite direction.
    
    Bytecode cost:
    1
  - rotateLeftDegrees
```
public Direction rotateLeftDegrees(float angleDegrees)
```
    Computes the direction angleDegrees to the left (counter-clockwise) of this one.
    
    Parameters:
    
    angleDegrees - number of degrees to rotate
    
    Returns:
    
    the direction angleDegrees degrees left of this one.
    
    Bytecode cost:
    1
  - rotateRightDegrees
```
public Direction rotateRightDegrees(float angleDegrees)
```
    Computes the direction angleDegrees to the right (clockwise) of this one.
    
    Parameters:
    
    angleDegrees - number of degrees to rotate
    
    Returns:
    
    the direction angleDegrees right of this one.
    
    Bytecode cost:
    1
  - rotateLeftRads
```
public Direction rotateLeftRads(float angleRads)
```
    Computes the direction angleRads (radians) to the left (counter-clockwise) of this one.
    
    Parameters:
    
    angleRads - number of radians to rotate
    
    Returns:
    
    the direction angleRads left of this one.
    
    Bytecode cost:
    1
  - rotateRightRads
```
public Direction rotateRightRads(float angleRads)
```
    Computes the direction angleRads (radians) to the right (clockwise) of this one.
    
    Parameters:
    
    angleRads - number of radians to rotate
    
    Returns:
    
    the direction angleRads right of this one.
    
    Bytecode cost:
    1
  - radiansBetween
```
public float radiansBetween(Direction other)
```
    Computes the angle between the given direction and this direction in radians. Returned value will be in the range (-Math.PI, Math.PI]. Positive values mean 'other' is to the left, negative values mean 'other' is to the right.
    
    Parameters:
    
    other - the direction you wish to find the angle between
    
    Returns:
    
    the angle in radians between this direction and the given direction in the range of (-Math.PI, Math.PI].
    
    Bytecode cost:
    1
  - degreesBetween
```
public float degreesBetween(Direction other)
```
    Computes the angle between the given direction and this direction in degrees. Returned value will be in the range (-180,180].
    
    Parameters:
    
    other - the direction you wish to find the angle between
    
    Returns:
    
    the angle in degrees between this direction and the given direction in the range of (-180,180].
    
    Bytecode cost:
    1
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class Direction

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NORTH

EAST

SOUTH

WEST

radians

Constructor Detail

Direction

Direction

Direction

Method Detail

equals

equals

getEast

getNorth

getWest

getSouth

getDeltaX

getDeltaY

getAngleDegrees

opposite

rotateLeftDegrees

rotateRightDegrees

rotateLeftRads

rotateRightRads

radiansBetween

degreesBetween

hashCode

toString