• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • libkdegames
 

libkdegames

  • KGrid2D
  • Hexagonal
Public Member Functions
KGrid2D::Hexagonal< Type > Class Template Reference

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::Hexagonal< Type >:
KGrid2D::Generic< Type > KGrid2D::HexagonalBase

List of all members.

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

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.


Member Function Documentation

template<class Type >
CoordList KGrid2D::Hexagonal< Type >::neighbours ( const Coord &  c,
bool  insideOnly = true 
) const [inline]
Returns:
the neighbours of coordinate
Parameters:
cto the given set of coordinates
cthe coordiante to use as the reference point
insideOnlyonly 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]
Returns:
the neighbours at distance
Parameters:
distanceof coordinate
cthe coordinate to use as the reference point
distancedistance to the neighbour (1 means at contact).
insideOnlyonly add coordinates that are inside the grid.
allreturns 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:
  • kgrid2d.h

libkdegames

Skip menu "libkdegames"
  • Main Page
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Class Members
  • Related Pages

libkdegames

Skip menu "libkdegames"
  • libkdegames
Generated for libkdegames by doxygen 1.7.6.1
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |