AreaImpl (BWAPI4J API)

java.lang.Object
- bwem.area.AreaImpl

All Implemented Interfaces:: Area

Direct Known Subclasses:: AreaInitializerImpl

public abstract class AreaImpl
extends java.lang.Object
implements Area

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.util.List<Area>`	`accessibleNeighbors`
`protected java.util.List<Base>`	`bases`
`protected TilePosition`	`bottomRight`
`protected int`	`buildableTileCount`
`protected java.util.List<ChokePoint>`	`chokePoints`
`protected java.util.Map<Area,java.util.List<ChokePoint>>`	`chokePointsByArea`
`protected java.util.List<Geyser>`	`geysers`
`protected GroupId`	`groupId`
`protected Altitude`	`highestAltitude`
`protected int`	`highGroundTileCount`
`protected java.util.List<Mineral>`	`minerals`
`protected int`	`tileCount`
`protected TilePosition`	`topLeft`
`protected int`	`veryHighGroundTileCount`

Constructor Summary

Constructors
Modifier Constructor and Description

protected AreaImpl(AreaId areaId, WalkPosition top, int miniTileCount)

Constructors
Modifier	Constructor and Description
`protected`	`AreaImpl(AreaId areaId, WalkPosition top, int miniTileCount)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object object)`
`java.util.List<Area>`	`getAccessibleNeighbors()` Returns the accessible neighboring Areas.
`java.util.List<Base>`	`getBases()` Returns the Bases contained in this Area.
`TilePosition`	`getBottomRight()` Returns the bottom right position of the bounding box of this area.
`TilePosition`	`getBoundingBoxSize()` Returns the bounding box size of this area.
`java.util.List<ChokePoint>`	`getChokePoints()` Returns the ChokePoints between this Area and the neighboring ones.
`java.util.List<ChokePoint>`	`getChokePoints(Area area)` Returns the ChokePoints between this Area and the specified area.
`java.util.Map<Area,java.util.List<ChokePoint>>`	`getChokePointsByArea()` Returns the ChokePoints of this Area grouped by neighboring Areas. - Note: if there are no neighboring Areas, than an empty set is returned.
`java.util.List<Geyser>`	`getGeysers()` Returns the Geysers contained in this Area.
`GroupId`	`getGroupId()` - Unique id > 0 of the group of Areas which are accessible from this Area.
`Altitude`	`getHighestAltitude()` Returns the highest altitude observed in this area.
`int`	`getHighGroundPercentage()` Returns the percentage of high ground tiles in this area.
`AreaId`	`getId()` - Unique id > 0 of this Area.
`int`	`getLowGroundPercentage()` Returns the percentage of low ground tiles in this area.
`java.util.List<Mineral>`	`getMinerals()` Returns the Minerals contained in this Area.
`int`	`getSize()` Returns the number of MiniTiles in this area.
`WalkPosition`	`getTop()` Alias for `Area.getWalkPositionWithHighestAltitude()`
`TilePosition`	`getTopLeft()` Returns the top left position of the bounding box of this area.
`int`	`getVeryHighGroundPercentage()` Returns the percentage of very high ground tiles in this area.
`WalkPosition`	`getWalkPositionWithHighestAltitude()` Returns the position of the MiniTile with the highest altitude value.
`int`	`hashCode()`
`boolean`	`isAccessibleFrom(Area area)` Returns whether this Area is accessible from the specified area, that is, if they share the same GroupId().
`void`	`onMineralDestroyed(Mineral mineral)`

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

- Field Detail
  - groupId
```
protected GroupId groupId
```
  - highestAltitude
```
protected Altitude highestAltitude
```
  - topLeft
```
protected TilePosition topLeft
```
  - bottomRight
```
protected TilePosition bottomRight
```
  - tileCount
```
protected int tileCount
```
  - buildableTileCount
```
protected int buildableTileCount
```
  - highGroundTileCount
```
protected int highGroundTileCount
```
  - veryHighGroundTileCount
```
protected int veryHighGroundTileCount
```
  - chokePointsByArea
```
protected final java.util.Map<Area,java.util.List<ChokePoint>> chokePointsByArea
```
  - accessibleNeighbors
```
protected final java.util.List<Area> accessibleNeighbors
```
  - chokePoints
```
protected final java.util.List<ChokePoint> chokePoints
```
  - minerals
```
protected final java.util.List<Mineral> minerals
```
  - geysers
```
protected final java.util.List<Geyser> geysers
```
  - bases
```
protected final java.util.List<Base> bases
```
- Constructor Detail
  - AreaImpl
```
protected AreaImpl(AreaId areaId,
                   WalkPosition top,
                   int miniTileCount)
```
- Method Detail
  - getId
```
public AreaId getId()
```
    Description copied from interface: Area
    
    - Unique id > 0 of this Area. Range = 1.. Map::Areas().size()
    - this == Map::GetArea(id())
    - id() == Map::GetMiniTile(w).AreaId() for each walkable MiniTile w in this Area.
    - Area::ids are guaranteed to remain unchanged.
    
    Specified by:
    
    getId in interface Area
  - getGroupId
```
public GroupId getGroupId()
```
    Description copied from interface: Area
    
    - Unique id > 0 of the group of Areas which are accessible from this Area.
    - For each pair (a, b) of Areas: a->GroupId() == b->GroupId() <==> a->AccessibleFrom(b)
    - A groupId uniquely identifies a maximum set of mutually accessible Areas, that is, in the absence of blocking ChokePoints, a continent.
    
    Specified by:
    
    getGroupId in interface Area
  - getTopLeft
```
public TilePosition getTopLeft()
```
    Description copied from interface: Area
    
    Returns the top left position of the bounding box of this area.
    
    Specified by:
    
    getTopLeft in interface Area
  - getBottomRight
```
public TilePosition getBottomRight()
```
    Description copied from interface: Area
    
    Returns the bottom right position of the bounding box of this area.
    
    Specified by:
    
    getBottomRight in interface Area
  - getBoundingBoxSize
```
public TilePosition getBoundingBoxSize()
```
    Description copied from interface: Area
    
    Returns the bounding box size of this area. The size is equal to (bottom right) subtract (top left) plus (1).
    
    Specified by:
    
    getBoundingBoxSize in interface Area
  - getWalkPositionWithHighestAltitude
```
public WalkPosition getWalkPositionWithHighestAltitude()
```
    Description copied from interface: Area
    
    Returns the position of the MiniTile with the highest altitude value.
    
    Specified by:
    
    getWalkPositionWithHighestAltitude in interface Area
  - getTop
```
public WalkPosition getTop()
```
    Description copied from interface: Area
    
    Alias for Area.getWalkPositionWithHighestAltitude()
    
    Specified by:
    
    getTop in interface Area
  - getHighestAltitude
```
public Altitude getHighestAltitude()
```
    Description copied from interface: Area
    
    Returns the highest altitude observed in this area.
    
    Specified by:
    
    getHighestAltitude in interface Area
  - getSize
```
public int getSize()
```
    Description copied from interface: Area
    
    Returns the number of MiniTiles in this area. This most accurately defines the size of this area.
    
    Specified by:
    
    getSize in interface Area
  - getLowGroundPercentage
```
public int getLowGroundPercentage()
```
    Description copied from interface: Area
    
    Returns the percentage of low ground tiles in this area.
    
    Specified by:
    
    getLowGroundPercentage in interface Area
  - getHighGroundPercentage
```
public int getHighGroundPercentage()
```
    Description copied from interface: Area
    
    Returns the percentage of high ground tiles in this area.
    
    Specified by:
    
    getHighGroundPercentage in interface Area
  - getVeryHighGroundPercentage
```
public int getVeryHighGroundPercentage()
```
    Description copied from interface: Area
    
    Returns the percentage of very high ground tiles in this area.
    
    Specified by:
    
    getVeryHighGroundPercentage in interface Area
  - getChokePoints
```
public java.util.List<ChokePoint> getChokePoints()
```
    Description copied from interface: Area
    
    Returns the ChokePoints between this Area and the neighboring ones.
    - Note: if there are no neighboring Areas, then an empty set is returned.
    - Note: there may be more ChokePoints returned than the number of neighboring Areas, as there may be several ChokePoints between two Areas.
    
    Specified by:
    
    getChokePoints in interface Area
    
    See Also:
    
    Area.getChokePoints(Area)
  - getChokePoints
```
public java.util.List<ChokePoint> getChokePoints(Area area)
```
    Description copied from interface: Area
    
    Returns the ChokePoints between this Area and the specified area.
    - Assumes the specified area is a neighbor of this area, i.e. ChokePointsByArea().find(pArea) != ChokePointsByArea().end()
    - Note: there is always at least one ChokePoint between two neighboring Areas.
    
    Specified by:
    
    getChokePoints in interface Area
    
    Parameters:
    
    area - the specified area
  - getChokePointsByArea
```
public java.util.Map<Area,java.util.List<ChokePoint>> getChokePointsByArea()
```
    Description copied from interface: Area
    
    Returns the ChokePoints of this Area grouped by neighboring Areas. - Note: if there are no neighboring Areas, than an empty set is returned.
    
    Specified by:
    
    getChokePointsByArea in interface Area
  - getAccessibleNeighbors
```
public java.util.List<Area> getAccessibleNeighbors()
```
    Description copied from interface: Area
    
    Returns the accessible neighboring Areas.
    - The accessible neighboring Areas are a subset of the neighboring Areas (the neighboring Areas can be iterated using ChokePointsByArea()).
    - Two neighboring Areas are accessible from each over if at least one the ChokePoints they share is not Blocked.
    
    Specified by:
    
    getAccessibleNeighbors in interface Area
    
    See Also:
    
    ChokePoint.isBlocked()
  - isAccessibleFrom
```
public boolean isAccessibleFrom(Area area)
```
    Description copied from interface: Area
    
    Returns whether this Area is accessible from the specified area, that is, if they share the same GroupId().
    - Note: accessibility is always symmetrical.
    - Note: even if a and b are neighboring Areas,
    we can have: a->AccessibleFrom(b)
    and not: contains(a->AccessibleNeighbors(), b)
    
    Specified by:
    
    isAccessibleFrom in interface Area
    
    Parameters:
    
    area - the specified area
    
    See Also:
    
    Area.getGroupId()
  - getMinerals
```
public java.util.List<Mineral> getMinerals()
```
    Description copied from interface: Area
    
    Returns the Minerals contained in this Area.
    
    Specified by:
    
    getMinerals in interface Area
  - getGeysers
```
public java.util.List<Geyser> getGeysers()
```
    Description copied from interface: Area
    
    Returns the Geysers contained in this Area.
    
    Specified by:
    
    getGeysers in interface Area
  - getBases
```
public java.util.List<Base> getBases()
```
    Description copied from interface: Area
    
    Returns the Bases contained in this Area.
    
    Specified by:
    
    getBases in interface Area
  - onMineralDestroyed
```
public void onMineralDestroyed(Mineral mineral)
```
  - equals
```
public boolean equals(java.lang.Object object)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

Class AreaImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

groupId

highestAltitude

topLeft

bottomRight

tileCount

buildableTileCount

highGroundTileCount

veryHighGroundTileCount

chokePointsByArea

accessibleNeighbors

chokePoints

minerals

geysers

bases

Constructor Detail

AreaImpl

Method Detail

getId

getGroupId

getTopLeft

getBottomRight

getBoundingBoxSize

getWalkPositionWithHighestAltitude

getTop

getHighestAltitude

getSize

getLowGroundPercentage

getHighGroundPercentage

getVeryHighGroundPercentage

getChokePoints

getChokePoints

getChokePointsByArea

getAccessibleNeighbors

isAccessibleFrom

getMinerals

getGeysers

getBases

onMineralDestroyed

equals

hashCode