Yiu Fai Kwok / Mbed 2 deprecated el17yfk

Dependencies:   mbed FXOS8700CQ mbed-rtos

Committer:
yfkwok
Date:
Sun Apr 21 11:02:28 2019 +0000
Revision:
17:5d8ff39a0e49
Parent:
12:71683453f66a
Child:
25:31111e6e13ad
21/04/2019 - Add Doxygen comments for the following classes: Exam, Characters, Score and Start

Who changed what in which revision?

UserRevisionLine numberNew contents of line
yfkwok 17:5d8ff39a0e49 1 /** Bulbasaur Class
yfkwok 17:5d8ff39a0e49 2 * @brief This class contains all information such as sprites and descriptions for the character Bulbasaur
yfkwok 17:5d8ff39a0e49 3 * @version 1.0
yfkwok 17:5d8ff39a0e49 4 * @author Yiu Fai Kwok
yfkwok 17:5d8ff39a0e49 5 * @date Match, 2019
yfkwok 17:5d8ff39a0e49 6 */
yfkwok 2:464c7e62d97d 7 #ifndef BULBASAUR_H
yfkwok 2:464c7e62d97d 8 #define BULBASAUR_H
yfkwok 2:464c7e62d97d 9
yfkwok 2:464c7e62d97d 10 #include "mbed.h"
yfkwok 2:464c7e62d97d 11 #include "N5110.h"
yfkwok 2:464c7e62d97d 12 #include "Gamepad.h"
yfkwok 2:464c7e62d97d 13
yfkwok 2:464c7e62d97d 14 class Bulbasaur
yfkwok 2:464c7e62d97d 15 {
yfkwok 2:464c7e62d97d 16
yfkwok 2:464c7e62d97d 17 public:
yfkwok 17:5d8ff39a0e49 18 /** Constructor */
yfkwok 2:464c7e62d97d 19 Bulbasaur();
yfkwok 17:5d8ff39a0e49 20 /** Deconstructor */
yfkwok 2:464c7e62d97d 21 ~Bulbasaur();
yfkwok 2:464c7e62d97d 22
yfkwok 17:5d8ff39a0e49 23 /**
yfkwok 17:5d8ff39a0e49 24 * @brief Draw the primary sprite
yfkwok 17:5d8ff39a0e49 25 * @param position x pos_x (int)
yfkwok 17:5d8ff39a0e49 26 * @param position y pos_y (int)
yfkwok 17:5d8ff39a0e49 27 * @details Draws the primary evolution of the character, the position will be determined by parameters pos_x and pos_y
yfkwok 17:5d8ff39a0e49 28 */
yfkwok 2:464c7e62d97d 29 void draw_cha1_sprite(int pos_x,int pos_y,N5110 &lcd);
yfkwok 17:5d8ff39a0e49 30
yfkwok 17:5d8ff39a0e49 31 /**
yfkwok 17:5d8ff39a0e49 32 * @brief Draw the evolution 1 sprite
yfkwok 17:5d8ff39a0e49 33 * @details Draws the primary evolution of the character which is displayed when evolving
yfkwok 17:5d8ff39a0e49 34 */
yfkwok 12:71683453f66a 35 void evo_1_sprite(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 36
yfkwok 17:5d8ff39a0e49 37 /**
yfkwok 17:5d8ff39a0e49 38 * @brief Draw the evolution 2 sprite
yfkwok 17:5d8ff39a0e49 39 * @details Draws the secondary evolution of the character which is displayed when evolving
yfkwok 17:5d8ff39a0e49 40 */
yfkwok 10:adff3c804985 41 void evo_2_sprite(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 42
yfkwok 17:5d8ff39a0e49 43 /**
yfkwok 17:5d8ff39a0e49 44 * @brief Draw the name title
yfkwok 17:5d8ff39a0e49 45 * @param position x x (int)
yfkwok 17:5d8ff39a0e49 46 * @param position y y (int)
yfkwok 17:5d8ff39a0e49 47 * @details Draws the name tile of the character, the position will be determined by parameters x and y
yfkwok 17:5d8ff39a0e49 48 */
yfkwok 10:adff3c804985 49 void evo_3_sprite(N5110 &lcd, int x, int y);
yfkwok 17:5d8ff39a0e49 50
yfkwok 17:5d8ff39a0e49 51 /**
yfkwok 17:5d8ff39a0e49 52 * @brief Draw the congratulation sprite for evolution 1
yfkwok 17:5d8ff39a0e49 53 * @details Draws the primary evolution of the character which is displayed after evolution
yfkwok 17:5d8ff39a0e49 54 */
yfkwok 10:adff3c804985 55 void evo_1_cong(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 56
yfkwok 17:5d8ff39a0e49 57 /**
yfkwok 17:5d8ff39a0e49 58 * @brief Draw the congratulation sprite for evolution 2
yfkwok 17:5d8ff39a0e49 59 * @details Draws the secondary evolution of the character which is displayed after evolution
yfkwok 17:5d8ff39a0e49 60 */
yfkwok 10:adff3c804985 61 void evo_2_cong(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 62
yfkwok 17:5d8ff39a0e49 63 /**
yfkwok 17:5d8ff39a0e49 64 * @brief Draw the congratulation sprite for evolution 3
yfkwok 17:5d8ff39a0e49 65 * @details Draws the final evolution of the character which is displayed after evolution
yfkwok 17:5d8ff39a0e49 66 */
yfkwok 10:adff3c804985 67 void evo_3_cong(N5110 &lcd);
yfkwok 17:5d8ff39a0e49 68
yfkwok 17:5d8ff39a0e49 69 /**
yfkwok 17:5d8ff39a0e49 70 * @brief Display the descrption of the character
yfkwok 17:5d8ff39a0e49 71 * @details Contain the detail description of the character and the instruction sets to navigate through the manual
yfkwok 17:5d8ff39a0e49 72 */
yfkwok 2:464c7e62d97d 73 void description(Gamepad &pad, N5110 &lcd);
yfkwok 2:464c7e62d97d 74
yfkwok 2:464c7e62d97d 75 private:
yfkwok 2:464c7e62d97d 76
yfkwok 2:464c7e62d97d 77 int _pos_x;
yfkwok 2:464c7e62d97d 78 int _pos_y;
yfkwok 12:71683453f66a 79 int _x;
yfkwok 12:71683453f66a 80 int _y;
yfkwok 2:464c7e62d97d 81
yfkwok 2:464c7e62d97d 82 };
yfkwok 2:464c7e62d97d 83
yfkwok 2:464c7e62d97d 84 #endif