hex::Hex Class Reference

#include <hex.h>

List of all members.

---

Detailed Description

A single hexagonal quanta of area.

Definition at line 260 of file hex.h.

Public Member Functions
const Grid &	grid (void) const
const Edge *	edge (const Direction &d) const
Edge *	edge (const Direction &d)
Hex *	go (const Direction &d, int distance=1) const
Hex *	go (const std::string &steps) const
Point	centre (void) const
std::string	str (void) const
	Hex (const Grid &grid, int i_, int j_)
Static Public Member Functions
static int	_key (int i, int j)
	Generates a unique key for co-ordinates i,j.
Public Attributes
const int	i
	in units of I
const int	j
	in units of J
Friends
class	Grid

---

Constructor & Destructor Documentation

hex::Hex::Hex	(	const Grid &	grid,
		int	i_,
		int	j_
	)

Definition at line 109 of file hex.cc.

                                        :
  _edgeA(this,A), _edgeB(this,B), _edgeC(this,C),
  _edgeD(this,D), _edgeE(this,E), _edgeF(this,F),
  _grid(grid), i(i_), j(j_)
{}

---

Member Function Documentation

const Grid& hex::Hex::grid

(

void

)

const [inline]

Definition at line 267 of file hex.h.

Referenced by hex::Area::boundary(), and hex::range().

{ return _grid; }

const Edge * hex::Hex::edge

(

const Direction &

d

)

const

Definition at line 47 of file hex.cc.

Referenced by hex::Area::boundary(), hex::Edge::complement(), hex::move::Topography::increase_hex_cost(), hex::Edge::next_in(), hex::Edge::next_out(), hex::move::Topography::override_hex_cost(), and hex::move::Topography::step().

{
  return const_cast<Edge*>( const_cast<Hex*>(this)->edge( d ) );
}

Edge * hex::Hex::edge

(

const Direction &

d

)

Definition at line 32 of file hex.cc.

References hex::A, hex::B, hex::C, hex::D, and hex::E.

{
  switch(d)
  {
    case A:  return &_edgeA;
    case B:  return &_edgeB;
    case C:  return &_edgeC;
    case D:  return &_edgeD;
    case E:  return &_edgeE;
    default: return &_edgeF;
  }
}

Hex * hex::Hex::go	(	const Direction &	d,
		int	distance = 1
	)			const

Definition at line 54 of file hex.cc.

References hex::go(), hex::Grid::hex(), i, and j.

Referenced by hex::Grid::area(), hex::Edge::complement(), hex::Area::fillpaths(), and hex::move::Topography::step().

{
  int i_ =this->i;
  int j_ =this->j;
  hex::go(i_,j_,d,distance); // in/out: i_,j_ 
  try
  {
    return _grid.hex(i_,j_);
  }
  catch(hex::out_of_range)
  {
    return NULL;
  }
}

Hex * hex::Hex::go

(

const std::string &

steps

)

const

Definition at line 71 of file hex.cc.

References hex::go(), hex::Grid::hex(), i, and j.

{
  int i_ =this->i;
  int j_ =this->j;
  hex::go(i_,j_,steps); // in/out: i_,j_ 
  try
  {
    return _grid.hex(i_,j_);
  }
  catch(hex::out_of_range)
  {
    return NULL;
  }
}

Point hex::Hex::centre

(

void

)

const

Definition at line 88 of file hex.cc.

References i, hex::I, j, hex::J, hex::K, hex::Point::x, and hex::Point::y.

Referenced by hex::move::_Route::distance(), hex::Edge::join_point(), and hex::Edge::start_point().

{
  Point result;
  if(this->j % 2)
      result.x = I * (1 + this->i); // odd rows
  else 
      result.x = I/2.0 + I * this->i; // even rows
  result.y = K + J * this->j;
  return result;
}

std::string hex::Hex::str

(

void

)

const

Definition at line 101 of file hex.cc.

References i, and j.

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

{
  std::ostringstream ss;
  ss<< this->i <<"_"<< this->j;
  return ss.str();
}

static int hex::Hex::_key	(	int	i,
		int	j
	)			[inline, static]

Generates a unique key for co-ordinates i,j.

(i,j < 2^14)

Definition at line 275 of file hex.h.

Referenced by hex::Grid::hex().

{ return (i<<14) | j; }

---

Friends And Related Function Documentation

friend class Grid [friend]

Definition at line 279 of file hex.h.

---

Member Data Documentation

const int hex::Hex::i

in units of I

Definition at line 265 of file hex.h.

Referenced by hex::Area::boundary(), centre(), go(), hex::range(), hex::steps(), and str().

const int hex::Hex::j

in units of J

Definition at line 266 of file hex.h.

Referenced by hex::Area::boundary(), centre(), go(), hex::range(), hex::steps(), and str().

---

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

• hex.h
• hex.cc

---