KGrid2D::SquareBase Class Reference

#include <kgrid2d.h>

Inheritance diagram for KGrid2D::SquareBase:

KGrid2D::Square< T > List of all members.

Detailed Description

This class contains static methods to manipulate coordinates for a square bidimensionnal grid.

Since:
3.2

Definition at line 234 of file kgrid2d.h.


Public Types

enum  Neighbour {
  Left = 0, Right, Up, Down,
  LeftUp, LeftDown, RightUp, RightDown,
  Nb_Neighbour
}

Static Public Member Functions

static double angle (Neighbour n)
static Neighbour opposed (Neighbour n)
static bool isDirect (Neighbour n)
static Coord neighbour (const Coord &c, Neighbour n)

Member Enumeration Documentation

Identify the eight neighbours.

Definition at line 240 of file kgrid2d.h.


Member Function Documentation

static double KGrid2D::SquareBase::angle ( Neighbour  n  )  [inline, static]

Returns:
the trigonometric angle in radians for the given neighbour.

Definition at line 246 of file kgrid2d.h.

static Neighbour KGrid2D::SquareBase::opposed ( Neighbour  n  )  [inline, static]

Returns:
the opposed neighbour.

Definition at line 264 of file kgrid2d.h.

static bool KGrid2D::SquareBase::isDirect ( Neighbour  n  )  [inline, static]

Returns:
true if the neighbour is a direct one (ie is one of the four nearest).

Definition at line 283 of file kgrid2d.h.

static Coord KGrid2D::SquareBase::neighbour ( const Coord c,
Neighbour  n 
) [inline, static]

Returns:
the neighbour for the given coordinate.

Definition at line 288 of file kgrid2d.h.


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