KGrid2D::Hexagonal< Type > Class Template Reference

This template implements a hexagonal grid where hexagons form horizontal lines:. More...

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::Hexagonal< Type >:

[legend]Collaboration diagram for KGrid2D::Hexagonal< Type >:

[legend]List of all members.

Public Member Functions
	Hexagonal (uint width=0, uint height=0)
	Constructor.
CoordList	neighbours (const Coord &c, bool insideOnly=true) const
CoordList	neighbours (const Coord &c, uint distance, bool all, bool insideOnly=true) const

---

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 459 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 465 of file kgrid2d.h.

---

Member Function Documentation

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

Returns: the neighbours at distance 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 493 of file kgrid2d.h.

template<class Type> CoordList KGrid2D::Hexagonal< Type >::neighbours (  const Coord &  c, bool  insideOnly = true )  const [inline]

Returns: the neighbours of coordinate 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 474 of file kgrid2d.h.

---

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

• kgrid2d.h

---