BWTA

java.lang.Object
- bwta.BWTA

```
public class BWTA
extends java.lang.Object
```
BWTA class wraps the functionality of BWTA library

Constructor Summary

Constructors
Constructor and Description

BWTA()

Constructors
Constructor and Description
`BWTA()`

Method Summary

Methods
Modifier and Type	Method and Description
`static void`	`analyze()` Before any other global functions can be called, the map must first be analyzed.
`static java.util.List<BaseLocation>`	`getBaseLocations()` Returns the set of base locations on the map.
`static double`	`getGroundDistance(TilePosition start, TilePosition end)` Returns the ground distance between the two given tile positions.
`static java.util.List<Chokepoint>`	`getChokepoints()` Returns the set of chokepoints in the map.
`static BaseLocation`	`getNearestBaseLocation(int x, int y)` Returns the nearest base location(in ground/walking distance).
`static BaseLocation`	`getNearestBaseLocation(Position position)` Returns the nearest base location(in ground/walking distance).
`static BaseLocation`	`getNearestBaseLocation(TilePosition tileposition)` Returns the nearest base location(in ground/walking distance).
`static Chokepoint`	`getNearestChokepoint(int x, int y)` Returns the nearest chokepoint (in ground/walking distance).
`static Chokepoint`	`getNearestChokepoint(Position position)` Returns the nearest chokepoint (in ground/walking distance).
`static Chokepoint`	`getNearestChokepoint(TilePosition tileposition)` Returns the nearest chokepoint (in ground/walking distance).
`static Polygon`	`getNearestUnwalkablePolygon(int x, int y)` Returns the nearest unwalkable polygon.
`static Polygon`	`getNearestUnwalkablePolygon(TilePosition tileposition)` Returns the nearest unwalkable polygon.
`static Position`	`getNearestUnwalkablePosition(Position position)` Returns the nearest position that is on the boundary of an unwalkable polygon, or border of the map.
`static Region`	`getRegion(int x, int y)` Returns the region that the tile position is inside.
`static Region`	`getRegion(Position position)` Returns the region that the tile position is inside.
`static Region`	`getRegion(TilePosition tileposition)` Returns the region that the tile position is inside.
`static java.util.List<Region>`	`getRegions()` Returns the set of regions in the map.
`static BaseLocation`	`getStartLocation(Player player)` Given a pointer to a Player object, this function returns a pointer to the player's starting base location.
`static java.util.List<BaseLocation>`	`getStartLocations()` Returns the set of base locations that are start locations.
`static java.util.List<Polygon>`	`getUnwalkablePolygons()` Returns the set of unwalkable polygons.
`static boolean`	`isConnected(int x1, int y1, int x2, int y2)` Returns true if there exists a static path between the two given tile positions.
`static boolean`	`isConnected(TilePosition a, TilePosition b)` Returns true if there exists a static path between the two given tile positions.
`static void`	`readMap()` Reads the contents of the map in to BWTA.

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

- Constructor Detail
  - BWTA
```
public BWTA()
```
- Method Detail
  - readMap
```
public static void readMap()
```
    Reads the contents of the map in to BWTA. This was added so analyze() can be executed in another thread.
  - analyze
```
public static void analyze()
```
    Before any other global functions can be called, the map must first be analyzed. Analyzing a starcraft map can take a long time, depending on your computer, so BWTA also automatically saves the results to a file when it is done. When you call analyze on the same map, BWTA will see that the results file for that map already exists, and load the results from file, rather than re-analyze the map.
  - getRegions
```
public static java.util.List<Region> getRegions()
```
    Returns the set of regions in the map.
  - getChokepoints
```
public static java.util.List<Chokepoint> getChokepoints()
```
    Returns the set of chokepoints in the map.
  - getBaseLocations
```
public static java.util.List<BaseLocation> getBaseLocations()
```
    Returns the set of base locations on the map.
  - getStartLocations
```
public static java.util.List<BaseLocation> getStartLocations()
```
    Returns the set of base locations that are start locations.
  - getUnwalkablePolygons
```
public static java.util.List<Polygon> getUnwalkablePolygons()
```
    Returns the set of unwalkable polygons.
  - getStartLocation
```
public static BaseLocation getStartLocation(Player player)
```
    Given a pointer to a Player object, this function returns a pointer to the player's starting base location.
  - getRegion
```
public static Region getRegion(int x,
               int y)
```
    Returns the region that the tile position is inside. Returns NULL if the tile position is not inside any valid region.
  - getRegion
```
public static Region getRegion(TilePosition tileposition)
```
    Returns the region that the tile position is inside. Returns NULL if the tile position is not inside any valid region.
  - getRegion
```
public static Region getRegion(Position position)
```
    Returns the region that the tile position is inside. Returns NULL if the tile position is not inside any valid region.
  - getNearestChokepoint
```
public static Chokepoint getNearestChokepoint(int x,
                              int y)
```
    Returns the nearest chokepoint (in ground/walking distance). Returns NULL if no chokepoint is reachable from the given tile position (such as in an island component with no chokepoints). The Position version of this function has walk tile accuracy, while the other two have build tile accuracy.
  - getNearestChokepoint
```
public static Chokepoint getNearestChokepoint(TilePosition tileposition)
```
    Returns the nearest chokepoint (in ground/walking distance). Returns NULL if no chokepoint is reachable from the given tile position (such as in an island component with no chokepoints). The Position version of this function has walk tile accuracy, while the other two have build tile accuracy.
  - getNearestChokepoint
```
public static Chokepoint getNearestChokepoint(Position position)
```
    Returns the nearest chokepoint (in ground/walking distance). Returns NULL if no chokepoint is reachable from the given tile position (such as in an island component with no chokepoints). The Position version of this function has walk tile accuracy, while the other two have build tile accuracy.
  - getNearestBaseLocation
```
public static BaseLocation getNearestBaseLocation(int x,
                                  int y)
```
    Returns the nearest base location(in ground/walking distance). Returns NULL if no base location is reachable from the given tile position. The Position version of this function has walk tile accuracy, while the other two have build tile accuracy.
  - getNearestBaseLocation
```
public static BaseLocation getNearestBaseLocation(TilePosition tileposition)
```
    Returns the nearest base location(in ground/walking distance). Returns NULL if no base location is reachable from the given tile position. The Position version of this function has walk tile accuracy, while the other two have build tile accuracy.
  - getNearestBaseLocation
```
public static BaseLocation getNearestBaseLocation(Position position)
```
    Returns the nearest base location(in ground/walking distance). Returns NULL if no base location is reachable from the given tile position. The Position version of this function has walk tile accuracy, while the other two have build tile accuracy.
  - getNearestUnwalkablePolygon
```
public static Polygon getNearestUnwalkablePolygon(int x,
                                  int y)
```
    Returns the nearest unwalkable polygon. Note: The border of the map is not considered an unwalkable polygon.
  - getNearestUnwalkablePolygon
```
public static Polygon getNearestUnwalkablePolygon(TilePosition tileposition)
```
    Returns the nearest unwalkable polygon. Note: The border of the map is not considered an unwalkable polygon.
  - getNearestUnwalkablePosition
```
public static Position getNearestUnwalkablePosition(Position position)
```
    Returns the nearest position that is on the boundary of an unwalkable polygon, or border of the map.
  - isConnected
```
public static boolean isConnected(int x1,
                  int y1,
                  int x2,
                  int y2)
```
    Returns true if there exists a static path between the two given tile positions.
  - isConnected
```
public static boolean isConnected(TilePosition a,
                  TilePosition b)
```
    Returns true if there exists a static path between the two given tile positions.
  - getGroundDistance
```
public static double getGroundDistance(TilePosition start,
                       TilePosition end)
```
    Returns the ground distance between the two given tile positions.

Class BWTA

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BWTA

Method Detail

readMap

analyze

getRegions

getChokepoints

getBaseLocations

getStartLocations

getUnwalkablePolygons

getStartLocation

getRegion

getRegion

getRegion

getNearestChokepoint

getNearestChokepoint

getNearestChokepoint

getNearestBaseLocation

getNearestBaseLocation

getNearestBaseLocation

getNearestUnwalkablePolygon

getNearestUnwalkablePolygon

getNearestUnwalkablePosition

isConnected

isConnected

getGroundDistance