obstacles for the map

Committer:
el15lm
Date:
Thu May 04 08:58:34 2017 +0000
Revision:
1:d55b0553a29a
Parent:
0:0c1bbee29dfe
added Doxygen code commenting

Who changed what in which revision?

UserRevisionLine numberNew contents of line
el15lm 0:0c1bbee29dfe 1 #ifndef Column_H
el15lm 0:0c1bbee29dfe 2 #define Column_H
el15lm 0:0c1bbee29dfe 3
el15lm 0:0c1bbee29dfe 4 #include "mbed.h"
el15lm 0:0c1bbee29dfe 5 #include "N5110.h"
el15lm 0:0c1bbee29dfe 6 #include "Gamepad.h"
el15lm 0:0c1bbee29dfe 7
el15lm 1:d55b0553a29a 8 /** Column.h
el15lm 1:d55b0553a29a 9 @brief This library handles a circular type of obstacle.
el15lm 1:d55b0553a29a 10 */
el15lm 0:0c1bbee29dfe 11 class Column
el15lm 0:0c1bbee29dfe 12 {
el15lm 0:0c1bbee29dfe 13 private:
el15lm 0:0c1bbee29dfe 14
el15lm 0:0c1bbee29dfe 15 // Variables
el15lm 0:0c1bbee29dfe 16 int _posX;
el15lm 0:0c1bbee29dfe 17 int _posY;
el15lm 0:0c1bbee29dfe 18 int _radius;
el15lm 0:0c1bbee29dfe 19 int _scenePosX;
el15lm 0:0c1bbee29dfe 20 int _scenePosY;
el15lm 0:0c1bbee29dfe 21
el15lm 0:0c1bbee29dfe 22 public:
el15lm 0:0c1bbee29dfe 23
el15lm 0:0c1bbee29dfe 24 /**
el15lm 0:0c1bbee29dfe 25 * Class constructor
el15lm 0:0c1bbee29dfe 26 */
el15lm 0:0c1bbee29dfe 27 Column();
el15lm 0:0c1bbee29dfe 28
el15lm 0:0c1bbee29dfe 29 /**
el15lm 0:0c1bbee29dfe 30 * Class destructor
el15lm 0:0c1bbee29dfe 31 */
el15lm 0:0c1bbee29dfe 32 ~Column();
el15lm 0:0c1bbee29dfe 33
el15lm 0:0c1bbee29dfe 34 /**
el15lm 0:0c1bbee29dfe 35 * Getter for the the absolute X cohordinate
el15lm 0:0c1bbee29dfe 36 */
el15lm 0:0c1bbee29dfe 37 int getPosX();
el15lm 0:0c1bbee29dfe 38
el15lm 0:0c1bbee29dfe 39 /**
el15lm 0:0c1bbee29dfe 40 * Getter for the the absolute Y cohordinate
el15lm 0:0c1bbee29dfe 41 */
el15lm 0:0c1bbee29dfe 42 int getPosY();
el15lm 0:0c1bbee29dfe 43
el15lm 0:0c1bbee29dfe 44 /**
el15lm 0:0c1bbee29dfe 45 * Getter for the the radius of the column object
el15lm 0:0c1bbee29dfe 46 */
el15lm 0:0c1bbee29dfe 47 int getRadius();
el15lm 0:0c1bbee29dfe 48
el15lm 0:0c1bbee29dfe 49 /**
el15lm 0:0c1bbee29dfe 50 * Getter for the the X cohordinate relative to the screen
el15lm 0:0c1bbee29dfe 51 */
el15lm 0:0c1bbee29dfe 52 int getScenePosX();
el15lm 0:0c1bbee29dfe 53
el15lm 0:0c1bbee29dfe 54 /**
el15lm 0:0c1bbee29dfe 55 * Getter for the the Y cohordinate relative to the screen
el15lm 0:0c1bbee29dfe 56 */
el15lm 0:0c1bbee29dfe 57 int getScenePosY();
el15lm 0:0c1bbee29dfe 58
el15lm 0:0c1bbee29dfe 59 /** Setter for the the X cohordinate relative to the screen
el15lm 0:0c1bbee29dfe 60 *
el15lm 0:0c1bbee29dfe 61 * @param x X cohordinate relative to the screens
el15lm 0:0c1bbee29dfe 62 *
el15lm 0:0c1bbee29dfe 63 */
el15lm 0:0c1bbee29dfe 64 void setScenePosX(int x);
el15lm 0:0c1bbee29dfe 65
el15lm 0:0c1bbee29dfe 66 /** Setter for the the Y cohordinate relative to the screen
el15lm 0:0c1bbee29dfe 67 *
el15lm 0:0c1bbee29dfe 68 * @param y Y cohordinate relative to the screens
el15lm 0:0c1bbee29dfe 69 *
el15lm 0:0c1bbee29dfe 70 */
el15lm 0:0c1bbee29dfe 71 void setScenePosY(int y);
el15lm 0:0c1bbee29dfe 72
el15lm 0:0c1bbee29dfe 73 /** initialise the column object
el15lm 0:0c1bbee29dfe 74 *
el15lm 0:0c1bbee29dfe 75 * @param x Absolute X cohordinate
el15lm 0:0c1bbee29dfe 76 * @param y Absolute y cohordinate
el15lm 0:0c1bbee29dfe 77 * @param radius Radius of the column object
el15lm 0:0c1bbee29dfe 78 *
el15lm 0:0c1bbee29dfe 79 */
el15lm 0:0c1bbee29dfe 80 void init(int x,
el15lm 0:0c1bbee29dfe 81 int y,
el15lm 0:0c1bbee29dfe 82 int radius);
el15lm 0:0c1bbee29dfe 83 void draw(N5110 &lcd);
el15lm 0:0c1bbee29dfe 84 };
el15lm 0:0c1bbee29dfe 85
el15lm 0:0c1bbee29dfe 86 #endif