diff options
author | mario <mario@notk.org> | 2011-11-30 03:46:41 +0100 |
---|---|---|
committer | mario <mario@notk.org> | 2011-11-30 03:46:41 +0100 |
commit | 871745156d679f82f3be060af83dfd51a3416f09 (patch) | |
tree | c17729ebf4c28991e02029e46ecb6d122b77c152 /Field.h | |
parent | f5c32b3b880deb0ff2eee7243e3f112469841e95 (diff) |
~Doxygen-style commented. Not exactly doxygen but compatible and close enough.
Diffstat (limited to 'Field.h')
-rw-r--r-- | Field.h | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -16,10 +16,27 @@ class Field public:
Field(uint width = 0, uint height = 0);
virtual ~Field(void);
+
+public:
+ /**
+ * Inits the fields at a givens size and empties it.
+ **/
void init(uint width, uint height);
+ /**
+ * Draw all players for several cycles. Initial, final AND intermediate positions will be drawn.
+ **/
bool drawAllPlayers(uint numCycles);
+ /**
+ * Returns a specific cell given its coordinates.
+ **/
Cell& getCell(Coordinates c);
+ /**
+ * Returns the size of the field
+ **/
Coordinates getMaxCoordinates();
+ /**
+ * Redefines the value of a cell.
+ **/
void setCell(Coordinates coord, Cell cell);
private:
|