KGrid2D::HexagonalBase Class Reference

This class contains static methods to manipulate coordinates on an hexagonal grid where hexagons form horizontal lines:. More...

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::HexagonalBase:

[legend]

List of all members.

Public Types
enum	Neighbour {   Left = 0, Right, LeftUp, LeftDown,   RightUp, RightDown, Nb_Neighbour }
	Identify the six neighbours. More...
Static Public Member Functions
static double	angle (Neighbour n)
	Returns: the trigonometric angle in radians for the given neighbour.
static Neighbour	opposed (Neighbour n)
	Returns: the opposed neighbour.
static Coord	neighbour (const Coord &c, Neighbour n)
	Returns: the neighbour of the given coordinate.
static uint	distance (const Coord &c1, const Coord &c2)
	Returns: the distance between the two coordinates in term of hexagons.

---

Detailed Description

This class contains static methods to manipulate coordinates on an hexagonal grid where hexagons form horizontal lines:.

 (0,0)   (0,1)   (0,2)
     (1,0)   (1,1)   (1,2)
 (2,0)   (2,1)   (2,2)
 

Definition at line 361 of file kgrid2d.h.

---

Member Enumeration Documentation

enum KGrid2D::HexagonalBase::Neighbour

Identify the six neighbours.

Enumerator:

Left
Right
LeftUp
LeftDown
RightUp
RightDown
Nb_Neighbour

Definition at line 367 of file kgrid2d.h.

---

Member Function Documentation

static double KGrid2D::HexagonalBase::angle

(

Neighbour

n

)

[inline, static]

Returns:

the trigonometric angle in radians for the given neighbour.

Definition at line 373 of file kgrid2d.h.

References Left, LeftDown, LeftUp, Nb_Neighbour, Right, RightDown, and RightUp.

static Neighbour KGrid2D::HexagonalBase::opposed

(

Neighbour

n

)

[inline, static]

Returns:

the opposed neighbour.

Definition at line 389 of file kgrid2d.h.

References Left, LeftDown, LeftUp, Nb_Neighbour, Right, RightDown, and RightUp.

static Coord KGrid2D::HexagonalBase::neighbour	(	const Coord &	c,
		Neighbour	n
	)			[inline, static]

Returns:

the neighbour of the given coordinate.

Definition at line 405 of file kgrid2d.h.

References Left, LeftDown, LeftUp, Nb_Neighbour, Right, RightDown, and RightUp.

Referenced by KGrid2D::Hexagonal< Type >::neighbours().

static uint KGrid2D::HexagonalBase::distance	(	const Coord &	c1,
		const Coord &	c2
	)			[inline, static]

Returns:

the distance between the two coordinates in term of hexagons.

Definition at line 422 of file kgrid2d.h.

---

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

• kgrid2d.h

---