#include <kgrid2d.h>

Inheritance diagram for KGrid2D::Hexagonal< Type >:

Public Member Functions
	Hexagonal (uint width=0, uint height=0)
CoordList	neighbours (const Coord &c, bool insideOnly=true) const
CoordList	neighbours (const Coord &c, uint distance, bool all, bool insideOnly=true) const
Public Member Functions inherited from KGrid2D::Generic< Type >
	Generic (uint width=0, uint height=0)
void	resize (uint width, uint height)
void	fill (const Type &value)
uint	width () const
uint	height () const
uint	size () const
uint	index (const Coord &c) const
Coord	coord (uint index) const
const Type &	at (const Coord &c) const
Type &	at (const Coord &c)
const Type &	operator[] (const Coord &c) const
Type &	operator[] (const Coord &c)
const Type &	at (uint index) const
Type &	at (uint index)
const Type &	operator[] (uint index) const
Type &	operator[] (uint index)
bool	inside (const Coord &c) const
void	bound (Coord &c) const

Additional Inherited Members
Public Types inherited from KGrid2D::HexagonalBase
enum	Neighbour { Left = 0 , Right , LeftUp , LeftDown , RightUp , RightDown , Nb_Neighbour }
Static Public Member Functions inherited from KGrid2D::HexagonalBase
static double	angle (Neighbour n)
static Neighbour	opposed (Neighbour n)
static Coord	neighbour (const Coord &c, Neighbour n)
static uint	distance (const Coord &c1, const Coord &c2)
Protected Attributes inherited from KGrid2D::Generic< Type >
uint	_width
uint	_height
TQValueVector< Type >	_vector

Detailed Description

template<class Type>
class KGrid2D::Hexagonal< Type >

This template implements a 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)

@ since 3.2

Definition at line 451 of file kgrid2d.h.

Constructor & Destructor Documentation

template<class Type>

KGrid2D::Hexagonal< Type >::Hexagonal	(	uint	width = 0,
		uint	height = 0 )

inline

Constructor.

Definition at line 457 of file kgrid2d.h.

template<class Type>

CoordList KGrid2D::Hexagonal< Type >::neighbours	(	const Coord &	c,
		bool	insideOnly = true ) const

inline

Parameters

c	to the given set of coordinates
c	the coordiante to use as the reference point
insideOnly	only add coordinates that are inside the grid.

Definition at line 466 of file kgrid2d.h.

template<class Type>

CoordList KGrid2D::Hexagonal< Type >::neighbours	(	const Coord &	c,
		uint	distance,
		bool	all,
		bool	insideOnly = true ) const

inline

Parameters

distance	of coordinate
c	the coordinate to use as the reference point
distance	distance to the neighbour (1 means at contact).
insideOnly	only add coordinates that are inside the grid.
all	returns all neighbours at distance equal and less than
distance	(the original coordinate is not included).

Definition at line 485 of file kgrid2d.h.

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