Max Houghton / Animations

Class containing all the bitmaps used to make up the various animations used within the game.

Animations.h@1:bf0f64c26a0a, 2017-05-04 (annotated)

Committer:
el15mh
Date:
Thu May 04 14:02:17 2017 +0000
Revision:
1:bf0f64c26a0a
Parent:
0:45606d84dad8 
Doxygen commenting added

Who changed what in which revision?

UserRevisionLine numberNew contents of line
el15mh 1:bf0f64c26a0a 1 /** Animations Class
el15mh 1:bf0f64c26a0a 2 @brief Class contains all the different animations used throughout the game.
el15mh 1:bf0f64c26a0a 3 @author Max Houghton
el15mh 1:bf0f64c26a0a 4 @date April 13 2017
el15mh 0:45606d84dad8 5 */
el15mh 0:45606d84dad8 6
el15mh 0:45606d84dad8 7 #ifndef ANIMATIONS_H
el15mh 0:45606d84dad8 8 #define ANIMATIONS_H
el15mh 0:45606d84dad8 9
el15mh 0:45606d84dad8 10 #include "mbed.h"
el15mh 0:45606d84dad8 11 #include "N5110.h"
el15mh 0:45606d84dad8 12 #include "Gamepad.h"
el15mh 0:45606d84dad8 13
el15mh 0:45606d84dad8 14 class Animations
el15mh 0:45606d84dad8 15 {
el15mh 0:45606d84dad8 16
el15mh 0:45606d84dad8 17 public:
el15mh 0:45606d84dad8 18
el15mh 1:bf0f64c26a0a 19 /**
el15mh 1:bf0f64c26a0a 20 * @details - constructor
el15mh 1:bf0f64c26a0a 21 */
el15mh 0:45606d84dad8 22 Animations();
el15mh 1:bf0f64c26a0a 23
el15mh 1:bf0f64c26a0a 24 /**
el15mh 1:bf0f64c26a0a 25 * @details - destructor
el15mh 1:bf0f64c26a0a 26 */
el15mh 0:45606d84dad8 27 ~Animations();
el15mh 0:45606d84dad8 28
el15mh 1:bf0f64c26a0a 29 /** Intro
el15mh 1:bf0f64c26a0a 30 *
el15mh 1:bf0f64c26a0a 31 * @details - Short animation to be used when running the introduction during the loading of the game.
el15mh 1:bf0f64c26a0a 32 * @param - lcd - N5110 Libarary used to print strings and draw the ball
el15mh 1:bf0f64c26a0a 33 *
el15mh 1:bf0f64c26a0a 34 */
el15mh 0:45606d84dad8 35 void intro(N5110 &lcd, Gamepad &pad);
el15mh 0:45606d84dad8 36
el15mh 1:bf0f64c26a0a 37 /** Vertical Joystick
el15mh 1:bf0f64c26a0a 38 *
el15mh 1:bf0f64c26a0a 39 * @details - Function to draw vertical joystick image. Used in 'animateJoystick()' function in Menu class.
el15mh 1:bf0f64c26a0a 40 * @param - lcd - N5110 Libarary used to draw joystick bitmap.
el15mh 1:bf0f64c26a0a 41 *
el15mh 1:bf0f64c26a0a 42 */
el15mh 0:45606d84dad8 43 void drawVerticalJoystick(N5110 &lcd);
el15mh 1:bf0f64c26a0a 44
el15mh 1:bf0f64c26a0a 45 /** Left Joystick
el15mh 1:bf0f64c26a0a 46 *
el15mh 1:bf0f64c26a0a 47 * @details - Function to draw joystick image tilting to the left. Used in 'animateJoystick()' function in Menu class.
el15mh 1:bf0f64c26a0a 48 * @param - lcd - N5110 Libarary used to draw joystick bitmap.
el15mh 1:bf0f64c26a0a 49 *
el15mh 1:bf0f64c26a0a 50 */
el15mh 0:45606d84dad8 51 void drawLeftJoystick(N5110 &lcd);
el15mh 1:bf0f64c26a0a 52
el15mh 1:bf0f64c26a0a 53 /** Right Joystick
el15mh 1:bf0f64c26a0a 54 *
el15mh 1:bf0f64c26a0a 55 * @details - Function to draw joystick image tilting to the right. Used in 'animateJoystick()' function in Menu class.
el15mh 1:bf0f64c26a0a 56 * @param - lcd - N5110 Libarary used to draw joystick bitmap.
el15mh 1:bf0f64c26a0a 57 *
el15mh 1:bf0f64c26a0a 58 */
el15mh 0:45606d84dad8 59 void drawRightJoystick(N5110 &lcd);
el15mh 0:45606d84dad8 60
el15mh 1:bf0f64c26a0a 61 /** Left Joystick
el15mh 1:bf0f64c26a0a 62 *
el15mh 1:bf0f64c26a0a 63 * @details - Function to draw gamepad image tilting to the left. Used in 'animateGamepad()' function in Menu class.
el15mh 1:bf0f64c26a0a 64 * @param - lcd - N5110 Libarary used to draw gamepad bitmap.
el15mh 1:bf0f64c26a0a 65 *
el15mh 1:bf0f64c26a0a 66 */
el15mh 0:45606d84dad8 67 void drawLeftGamepad(N5110 &lcd);
el15mh 1:bf0f64c26a0a 68
el15mh 1:bf0f64c26a0a 69 /** Vertical Gamepad
el15mh 1:bf0f64c26a0a 70 *
el15mh 1:bf0f64c26a0a 71 * @details - Function to draw vertical gamepad image. Used in 'animateGamepad()' function in Menu class.
el15mh 1:bf0f64c26a0a 72 * @param - lcd - N5110 Libarary used to draw gamepad bitmap.
el15mh 1:bf0f64c26a0a 73 *
el15mh 1:bf0f64c26a0a 74 */
el15mh 0:45606d84dad8 75 void drawVerticalGamepad(N5110 &lcd);
el15mh 1:bf0f64c26a0a 76
el15mh 1:bf0f64c26a0a 77 /** Right Gamepad
el15mh 1:bf0f64c26a0a 78 *
el15mh 1:bf0f64c26a0a 79 * @details - Function to draw gamepad image tilting to the right. Used in 'animateGamepad()' function in Menu class.
el15mh 1:bf0f64c26a0a 80 * @param - lcd - N5110 Libarary used to draw gamepad bitmap.
el15mh 1:bf0f64c26a0a 81 *
el15mh 1:bf0f64c26a0a 82 */
el15mh 0:45606d84dad8 83 void drawRightGamepad(N5110 &lcd);
el15mh 0:45606d84dad8 84
el15mh 1:bf0f64c26a0a 85 /** Rolling Empty Ball
el15mh 1:bf0f64c26a0a 86 *
el15mh 1:bf0f64c26a0a 87 * @details - Function to draw transparent-filled ball rolling across the screen. Used in 'ballColourOptions()' function in Menu class.
el15mh 1:bf0f64c26a0a 88 * @param - lcd - N5110 Libarary used to draw circles representing moving ball.
el15mh 1:bf0f64c26a0a 89 *
el15mh 1:bf0f64c26a0a 90 */
el15mh 0:45606d84dad8 91 void rollingEmptyBall(N5110 &lcd);
el15mh 1:bf0f64c26a0a 92
el15mh 1:bf0f64c26a0a 93 /** Rolling Solid Ball
el15mh 1:bf0f64c26a0a 94 *
el15mh 1:bf0f64c26a0a 95 * @details - Function to draw solid-filled ball rolling across the screen. Used in 'ballColourOptions()' function in Menu class.
el15mh 1:bf0f64c26a0a 96 * @param - lcd - N5110 Libarary used to draw circles representing moving ball.
el15mh 1:bf0f64c26a0a 97 *
el15mh 1:bf0f64c26a0a 98 */
el15mh 0:45606d84dad8 99 void rollingSolidBall(N5110 &lcd);
el15mh 0:45606d84dad8 100
el15mh 1:bf0f64c26a0a 101 /** Maze Completed
el15mh 1:bf0f64c26a0a 102 *
el15mh 1:bf0f64c26a0a 103 * @details - Short animation to be used when the maze being used has been completed.
el15mh 1:bf0f64c26a0a 104 * @param - lcd - N5110 Libarary used to print strings and draw bitmaps.
el15mh 1:bf0f64c26a0a 105 *
el15mh 1:bf0f64c26a0a 106 */
el15mh 0:45606d84dad8 107 void mazeCompleted(N5110 &lcd);
el15mh 1:bf0f64c26a0a 108
el15mh 1:bf0f64c26a0a 109 /** Stickman One
el15mh 1:bf0f64c26a0a 110 *
el15mh 1:bf0f64c26a0a 111 * @details - First animation in a series to create a jumping man. Used inside mazeCompleted() function.
el15mh 1:bf0f64c26a0a 112 * @param - lcd - N5110 Libarary used to print strings and draw bitmap.
el15mh 1:bf0f64c26a0a 113 *
el15mh 1:bf0f64c26a0a 114 */
el15mh 0:45606d84dad8 115 void stickmanOne(N5110 &lcd);
el15mh 1:bf0f64c26a0a 116
el15mh 1:bf0f64c26a0a 117 /** Stickman Two
el15mh 1:bf0f64c26a0a 118 *
el15mh 1:bf0f64c26a0a 119 * @details - Second animation in a series to create a jumping man. Used inside mazeCompleted() function.
el15mh 1:bf0f64c26a0a 120 * @param - lcd - N5110 Libarary used to print strings and draw bitmap.
el15mh 1:bf0f64c26a0a 121 *
el15mh 1:bf0f64c26a0a 122 */
el15mh 0:45606d84dad8 123 void stickmanTwo(N5110 &lcd);
el15mh 1:bf0f64c26a0a 124
el15mh 1:bf0f64c26a0a 125 /** Stickman Three
el15mh 1:bf0f64c26a0a 126 *
el15mh 1:bf0f64c26a0a 127 * @details - Third animation in a series to create a jumping man. Used inside mazeCompleted() function.
el15mh 1:bf0f64c26a0a 128 * @param - lcd - N5110 Libarary used to print strings and draw bitmap.
el15mh 1:bf0f64c26a0a 129 *
el15mh 1:bf0f64c26a0a 130 */
el15mh 0:45606d84dad8 131 void stickmanThree(N5110 &lcd);
el15mh 1:bf0f64c26a0a 132
el15mh 1:bf0f64c26a0a 133 /** Stickman Four
el15mh 1:bf0f64c26a0a 134 *
el15mh 1:bf0f64c26a0a 135 * @details - Fourth animation in a series to create a jumping man. Used inside mazeCompleted() function.
el15mh 1:bf0f64c26a0a 136 * @param - lcd - N5110 Libarary used to print strings and draw bitmap.
el15mh 1:bf0f64c26a0a 137 *
el15mh 1:bf0f64c26a0a 138 */
el15mh 0:45606d84dad8 139 void stickmanFour(N5110 &lcd);
el15mh 1:bf0f64c26a0a 140
el15mh 1:bf0f64c26a0a 141 /** Stickman Five
el15mh 1:bf0f64c26a0a 142 *
el15mh 1:bf0f64c26a0a 143 * @details - Fifth animation in a series to create a jumping man. Used inside mazeCompleted() function.
el15mh 1:bf0f64c26a0a 144 * @param - lcd - N5110 Libarary used to print strings and draw bitmap.
el15mh 1:bf0f64c26a0a 145 *
el15mh 1:bf0f64c26a0a 146 */
el15mh 0:45606d84dad8 147 void stickmanFive(N5110 &lcd);
el15mh 1:bf0f64c26a0a 148
el15mh 1:bf0f64c26a0a 149 /** Stickman Six
el15mh 1:bf0f64c26a0a 150 *
el15mh 1:bf0f64c26a0a 151 * @details - Sixth animation in a series to create a jumping man. Used inside mazeCompleted() function.
el15mh 1:bf0f64c26a0a 152 * @param - lcd - N5110 Libarary used to print strings and draw bitmap.
el15mh 1:bf0f64c26a0a 153 *
el15mh 1:bf0f64c26a0a 154 */
el15mh 0:45606d84dad8 155 void stickmanSix(N5110 &lcd);
el15mh 0:45606d84dad8 156
el15mh 1:bf0f64c26a0a 157 /** Sound Switch
el15mh 1:bf0f64c26a0a 158 *
el15mh 1:bf0f64c26a0a 159 * @details - Function to display a switch a made up of one outer rectangle and two inner ones. At any given instant, only one of the inner rectangles is drawn. This is decided by the boolean value of 'tone'.
el15mh 1:bf0f64c26a0a 160 * @param - lcd - N5110 Libarary used to print rectangles on the screen.
el15mh 1:bf0f64c26a0a 161 * @param - tone - Boolean variable to dictate the appearance of the switch being drawn on the screen.
el15mh 1:bf0f64c26a0a 162 *
el15mh 1:bf0f64c26a0a 163 */
el15mh 0:45606d84dad8 164 void soundSwitch(N5110 &lcd, Gamepad &pad, bool tone);
el15mh 0:45606d84dad8 165
el15mh 0:45606d84dad8 166 private:
el15mh 0:45606d84dad8 167
el15mh 0:45606d84dad8 168 };
el15mh 0:45606d84dad8 169
el15mh 0:45606d84dad8 170 #endif /*ANIMATIONS_H*/