KGrid2D::Square< T > Class Template Reference

This template is a Generic implementation for a square bidimensionnal grid (SquareBase). More...

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::Square< T >:

Inheritance graph
[legend]
Collaboration diagram for KGrid2D::Square< T >:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 Square (uint width=0, uint height=0)
 Constructor.
CoordList neighbours (const Coord &c, bool insideOnly=true, bool directOnly=false) const
Coord toEdge (const Coord &c, Neighbour n) const

Detailed Description

template<class T>
class KGrid2D::Square< T >

This template is a Generic implementation for a square bidimensionnal grid (SquareBase).

Since:
3.2

Definition at line 319 of file kgrid2d.h.


Constructor & Destructor Documentation

template<class T>
KGrid2D::Square< T >::Square uint  width = 0,
uint  height = 0
[inline]
 

Constructor.

Definition at line 325 of file kgrid2d.h.


Member Function Documentation

template<class T>
CoordList KGrid2D::Square< T >::neighbours const Coord c,
bool  insideOnly = true,
bool  directOnly = false
const [inline]
 

Returns:
the neighbours of coordinate
Parameters:
c to the given set of coordinates
c the coordinate to use as the reference point
insideOnly only add coordinates that are inside the grid.
directOnly only add the four nearest neighbours.

Definition at line 335 of file kgrid2d.h.

References KGrid2D::SquareBase::LeftUp, KGrid2D::SquareBase::Nb_Neighbour, and KGrid2D::SquareBase::neighbour().

Here is the call graph for this function:

template<class T>
Coord KGrid2D::Square< T >::toEdge const Coord c,
Neighbour  n
const [inline]
 

Returns:
the "projection" of the given coordinate on the grid edges.
Parameters:
c the coordinate to use as the reference point
n the direction of projection.

Definition at line 352 of file kgrid2d.h.


The documentation for this class was generated from the following file:
Generated on Wed Aug 23 18:06:36 2006 for libkdegames by  doxygen 1.4.6