KDE 4.0 API Reference ksquares
GameBoardScene Class Reference
#include <gameboardscene.h>
Detailed Description
Scene for displaying the game board.Created anew at the beginning of each game. Contains the visual representation of the board. Is used to interperet mouse clicks from the user (if the view is unlocked) Contains QGraphicsLineItems for lines, QGraphicsEllipseItems for the dots and QGraphicsRectItem for when a square is complete.
Definition at line 26 of file gameboardscene.h.
Public Slots | |
| void | drawLine (int index, const QColor &colour) |
| void | drawSquare (int index, const QColor &colour) |
| void | enableEvents () |
| void | disableEvents () |
Signals | |
| void | lineDrawn (int) |
Public Member Functions | |
| GameBoardScene (int newWidth, int newHeight, QObject *parent=0) | |
| ~GameBoardScene () | |
| const QSize | minimumSizeHint () const |
Protected Member Functions | |
| QList< QGraphicsEllipseItem * > | getTwoNearestPoints (const QPointF &pos) const |
| bool | isLineAlready (const QList< QGraphicsEllipseItem * > &pointPair) const |
| void | addLineToIndex (const QList< QGraphicsEllipseItem * > &pointPair) |
| int | indexFromPointPair (const QList< QGraphicsEllipseItem * > &pointPair) const |
| QGraphicsLineItem * | lineFromIndex (int index) const |
| void | mouseReleaseEvent (QGraphicsSceneMouseEvent *mouseEvent) |
| void | mouseMoveEvent (QGraphicsSceneMouseEvent *mouseEvent) |
Protected Attributes | |
| QGraphicsLineItem * | indicatorLine |
| QList< bool > | lineList |
| int | QGraphicsEllipseItemType |
| int | width |
| int | height |
| int | spacing |
| bool | acceptEvents |
Constructor & Destructor Documentation
| GameBoardScene::GameBoardScene | ( | int | newWidth, | |
| int | newHeight, | |||
| QObject * | parent = 0 | |||
| ) |
Create a new gameboard scene with the appropriate size.
- Parameters:
-
newWidth the number of squares wide the board is newHeight the number of squares tall the board is parent passed to QGraphicsScene's constructor
Definition at line 19 of file gameboardscene.cpp.
| GameBoardScene::~GameBoardScene | ( | ) |
Member Function Documentation
| const QSize GameBoardScene::minimumSizeHint | ( | ) | const |
The smallest the view can be when 'auto-zoom' is off.
- Returns:
- the minimum size the view should be
Definition at line 206 of file gameboardscene.cpp.
| void GameBoardScene::drawLine | ( | int | index, | |
| const QColor & | colour | |||
| ) | [slot] |
Add the line to the scene so it shows up in the view.
- Parameters:
-
index the line-index of the line colour the colour of the line
Definition at line 80 of file gameboardscene.cpp.
| void GameBoardScene::drawSquare | ( | int | index, | |
| const QColor & | colour | |||
| ) | [slot] |
Fill a box to show it is owned be a particular player.
- Parameters:
-
index the square-index of the square colour the colour fill of the square
Definition at line 91 of file gameboardscene.cpp.
| void GameBoardScene::enableEvents | ( | ) | [inline, slot] |
| void GameBoardScene::disableEvents | ( | ) | [inline, slot] |
| QList< QGraphicsEllipseItem * > GameBoardScene::getTwoNearestPoints | ( | const QPointF & | pos | ) | const [protected] |
Given a single location in the scene, gives the two nearest QGraphicsEllipseItem.
- Parameters:
-
pos the point in question
- Returns:
- QList of (hopefully 2) QGraphicsEllipseItem*s
Definition at line 185 of file gameboardscene.cpp.
| bool GameBoardScene::isLineAlready | ( | const QList< QGraphicsEllipseItem * > & | pointPair | ) | const [protected] |
Given a pair of points, returns whether there is already a line there.
- Parameters:
-
pointPair QList of (hopefully 2) QGraphicsEllipseItem*s
- Returns:
- trur if there is a line there
Definition at line 167 of file gameboardscene.cpp.
| void GameBoardScene::addLineToIndex | ( | const QList< QGraphicsEllipseItem * > & | pointPair | ) | [protected] |
Adds the line to the index for a specified pair of points.
- Parameters:
-
pointPair QList of (hopefully 2) QGraphicsEllipseItem*s
Definition at line 176 of file gameboardscene.cpp.
| int GameBoardScene::indexFromPointPair | ( | const QList< QGraphicsEllipseItem * > & | pointPair | ) | const [protected] |
Takes a pair of QGraphicsEllipseItems and finds the index that relates to the line that's between them.
- Parameters:
-
pointPair QList of (hopefully 2) QGraphicsEllipseItem*s
- Returns:
- the line-index
Definition at line 98 of file gameboardscene.cpp.
| QGraphicsLineItem * GameBoardScene::lineFromIndex | ( | int | index | ) | const [protected] |
Takes a line-index and returns a QGraphicsLineItem located at that position.
- Parameters:
-
index the line-index
- Returns:
- line located at the correct position
Definition at line 138 of file gameboardscene.cpp.
| void GameBoardScene::mouseReleaseEvent | ( | QGraphicsSceneMouseEvent * | mouseEvent | ) | [protected] |
| void GameBoardScene::mouseMoveEvent | ( | QGraphicsSceneMouseEvent * | mouseEvent | ) | [protected] |
| void GameBoardScene::lineDrawn | ( | int | ) | [signal] |
Emits the index of the closet (undrawn) line when a click is detected.
Member Data Documentation
QGraphicsLineItem* GameBoardScene::indicatorLine [protected] |
QList<bool> GameBoardScene::lineList [protected] |
int GameBoardScene::QGraphicsEllipseItemType [protected] |
int GameBoardScene::width [protected] |
int GameBoardScene::height [protected] |
int GameBoardScene::spacing [protected] |
bool GameBoardScene::acceptEvents [protected] |
This property holds whether mouse events are enabled for this widget.
Definition at line 113 of file gameboardscene.h.
The documentation for this class was generated from the following files:
