KGrid2D::Square< T > Class Template Reference

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::Square< T >:

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
Public Member Functions inherited from KGrid2D::Generic< T >
	Generic (uint width=0, uint height=0)
void	resize (uint width, uint height)
void	fill (const T &value)
uint	width () const
uint	height () const
uint	size () const
uint	index (const Coord &c) const
Coord	coord (uint index) const
const T &	at (const Coord &c) const
T &	at (const Coord &c)
const T &	at (uint index) const
T &	at (uint index)
const T &	operator[] (const Coord &c) const
T &	operator[] (const Coord &c)
const T &	operator[] (uint index) const
T &	operator[] (uint index)
bool	inside (const Coord &c) const
void	bound (Coord &c) const

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

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.

Constructor & Destructor Documentation

Square()

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

neighbours()

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.

toEdge()

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:

• kgrid2d.h