hex::Edge Class Reference

#include <hex.h>

List of all members.

---

Detailed Description

The interface between a hex and one of its six neighbours.

Length K. Each hex has its OWN set of edges, so each hex-hex interface has TWO edges- one for each hex.

Definition at line 238 of file hex.h.

Public Member Functions
Hex *	hex (void) const
Direction	direction (void) const
Edge *	complement (void) const
bool	is_next (const Edge &v) const
Edge *	next_in (bool clockwise=false) const
Edge *	next_out (bool clockwise=false) const
Point	start_point (float bias=0.0, bool clockwise=false) const
Point	end_point (float bias=0.0, bool clockwise=false) const
Point	join_point (const Edge *next, float bias=0.0) const
Friends
class	Hex

---

Member Function Documentation

Hex* hex::Edge::hex

(

void

)

const [inline]

Definition at line 243 of file hex.h.

Referenced by hex::Grid::boundary(), hex::Area::boundary(), and hex::move::Topography::increase_edge_cost().

{ return _hex; }

Direction hex::Edge::direction

(

void

)

const [inline]

Definition at line 244 of file hex.h.

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

{ return _direction; }

Edge * hex::Edge::complement

(

void

)

const

Definition at line 32 of file edge.cc.

References hex::Hex::edge(), and hex::Hex::go().

Referenced by next_out().

{
  Hex* adjacent_hex =_hex->go(_direction);
  if(adjacent_hex)
      return adjacent_hex->edge(_direction+3);
  else
      return NULL;
}

bool hex::Edge::is_next

(

const Edge &

v

)

const

Definition at line 43 of file edge.cc.

References _direction, _hex, and next_out().

{
  // TRUE iff: &v == next_in(T) || next_in(F) || next_out(T) || next_out(F)
  if( _hex == v._hex )
      return( _direction+1 == v._direction || _direction-1 == v._direction );
  else
      return( &v == next_out(true) || &v == next_out(false) );
}

Edge * hex::Edge::next_in

(

bool

clockwise = false

)

const

Definition at line 54 of file edge.cc.

References hex::Hex::edge().

Referenced by hex::Grid::boundary(), hex::Area::boundary(), and hex::Boundary::clockwise().

{
  int one =(clockwise? -1: 1);
  return _hex->edge( _direction + one );
}

Edge * hex::Edge::next_out

(

bool

clockwise = false

)

const

Definition at line 62 of file edge.cc.

References _hex, complement(), and hex::Hex::edge().

Referenced by hex::Grid::boundary(), hex::Boundary::clockwise(), is_next(), and join_point().

{
  int one =(clockwise? -1: 1);
  Edge* c =_hex->edge( _direction + one )->complement();
  if(c)
      return c->_hex->edge( _direction - one );
  else
      return NULL;
}

Point hex::Edge::start_point	(	float	bias = 0.0,
		bool	clockwise = false
	)			const

Definition at line 95 of file edge.cc.

References hex::Hex::centre(), and hex::corner_offset().

Referenced by end_point(), and join_point().

{
  if(clockwise)
      return corner_offset( _hex->centre(), _direction + 1, bias );
  else
      return corner_offset( _hex->centre(), _direction    , bias );
}

Point hex::Edge::end_point	(	float	bias = 0.0,
		bool	clockwise = false
	)			const

Definition at line 105 of file edge.cc.

References start_point().

Referenced by join_point(), and hex::Boundary::stroke().

{
  return start_point(bias,!clockwise);
}

Point hex::Edge::join_point	(	const Edge *	next,
		float	bias = 0.0
	)			const

Definition at line 112 of file edge.cc.

References _direction, _hex, hex::Hex::centre(), hex::corner_offset(), end_point(), next_out(), and start_point().

Referenced by hex::Boundary::stroke().

{
  if(bias==0.0 || this->_hex==next->_hex)
  {
    if(this->_direction+1 == next->_direction)
        return end_point(bias);
    else
        return start_point(bias); // clockwise
  }
  else if(next == next_out())
  {
    Point p =corner_offset( _hex->centre(), _direction + 2, 0.0 );
    return corner_offset( p, _direction, bias );
  }
  else // clockwise
  {
#ifdef HEX_PARANOID_CHECKS
    assert(next == next_out(true));
#endif
    Point p =corner_offset( _hex->centre(), _direction - 1, 0.0 );
    return corner_offset( p, _direction + 1, bias );
  }
}

---

Friends And Related Function Documentation

friend class Hex [friend]

Definition at line 253 of file hex.h.

---

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

• hex.h
• edge.cc

---