Inheritance diagram for BWAPI::Regionset:

Public Member Functions
Position	getCenter () const
Unitset	getUnits (const UnitFilter &pred=nullptr) const
Public Member Functions inherited from std::unordered_set< K >
T	unordered_set (T...args)
T	begin (T...args)
T	begin(int) (T...args)
T	bucket (T...args)
T	bucket_count (T...args)
T	bucket_size (T...args)
T	cbegin (T...args)
T	cbegin(int) (T...args)
T	cend (T...args)
T	cend(int) (T...args)
T	clear (T...args)
T	count (T...args)
T	emplace (T...args)
T	emplace_hint (T...args)
T	empty (T...args)
T	end (T...args)
T	end(int) (T...args)
T	equal_range (T...args)
T	erase (T...args)
T	find (T...args)
T	get_allocator (T...args)
T	hash_function (T...args)
T	insert (T...args)
T	key_eq (T...args)
T	load_factor (T...args)
T	max_bucket_count (T...args)
T	max_load_factor (T...args)
T	max_size (T...args)
T	operator= (T...args)
T	rehash (T...args)
T	reserve (T...args)
T	size (T...args)
T	swap (T...args)

Additional Inherited Members
Public Attributes inherited from std::unordered_set< K >
K	keys

Detailed Description

A container that holds a set of Region objects.

Member Function Documentation

Position BWAPI::Regionset::getCenter () const

Retrieves the center of the region.

This position is used as the node of the region.

Returns: A Position indicating the center location of the Region, in pixels.

Unitset BWAPI::Regionset::getUnits (const UnitFilter & pred = nullptr) const

Retrieves a Unitset containing all the units that are in this region.

Also has the ability to filter the units before the creation of the Unitset.

Parameters

pred	(optional) If this parameter is used, it is a UnitFilter or function predicate that will retrieve only the units whose attributes match the given criteria. If omitted, then a default value of nullptr is used, in which case there is no filter.

Returns: A Unitset containing all units in this region that have met the requirements of pred.