BWAPI::Region Class Reference

#include <Region.h>

Inheritance diagram for BWAPI::Region:

List of all members.

Public Member Functions
virtual int	getID () const =0
virtual int	getRegionGroupID () const =0
virtual BWAPI::Position	getCenter () const =0
virtual bool	isHigherGround () const =0
virtual int	getDefensePriority () const =0
virtual bool	isWalkable () const =0
virtual const std::set< Region * > &	getNeighbors () const =0
virtual int	getBoundsLeft () const =0
virtual int	getBoundsTop () const =0
virtual int	getBoundsRight () const =0
virtual int	getBoundsBottom () const =0
virtual BWAPI::Region *	getClosestAccessibleRegion () const =0
virtual BWAPI::Region *	getClosestInaccessibleRegion () const =0
virtual int	getDistance (BWAPI::Region *other) const =0
Protected Member Functions
virtual	~Region ()

---

Constructor & Destructor Documentation

virtual BWAPI::Region::~Region

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual int BWAPI::Region::getBoundsBottom

(

)

const [pure virtual]

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual int BWAPI::Region::getBoundsLeft

(

)

const [pure virtual]

Retrieves the approximate region boundry as specified by Broodwar.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual int BWAPI::Region::getBoundsRight

(

)

const [pure virtual]

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual int BWAPI::Region::getBoundsTop

(

)

const [pure virtual]

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual BWAPI::Position BWAPI::Region::getCenter

(

)

const [pure virtual]

Retrieves the center of the region.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

Here is the caller graph for this function:

virtual BWAPI::Region* BWAPI::Region::getClosestAccessibleRegion

(

)

const [pure virtual]

Retrieves the closest accessable neighbor region.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual BWAPI::Region* BWAPI::Region::getClosestInaccessibleRegion

(

)

const [pure virtual]

Retrieves the closest inaccessable neighbor region.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual int BWAPI::Region::getDefensePriority

(

)

const [pure virtual]

Returns a value representing the strategic advantage of this region according to Broodwar.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual int BWAPI::Region::getDistance

(

BWAPI::Region *

other

)

const [pure virtual]

Retrieves the center-to-center distance between two regions.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual int BWAPI::Region::getID

(

)

const [pure virtual]

Returns the unique ID for this region assigned by Broodwar.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual const std::set<Region*>& BWAPI::Region::getNeighbors

(

)

const [pure virtual]

Retrieves the set of neighbors that this region is connected to.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

Here is the caller graph for this function:

virtual int BWAPI::Region::getRegionGroupID

(

)

const [pure virtual]

Returns an ID for the body of land that this region belongs to.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

Here is the caller graph for this function:

virtual bool BWAPI::Region::isHigherGround

(

)

const [pure virtual]

Returns true if this region belongs to strategic higher ground, assigned by Broodwar.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

virtual bool BWAPI::Region::isWalkable

(

)

const [pure virtual]

Returns true if the region can be walked on by ground units.

Implemented in BWAPI::RegionImpl, and BWAPI::RegionImpl.

---

The documentation for this class was generated from the following file:

• trunk/bwapi/include/BWAPI/Region.h