File: Mainpage.dox

package info (click to toggle)
ksquares 4:18.04.1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 1,460 kB
  • sloc: cpp: 1,542; xml: 111; makefile: 5; sh: 3
file content (49 lines) | stat: -rw-r--r-- 1,845 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
/**
\mainpage KSquares

\section intro_sec Introduction

KSquares is a KDE implementation of the game "squares"

\section overview_sec Overview

The overall game is masterminded from @ref KSquaresWindow.
That class creates a @ref KSquaresGame object which handles the game logic such as moving from player to player and tracking when points are scored.
The information for each player is stored in @ref KSquaresPlayer of which KSquaresGame has an array.
When a KSquaresGame event occurs it emits a signal which is picked up by the KSquaresWindow and passed onto the @ref GameBoardScene which is responsible for holding the information about the game board.
The GameBoardScene emits signal when a line is drawn which passes via the KSquaresWindow back to KSquaresGame.

\section index_sec Layout of indices

In @ref KSquaresGame, @ref GameBoardScene and @ref aiController there is a consistent indexing rule for accesing the tables.

For the list of squares and their owners, the indices simply count from left to right along the top row of the board, then along the second row etc.

For the list of lines and whether they're drawn, the indices count from left to right along the top row of horizontal lines, then (left to right) along the first row of vertical lines etc.

\image html ksquaresindex.png

\section todo_sec TODO

\todo A more obvious sign of where the computer player has moved

\todo Logo/initials/colour/etc. for players squares

\todo Themeable game board. Subclass all the QGraphicsItems and handle the theming there :D
QGraphicsLineItem (feint lines, completed lines), QGraphicsEllipseItem (dots), QGraphicsRectItem(completed squares)

\todo foreach for QLists in AI class

\todo valgrind

\todo *Not yet* Hints
	
\todo *Not yet* Network play
*/

/*!
	\namespace KSquares 
	\brief Namespace for KSquares only stuff
	
	Blah
*/