Doxygen comments added
Dependencies: mbed Gamepad N5110
Bird/Bird.h@11:c85abe88ad7a, 2019-05-08 (annotated)
- Committer:
- rafeh
- Date:
- Wed May 08 21:10:18 2019 +0000
- Revision:
- 11:c85abe88ad7a
- Parent:
- 10:75de0f4da176
- Child:
- 12:736e8561b81e
doxygen comments;
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
rafeh | 3:5409b50b01b0 | 1 | #ifndef BIRD_H |
rafeh | 3:5409b50b01b0 | 2 | #define BIRD_H |
rafeh | 3:5409b50b01b0 | 3 | |
rafeh | 3:5409b50b01b0 | 4 | #include "mbed.h" |
rafeh | 3:5409b50b01b0 | 5 | #include "N5110.h" |
rafeh | 3:5409b50b01b0 | 6 | #include "Gamepad.h" |
rafeh | 3:5409b50b01b0 | 7 | |
rafeh | 3:5409b50b01b0 | 8 | class Bird { |
rafeh | 10:75de0f4da176 | 9 | /** Bird Class |
rafeh | 10:75de0f4da176 | 10 | @brief Class to control the movement of the bird |
rafeh | 10:75de0f4da176 | 11 | @author Rafeh Ishtiaq |
rafeh | 10:75de0f4da176 | 12 | @date May 2019 |
rafeh | 10:75de0f4da176 | 13 | */ |
rafeh | 3:5409b50b01b0 | 14 | public: |
rafeh | 11:c85abe88ad7a | 15 | /** Constructor */ |
rafeh | 10:75de0f4da176 | 16 | Bird(); |
rafeh | 11:c85abe88ad7a | 17 | /** Destructor */ |
rafeh | 10:75de0f4da176 | 18 | ~Bird(); |
rafeh | 11:c85abe88ad7a | 19 | /** initialises and sets the horizonal and verical position of the bird |
rafeh | 10:75de0f4da176 | 20 | @param xpos @details Horizonal position of the bird |
rafeh | 10:75de0f4da176 | 21 | @param ypos @details vertical position of the bird |
rafeh | 10:75de0f4da176 | 22 | */ |
rafeh | 6:bc580b480ac8 | 23 | void init(int xpos, int ypos); |
rafeh | 11:c85abe88ad7a | 24 | /** Draws the bird on the lcd |
rafeh | 10:75de0f4da176 | 25 | */ |
rafeh | 6:bc580b480ac8 | 26 | void draw(N5110 &lcd); |
rafeh | 11:c85abe88ad7a | 27 | /** Gets the updated vertical positon of the bird |
rafeh | 10:75de0f4da176 | 28 | @param y @details the old vertical position of the bird |
rafeh | 10:75de0f4da176 | 29 | @returns y @details new vertical position of the bird (depends on button being pressed on Gamepad) |
rafeh | 10:75de0f4da176 | 30 | */ |
rafeh | 6:bc580b480ac8 | 31 | int get_position(int y, Gamepad &pad); |
rafeh | 3:5409b50b01b0 | 32 | |
rafeh | 3:5409b50b01b0 | 33 | private: |
rafeh | 3:5409b50b01b0 | 34 | |
rafeh | 6:bc580b480ac8 | 35 | int _xpos; |
rafeh | 6:bc580b480ac8 | 36 | int _ypos; |
rafeh | 6:bc580b480ac8 | 37 | int _y; |
rafeh | 6:bc580b480ac8 | 38 | |
rafeh | 3:5409b50b01b0 | 39 | |
rafeh | 3:5409b50b01b0 | 40 | }; |
rafeh | 3:5409b50b01b0 | 41 | #endif |