hex::Area Class Reference

#include <hex.h>

Inheritance diagram for hex::Area:

List of all members.

---

Detailed Description

A connected set of hexes.

Definition at line 288 of file hex.h.

Public Member Functions
int	size (void) const
bool	contains (Hex *h) const
Boundary	boundary (void) const
const std::set< Hex * > &	hexes (void) const
std::list< Area >	enclosed_areas (void) const
std::list< Boundary >	skeleton (bool include_boundary=true) const
	For drawing the structure.
std::list< hex::Path >	fillpaths (Hex *origin=NULL) const
	A list of one or more paths that include every hex in the area once.
std::string	str (Hex *origin=NULL) const
Area	go (const Direction &d, int distance=1) const throw (hex::out_of_range)
Area	go (const std::string &steps) const throw (hex::out_of_range)
	Area (void)
	Required for list<Area>.
	Area (const std::set< Hex * > &hexes)
	Area (Hex *h)
	Area (Hex *h, int distance)
	All hexes <= distance from h.

---

Constructor & Destructor Documentation

hex::Area::Area

(

void

)

[inline]

Required for list<Area>.

Definition at line 307 of file hex.h.

hex::Area::Area

(

const std::set< Hex * > &

hexes

)

Definition at line 173 of file area.cc.

References hex::is_connected().

                                   : _hexes(hexes)
{
#ifdef HEX_PARANOID_CHECKS
  assert(is_connected(hexes));
#endif
}

hex::Area::Area

(

Hex *

h

)

[inline]

Definition at line 309 of file hex.h.

: _hexes() { _hexes.insert(h); }

hex::Area::Area	(	Hex *	h,
		int	distance
	)

All hexes <= distance from h.

Definition at line 181 of file area.cc.

References hex::range().

                              : _hexes()
{
  for(int i=0; i<=distance; ++i)
  {
    std::set<Hex*> s =range(h,i);
    std::copy(s.begin(),s.end(),inserter(_hexes,_hexes.end()));
  }
}

---

Member Function Documentation

int hex::Area::size

(

void

)

const [inline]

Definition at line 292 of file hex.h.

{ return int(_hexes.size()); }

bool hex::Area::contains

(

Hex *

h

)

const [inline]

Definition at line 293 of file hex.h.

Referenced by boundary().

{ return _hexes.count(h)>0; }

Boundary hex::Area::boundary

(

void

)

const

Definition at line 33 of file area.cc.

References contains(), hex::D, hex::Hex::edge(), hex::Hex::grid(), hex::Edge::hex(), hex::Grid::hex(), hex::Hex::i, hex::Hex::j, and hex::Edge::next_in().

Referenced by hex::svg::Document::draw_complex_area(), hex::svg::Document::draw_simple_area(), enclosed_areas(), main(), and skeleton().

{
  // Start with a random hex.
  Hex* h =*_hexes.begin();
  const Grid& grid =h->grid();
  const int i0 =h->i;
  const int j0 =h->j;
  // Find an edge.
  int i=0;
  while(i<=i0 && !contains(grid.hex(i,j0)))
      ++i;
  std::list<Edge*> result;
  result.push_back( grid.hex(i,j0)->edge(D) );
  // Follow the edge round.
  while(true)
  {
    Edge* e =result.back()->next_out();
    if( !e || !contains(e->hex()) )
        e = result.back()->next_in();
    if(e == result.front())
        break;
    result.push_back(e);
  }
  return result;
}

const std::set<Hex*>& hex::Area::hexes

(

void

)

const [inline]

Definition at line 295 of file hex.h.

Referenced by hex::fill(), hex::move::Topography::increase_cost(), and hex::move::Topography::override_cost().

{ return _hexes; }

std::list< Area > hex::Area::enclosed_areas

(

void

)

const

Definition at line 61 of file area.cc.

References _hexes, hex::Boundary::area(), hex::areas(), boundary(), and hex::set_difference().

Referenced by hex::svg::Document::draw_complex_area().

{
  Area a =boundary().area();
  return areas( set_difference( a._hexes, _hexes ) );
}

std::list< Boundary > hex::Area::skeleton

(

bool

include_boundary = true

)

const

For drawing the structure.

If include_boundary is TRUE, then the last item in the list is the external boundary of the area.

Definition at line 69 of file area.cc.

References hex::A, hex::B, boundary(), and hex::C.

Referenced by hex::svg::Document::draw_skeleton().

{
  std::list<Boundary> result;
  for(std::set<Hex*>::const_iterator h=_hexes.begin(); h!=_hexes.end(); ++h)
  {
    std::list<Edge*> edges;
    edges.push_back( (**h).edge(A) );
    edges.push_back( (**h).edge(B) );
    edges.push_back( (**h).edge(C) );
    result.push_back(edges);
  }
  if(include_boundary)
      result.push_back(boundary());
  return result;
}

std::list< hex::Path > hex::Area::fillpaths

(

Hex *

origin = NULL

)

const

A list of one or more paths that include every hex in the area once.

Definition at line 87 of file area.cc.

References hex::F, hex::Hex::go(), and hex::path().

Referenced by str().

{
  // Try to calculate a path that fills area.
  std::set<Hex*> queue =_hexes;
  std::set<Hex*> seen;
  std::list<Path> result;
  std::list<Hex*> path;
  Hex*      hex = origin? origin: *queue.begin();
  Direction dir =F;
  while(!queue.empty())
  {
    path.push_back( hex );
    queue.erase( hex );
    seen.insert( hex );
    Direction d=dir+1;
    while(true)
    {
      if(d==dir)
      {
        result.push_back( path );
        path.clear();
        hex = *queue.begin();
        break;
      }
      Hex* hd =hex->go(d);
      if(queue.count(hd) && !seen.count(hd))
      {
        hex = hd;
        dir = d+3;
        break;
      }
      ++d;
    }
  }
  return result;
}

std::string hex::Area::str

(

Hex *

origin = NULL

)

const

Definition at line 126 of file area.cc.

References fillpaths(), hex::steps(), and hex::Hex::str().

Referenced by main().

{
  if(!origin)
      origin=*_hexes.begin();
  std::ostringstream result;
  std::list<Path> paths  =this->fillpaths(origin);
  result << origin->str();
  for(std::list<Path>::const_iterator p =paths.begin(); p!=paths.end(); ++p)
  {
    if(p->hexes().front()!=origin)
        result << ">" << hex::steps(origin,p->hexes().front());
    result << ":" << p->steps();
  }
  return result.str();
}

Area hex::Area::go	(	const Direction &	d,
		int	distance = 1
	)			const throw (hex::out_of_range)

Definition at line 144 of file area.cc.

References _hexes, and hex::distance().

{
  Area result;
  for(std::set<Hex*>::const_iterator h=_hexes.begin(); h!=_hexes.end(); ++h)
  {
    Hex* hex =(**h).go(d,distance);
    if(!hex)
        throw hex::out_of_range("Area::go");
    result._hexes.insert(hex);
  }
  return result;
}

Area hex::Area::go

(

const std::string &

steps

)

const throw (hex::out_of_range)

Definition at line 159 of file area.cc.

References _hexes, and hex::steps().

{
  Area result;
  for(std::set<Hex*>::const_iterator h=_hexes.begin(); h!=_hexes.end(); ++h)
  {
    Hex* hex =(**h).go(steps);
    if(!hex)
        throw hex::out_of_range("Area::go");
    result._hexes.insert(hex);
  }
  return result;
}

---

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

• hex.h
• area.cc

---