hex::Boundary Class Reference

#include <hex.h>

Inheritance diagram for hex::Boundary:

List of all members.

---

Detailed Description

A sequence of adjacent edges.

Definition at line 337 of file hex.h.

Public Member Functions
int	length (void) const
	< in units of K
bool	is_closed (void) const
	has no endpoints
bool	is_container (void) const
	contains finite area
Boundary	complement (void) const throw (hex::out_of_range)
const std::list< Edge * > &	edges (void) const
Path	to_path (void) const
bool	clockwise (void) const
	normally false.
std::string	str (void) const
std::list< Point >	stroke (float bias=0.0) const
	Calculate the set of points required to draw this boundary.
Area	area (void) const
	Returns the area enclosed by the boundary.
	Boundary (void)
	Required for list<Boundary>.
	Boundary (const std::list< Edge * > &edges)

---

Constructor & Destructor Documentation

hex::Boundary::Boundary

(

void

)

[inline]

Required for list<Boundary>.

Definition at line 355 of file hex.h.

hex::Boundary::Boundary

(

const std::list< Edge * > &

edges

)

[inline]

Definition at line 356 of file hex.h.

: _edges(edges) {}

---

Member Function Documentation

int hex::Boundary::length

(

void

)

const

< in units of K

Definition at line 32 of file boundary.cc.

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

bool hex::Boundary::is_closed

(

void

)

const

has no endpoints

Definition at line 39 of file boundary.cc.

Referenced by area(), hex::svg::Document::draw_boundary(), is_container(), and stroke().

{
  return( _edges.size()>2 && _edges.front()->is_next( *_edges.back() ) );
}

bool hex::Boundary::is_container

(

void

)

const

contains finite area

Definition at line 46 of file boundary.cc.

References complement(), is_closed(), hex::Path::length(), and to_path().

{
  if(is_closed())
  {
    try {
      Path p1 =complement().to_path();
      Path p0 =to_path();
      return( p0.length() < p1.length() );
    }
    catch(hex::out_of_range) {
      // If is_closed AND there is no complement, then the boundary must
      // be at the very edge of the grid... it MUST be a container.
      return true;
    }
  }
  return false;
}

Boundary hex::Boundary::complement

(

void

)

const throw (hex::out_of_range)

Definition at line 66 of file boundary.cc.

References complement().

Referenced by complement(), and is_container().

{
  std::list<Edge*> result;
  for(std::list<Edge*>::const_iterator e=_edges.begin(); e!=_edges.end(); ++e)
  {
    Edge* c =(**e).complement();
    if(c)
        result.push_back( c );
    else
        throw hex::out_of_range("Boundary complement out of range.");
  }
  return result;
}

const std::list<Edge*>& hex::Boundary::edges

(

void

)

const [inline]

Definition at line 345 of file hex.h.

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

{ return _edges; }

Path hex::Boundary::to_path

(

void

)

const

Definition at line 82 of file boundary.cc.

Referenced by is_container().

{
  std::list<Hex*> result;
  for(std::list<Edge*>::const_iterator e=_edges.begin(); e!=_edges.end(); ++e)
    if( result.empty() || (**e).hex() != result.back() )
        result.push_back( (**e).hex() );
  return result;
}

bool hex::Boundary::clockwise

(

void

)

const

normally false.

Definition at line 93 of file boundary.cc.

References hex::Edge::next_in(), and hex::Edge::next_out().

Referenced by str(), and stroke().

{
  // Boundaries usually go round in a positive (anti-clockwise) direction.
  if(_edges.size() > 1)
  {
    std::list<Edge*>::const_iterator e =_edges.begin();
    Edge* e0 = *e;
    Edge* e1 = *(++e);
    return( e0==e1->next_in() || e0==e1->next_out() );
  }
  return false;
}

std::string hex::Boundary::str

(

void

)

const

Definition at line 108 of file boundary.cc.

References clockwise(), and hex::to_char().

{
  assert(!_edges.empty());
  std::string result =_edges.front()->hex()->str() + (clockwise()?"-":"+");
  for(std::list<Edge*>::const_iterator e=_edges.begin(); e!=_edges.end(); ++e)
      result += to_char( (**e).direction() );
  return result;
}

std::list< Point > hex::Boundary::stroke

(

float

bias = 0.0

)

const

Calculate the set of points required to draw this boundary.

Definition at line 119 of file boundary.cc.

References clockwise(), hex::Edge::end_point(), is_closed(), and hex::Edge::join_point().

Referenced by hex::svg::Document::draw_boundary(), hex::svg::Document::draw_complex_area(), and hex::svg::Document::draw_simple_area().

{
  std::list<Point> result;
  bool cw =this->clockwise();
  if(bias==0.0)
  {
    if(!_edges.empty())
    {
      std::list<Edge*>::const_iterator e =_edges.begin();
      result.push_back( (**e).start_point(0.0,cw) );
      while(e!=_edges.end())
      {
        result.push_back( (**e).end_point(0.0,cw) );
        ++e;
      }
    }
  }
  else
  {
    Edge* last =NULL;
    for(std::list<Edge*>::const_iterator e=_edges.begin(); e!=_edges.end(); ++e)
    {
      if(last)
          result.push_back( last->join_point(*e,bias) );
      last = *e;
    }
    if(is_closed())
    {
      Point p =last->join_point(_edges.front(),bias);
      result.push_front( p );
      result.push_back( p );
    }
    else
    {
      result.push_front( _edges.front()->start_point(bias,cw) );
      result.push_back( last->end_point(bias,cw) );
    }
  }
  return result;
}

Area hex::Boundary::area

(

void

)

const

Returns the area enclosed by the boundary.

It is an error to call this function when is_closed()==false

Definition at line 162 of file boundary.cc.

References hex::fill(), and is_closed().

Referenced by hex::Area::enclosed_areas().

{
  assert(is_closed());
  std::set<Hex*> beyond;
  std::set<Hex*> queue;
  for(std::list<Edge*>::const_iterator e=_edges.begin(); e!=_edges.end(); ++e)
  {
    queue.insert(  (**e).hex() );
    beyond.insert( (**e).hex()->go( (**e).direction() ) ); // NULL is OK.
  }
  return fill(beyond,queue);
}

---

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

• hex.h
• boundary.cc

---