KGrid2D::Square< T > Class Template Reference

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::Square< T >:

KGrid2D::Generic< T > KGrid2D::SquareBase List of all members.

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


Public Member Functions

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

Constructor & Destructor Documentation

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

Constructor.

Definition at line 317 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 327 of file kgrid2d.h.

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


The documentation for this class was generated from the following file:
KDE Home | KDE Accessibility Home | Description of Access Keys