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

libkdegames

  • KGrid2D
  • Square
Public Member Functions
KGrid2D::Square< T > Class Template Reference

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::Square< T >:
KGrid2D::Generic< T > KGrid2D::SquareBase

List of all members.

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

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

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:
cto the given set of coordinates
cthe coordinate to use as the reference point
insideOnlyonly add coordinates that are inside the grid.
directOnlyonly 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:
cthe coordinate to use as the reference point
nthe direction of projection.

Definition at line 344 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. |