battlecode.common

Class MapLocation

java.lang.Object

battlecode.common.MapLocation

All Implemented Interfaces:

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

public final class MapLocation
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable<MapLocation>

This class is an immutable representation of two-dimensional coordinates in the battlecode world.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
float	x The x-coordinate.
float	y The y-coordinate.

Constructor Summary

Constructors

Constructor and Description
MapLocation(float x, float y) Creates a new MapLocation representing the location with the given coordinates.

Method Summary

Modifier and Type	Method and Description
MapLocation	add(Direction direction) Returns a new MapLocation object representing a location one unit in distance from this one in the given direction.
MapLocation	add(Direction direction, float dist) Returns a new MapLocation object representing a location dist units away from this one in the given direction.
MapLocation	add(float radians) Returns a new MapLocation object representing a location one unit in distance from this one in the given direction represented in radians.
MapLocation	add(float radians, float dist) Returns a new MapLocation object representing a location dist units away from this one in the given direction represented in radians.
int	compareTo(MapLocation other) A comparison function for MapLocations.
Direction	directionTo(MapLocation location) Returns the Direction from this MapLocation to location.
float	distanceSquaredTo(MapLocation location) Computes the squared distance from this location to the specified location.
float	distanceTo(MapLocation location) Computes the Euclidean distance from this location to the specified location.
static boolean	doCirclesCollide(MapLocation center1, float radius1, MapLocation center2, float radius2) Checks where two given circles collide at any point.
boolean	equals(java.lang.Object obj) Two MapLocations are regarded as equal iff their coordinates are the same.
int	hashCode()
boolean	isWithinBulletSightRadius(RobotInfo robot) Determines whether this location is within the bullet sight radius of the given robot.
boolean	isWithinDistance(MapLocation location, float dist) Determines whether this location is within a specified distance from target location.
boolean	isWithinSensorRadius(RobotInfo robot) Determines whether this location is within the sensor radius of the given robot.
boolean	isWithinStrideDistance(RobotInfo robot) Determines whether this location is within one stride of the given robot.
MapLocation	subtract(Direction direction) Returns a new MapLocation object representing a location one unit in distance from this one in the opposite direction of the given direction.
MapLocation	subtract(Direction direction, float dist) Returns a new MapLocation object representing a location dist units in distance from this one in the opposite direction of the given direction.
MapLocation	subtract(float radians) Returns a new MapLocation object representing a location one unit in distance from this one in the opposite direction of the given direction represented in radians.
MapLocation	subtract(float radians, float dist) Returns a new MapLocation object representing a location dist units in distance from this one in the opposite direction of the given direction represented in radians.
java.lang.String	toString()
MapLocation	translate(float dx, float dy) Returns a new MapLocation object translated from this location by a fixed amount.
static MapLocation	valueOf(java.lang.String s)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

x

public final float x

The x-coordinate.

y

public final float y

The y-coordinate.

Constructor Detail

MapLocation

public MapLocation(float x,
                   float y)

Creates a new MapLocation representing the location with the given coordinates.

Parameters:

x - the x-coordinate of the location

y - the y-coordinate of the location

Method Detail

compareTo

public int compareTo(MapLocation other)

A comparison function for MapLocations. Smaller x values go first, with ties broken by smaller y values.

Specified by:

compareTo in interface java.lang.Comparable<MapLocation>

Parameters:

other - the MapLocation to compare to.

Returns:

whether this MapLocation goes before the other one.

Bytecode cost:

2

equals

public boolean equals(java.lang.Object obj)

Two MapLocations are regarded as equal iff their coordinates are the same.

Overrides:

equals in class java.lang.Object

Bytecode cost:

2

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

Bytecode cost:

2

valueOf

public static MapLocation valueOf(java.lang.String s)

doCirclesCollide

public static boolean doCirclesCollide(MapLocation center1,
                                       float radius1,
                                       MapLocation center2,
                                       float radius2)

Checks where two given circles collide at any point.

Parameters:

center1 - the center of the first circle

radius1 - the radius of the first circle

center2 - the center of the second circle

radius2 - the radius of the second circle

Returns:

true if the given circles collide at any point, false otherwise.

Bytecode cost:

4

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Bytecode cost:

2

distanceTo

public final float distanceTo(MapLocation location)

Computes the Euclidean distance from this location to the specified location.

Parameters:

location - the location to compute the distance to

Returns:

the distance to the given location

Bytecode cost:

2

distanceSquaredTo

public final float distanceSquaredTo(MapLocation location)

Computes the squared distance from this location to the specified location.

Parameters:

location - the location to compute the squared distance to

Returns:

the squared distance to the given location

Bytecode cost:

2

isWithinDistance

public final boolean isWithinDistance(MapLocation location,
                                      float dist)

Determines whether this location is within a specified distance from target location.

Parameters:

location - the location to test

dist - the distance for the location to be within

Returns:

true if the given location is within dist to this one; false otherwise

Bytecode cost:

2

isWithinStrideDistance

public final boolean isWithinStrideDistance(RobotInfo robot)

Determines whether this location is within one stride of the given robot.

Parameters:

robot - the robot to test

Returns:

true if this location is within one stride of the given robot; false otherwise

Bytecode cost:

2

isWithinSensorRadius

public final boolean isWithinSensorRadius(RobotInfo robot)

Determines whether this location is within the sensor radius of the given robot.

Parameters:

robot - the robot to test

Returns:

true if this location is within the robot's sensor radius, false otherwise

Bytecode cost:

2

isWithinBulletSightRadius

public final boolean isWithinBulletSightRadius(RobotInfo robot)

Determines whether this location is within the bullet sight radius of the given robot.

Parameters:

robot - the robot to test

Returns:

true if this location is within robot's bullet sight radius, false otherwise

Bytecode cost:

2

directionTo

public final Direction directionTo(MapLocation location)

Returns the Direction from this MapLocation to location. If location is null then the return value is null. If location equals this location then the return value is null.

Parameters:

location - The location to which the Direction will be calculated

Returns:

The Direction to location from this MapLocation.

Bytecode cost:

2

add

public final MapLocation add(Direction direction)

Returns a new MapLocation object representing a location one unit in distance from this one in the given direction.

Parameters:

direction - the direction to add to this location

Returns:

a MapLocation for the location one unit in distance in the given direction.

Bytecode cost:

2

add

public final MapLocation add(float radians)

Returns a new MapLocation object representing a location one unit in distance from this one in the given direction represented in radians.

Parameters:

radians - the radians of the direction to add to this location, note that 0 radians points right

Returns:

a MapLocation for the location one unit in distance in the given direction.

Bytecode cost:

2

add

public final MapLocation add(Direction direction,
                             float dist)

Returns a new MapLocation object representing a location dist units away from this one in the given direction.

Parameters:

direction - the direction to add to this location

dist - the distance the locations should be apart

Returns:

a MapLocation for the location dist away from this location in the given direction.

Bytecode cost:

2

add

public final MapLocation add(float radians,
                             float dist)

Returns a new MapLocation object representing a location dist units away from this one in the given direction represented in radians.

Parameters:

radians - the radians of the direction to add to this location, note that 0 radians points right

dist - the distance the locations should be apart

Returns:

a MapLocation for the location dist away from this location in the given direction.

Bytecode cost:

2

subtract

public final MapLocation subtract(Direction direction)

Returns a new MapLocation object representing a location one unit in distance from this one in the opposite direction of the given direction.

Parameters:

direction - the direction to subtract from this location

Returns:

a MapLocation for the location one unit in distance in the opposite of the given direction.

Bytecode cost:

2

subtract

public final MapLocation subtract(float radians)

Returns a new MapLocation object representing a location one unit in distance from this one in the opposite direction of the given direction represented in radians.

Parameters:

radians - the radians of the direction to subtract from this location, note that 0 radians points right

Returns:

a MapLocation for the location one unit in distance in the given direction.

Bytecode cost:

2

subtract

public final MapLocation subtract(Direction direction,
                                  float dist)

Returns a new MapLocation object representing a location dist units in distance from this one in the opposite direction of the given direction.

Parameters:

direction - the direction to subtract from this location

dist - the distance the locations should be apart

Returns:

a MapLocation for the location dist away from this location in the opposite of the given direction.

Bytecode cost:

2

subtract

public final MapLocation subtract(float radians,
                                  float dist)

Returns a new MapLocation object representing a location dist units in distance from this one in the opposite direction of the given direction represented in radians.

Parameters:

radians - the radians of the direction to subtract from this location, note that 0 radians points right

dist - the distance the locations should be apart

Returns:

a MapLocation for the location one unit in distance in the given direction.

Bytecode cost:

2

translate

public final MapLocation translate(float dx,
                                   float dy)

Returns a new MapLocation object translated from this location by a fixed amount.

Parameters:

dx - the amount to translate in the x direction

dy - the amount to translate in the y direction

Returns:

the new MapLocation that is the translated version of the original.

Bytecode cost:

2