ChokePointImpl (BWAPI4J API)

java.lang.Object
- bwem.ChokePointImpl

All Implemented Interfaces:: ChokePoint

public class ChokePointImpl
extends java.lang.Object
implements ChokePoint

Nested Class Summary
- Nested classes/interfaces inherited from interface bwem.ChokePoint
  ChokePoint.Node

Constructor Summary

Constructors
Constructor and Description
`ChokePointImpl(Graph graph, Index index, Area area1, Area area2, java.util.List<WalkPosition> geometry)`
`ChokePointImpl(Graph graph, Index index, Area area1, Area area2, java.util.List<WalkPosition> geometry, Neutral blockingNeutral)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accessibleFrom(ChokePoint chokePoint)` Returns whether this ChokePoint is accessible from cp (through a walkable path).
`int`	`distanceFrom(ChokePoint chokePoint)` If accessibleFrom(cp) == false, returns -1.
`boolean`	`equals(java.lang.Object object)`
`Pair<Area,Area>`	`getAreas()` Returns the two areas of this ChokePoint.
`Neutral`	`getBlockingNeutral()` If !
`WalkPosition`	`getCenter()` Returns the center of this ChokePoint.
`java.util.List<WalkPosition>`	`getGeometry()` Returns the set of positions that defines the shape of this ChokePoint.
`Index`	`getIndex()`
`WalkPosition`	`getNodePosition(ChokePoint.Node node)` Returns the position of one of the 3 nodes of this ChokePoint (Cf. node definition).
`WalkPosition`	`getNodePositionInArea(ChokePoint.Node node, Area area)` Pretty much the same as pos(n), except that the returned MiniTile position is guaranteed to be part of pArea.
`ChokePoint`	`getPathBackTrace()`
`CPPath`	`getPathTo(ChokePoint cp)` Returns a list of getChokePoints, which is intended to be the shortest walking path from this ChokePoint to cp.
`int`	`hashCode()`
`boolean`	`isBlocked()` If !
`boolean`	`isPseudo()` Tells whether this ChokePoint is a pseudo ChokePoint, i.e., it was created on top of a blocking Neutral.
`void`	`onBlockingNeutralDestroyed(Neutral pBlocking)`
`void`	`setPathBackTrace(ChokePoint pathBackTrace)`

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

- Constructor Detail
  - ChokePointImpl
```
public ChokePointImpl(Graph graph,
                      Index index,
                      Area area1,
                      Area area2,
                      java.util.List<WalkPosition> geometry,
                      Neutral blockingNeutral)
```
  - ChokePointImpl
```
public ChokePointImpl(Graph graph,
                      Index index,
                      Area area1,
                      Area area2,
                      java.util.List<WalkPosition> geometry)
```
- Method Detail
  - isPseudo
```
public boolean isPseudo()
```
    Description copied from interface: ChokePoint
    
    Tells whether this ChokePoint is a pseudo ChokePoint, i.e., it was created on top of a blocking Neutral.
    
    Specified by:
    
    isPseudo in interface ChokePoint
  - getAreas
```
public Pair<Area,Area> getAreas()
```
    Description copied from interface: ChokePoint
    
    Returns the two areas of this ChokePoint.
    
    Specified by:
    
    getAreas in interface ChokePoint
  - getCenter
```
public WalkPosition getCenter()
```
    Description copied from interface: ChokePoint
    
    Returns the center of this ChokePoint.
    
    Specified by:
    
    getCenter in interface ChokePoint
  - getNodePosition
```
public WalkPosition getNodePosition(ChokePoint.Node node)
```
    Description copied from interface: ChokePoint
    
    Returns the position of one of the 3 nodes of this ChokePoint (Cf. node definition).
    - Note: the returned value is contained in geometry()
    
    Specified by:
    
    getNodePosition in interface ChokePoint
  - getNodePositionInArea
```
public WalkPosition getNodePositionInArea(ChokePoint.Node node,
                                          Area area)
```
    Description copied from interface: ChokePoint
    
    Pretty much the same as pos(n), except that the returned MiniTile position is guaranteed to be part of pArea. That is: Map::getArea(positionOfNodeInArea(n, pArea)) == pArea.
    
    Specified by:
    
    getNodePositionInArea in interface ChokePoint
  - getGeometry
```
public java.util.List<WalkPosition> getGeometry()
```
    Description copied from interface: ChokePoint
    
    Returns the set of positions that defines the shape of this ChokePoint.
    - Note: none of these miniTiles actually belongs to this ChokePoint (a ChokePoint doesn't contain any MiniTile). They are however guaranteed to be part of one of the 2 areas.
    - Note: the returned set contains pos(middle), pos(END_1) and pos(END_2). If isPseudo(), returns {p} where p is the position of a walkable MiniTile near from blockingNeutral()->pos().
    
    Specified by:
    
    getGeometry in interface ChokePoint
  - isBlocked
```
public boolean isBlocked()
```
    Description copied from interface: ChokePoint
    
    If !isPseudo(), returns false. Otherwise, returns whether this ChokePoint is considered blocked. Normally, a pseudo ChokePoint either remains blocked, or switches to not isBlocked when blockingNeutral() is destroyed and there is no remaining Neutral stacked with it. However, in the case where Map::automaticPathUpdate() == false, blocked() will always return true whatever blockingNeutral() returns. Cf. Area::AccessibleNeighbors().
    
    Specified by:
    
    isBlocked in interface ChokePoint
  - getBlockingNeutral
```
public Neutral getBlockingNeutral()
```
    Description copied from interface: ChokePoint
    
    If !isPseudo(), returns nullptr. Otherwise, returns a pointer to the blocking Neutral on top of which this pseudo ChokePoint was created, unless this blocking Neutral has been destroyed. In this case, returns a pointer to the next blocking Neutral that was stacked at the same location, or nullptr if no such Neutral exists.
    
    Specified by:
    
    getBlockingNeutral in interface ChokePoint
  - distanceFrom
```
public int distanceFrom(ChokePoint chokePoint)
```
    Description copied from interface: ChokePoint
    
    If accessibleFrom(cp) == false, returns -1. Otherwise, returns the ground distance in pixels between center() and cp->center(). - Note: if this == cp, returns 0.
    - Time complexity: O(1)
    - Note: Corresponds to the length in pixels of getPathTo(cp). So it suffers from the same lack of accuracy. In particular, the value returned tends to be slightly higher than expected when getPathTo(cp).size() is high.
    
    Specified by:
    
    distanceFrom in interface ChokePoint
  - accessibleFrom
```
public boolean accessibleFrom(ChokePoint chokePoint)
```
    Description copied from interface: ChokePoint
    
    Returns whether this ChokePoint is accessible from cp (through a walkable path).
    - Note: the relation is symmetric: this->accessibleFrom(cp) == cp->accessibleFrom(this)
    - Note: if this == cp, returns true.
    - Time complexity: O(1)
    
    Specified by:
    
    accessibleFrom in interface ChokePoint
  - getPathTo
```
public CPPath getPathTo(ChokePoint cp)
```
    Description copied from interface: ChokePoint
    
    Returns a list of getChokePoints, which is intended to be the shortest walking path from this ChokePoint to cp. The path always starts with this ChokePoint and ends with cp, unless accessibleFrom(cp) == false. In this case, an empty list is returned.
    - Note: if this == cp, returns [cp].
    Time complexity: O(1)
    To get the length of the path returned in pixels, use distanceFrom(cp).
    - Note: all the possible Paths are precomputed during Map::initialize().
    The best one is then stored for each pair of getChokePoints. However, only the center of the getChokePoints is considered. As a consequence, the returned path may not be the shortest one.
    
    Specified by:
    
    getPathTo in interface ChokePoint
  - onBlockingNeutralDestroyed
```
public void onBlockingNeutralDestroyed(Neutral pBlocking)
```
  - getIndex
```
public Index getIndex()
```
  - getPathBackTrace
```
public ChokePoint getPathBackTrace()
```
  - setPathBackTrace
```
public void setPathBackTrace(ChokePoint pathBackTrace)
```
  - 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 ChokePointImpl

Nested Class Summary

Nested classes/interfaces inherited from interface bwem.ChokePoint

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ChokePointImpl

ChokePointImpl

Method Detail

isPseudo

getAreas

getCenter

getNodePosition

getNodePositionInArea

getGeometry

isBlocked

getBlockingNeutral

distanceFrom

accessibleFrom

getPathTo

onBlockingNeutralDestroyed

getIndex

getPathBackTrace

setPathBackTrace

equals

hashCode