Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Ghost/Ghost.h@16:17f91f51358f, 2020-03-28 (annotated)
- Committer:
- HenryWTriff
- Date:
- Sat Mar 28 12:41:25 2020 +0000
- Revision:
- 16:17f91f51358f
- Parent:
- 11:7b12992156de
- Child:
- 22:9065c457a45d
Ghost Documentation Done
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
HenryWTriff | 6:5f76dd718dc3 | 1 | #ifndef GHOST_H |
HenryWTriff | 6:5f76dd718dc3 | 2 | #define GHOST_H |
HenryWTriff | 6:5f76dd718dc3 | 3 | |
HenryWTriff | 6:5f76dd718dc3 | 4 | #include "mbed.h" |
HenryWTriff | 6:5f76dd718dc3 | 5 | #include "Gamepad.h" |
HenryWTriff | 6:5f76dd718dc3 | 6 | #include "N5110.h" |
HenryWTriff | 6:5f76dd718dc3 | 7 | #include "FXOS8700CQ.h" |
HenryWTriff | 10:29126a41b1da | 8 | #include "SDFileSystem.h" |
HenryWTriff | 6:5f76dd718dc3 | 9 | #include "Graphics.h" |
HenryWTriff | 6:5f76dd718dc3 | 10 | #include "Mechanics.h" |
HenryWTriff | 6:5f76dd718dc3 | 11 | #include "Menu.h" |
HenryWTriff | 6:5f76dd718dc3 | 12 | #include "LEDs.h" |
HenryWTriff | 6:5f76dd718dc3 | 13 | #include "Ghost.h" |
HenryWTriff | 6:5f76dd718dc3 | 14 | #include <string> |
HenryWTriff | 6:5f76dd718dc3 | 15 | |
HenryWTriff | 16:17f91f51358f | 16 | /** Ghost Class |
HenryWTriff | 16:17f91f51358f | 17 | * @brief Records the current position of the player so that it can be played back later during ghost mode. |
HenryWTriff | 16:17f91f51358f | 18 | * @brief The best race (so far) is copied to the SD card when the race is over. |
HenryWTriff | 16:17f91f51358f | 19 | * @brief Before each race, the previos best ghost data is read from the SD card to internal memory to allow the game to run faster. |
HenryWTriff | 16:17f91f51358f | 20 | * @author Henry W Triff |
HenryWTriff | 16:17f91f51358f | 21 | * @date Mar, 2020 |
HenryWTriff | 16:17f91f51358f | 22 | */ |
HenryWTriff | 16:17f91f51358f | 23 | |
HenryWTriff | 6:5f76dd718dc3 | 24 | #ifndef STRUCTS |
HenryWTriff | 6:5f76dd718dc3 | 25 | #define STRUCTS |
HenryWTriff | 6:5f76dd718dc3 | 26 | |
HenryWTriff | 6:5f76dd718dc3 | 27 | //STRUCTS |
HenryWTriff | 6:5f76dd718dc3 | 28 | struct Point_2D { |
HenryWTriff | 6:5f76dd718dc3 | 29 | float x; |
HenryWTriff | 6:5f76dd718dc3 | 30 | float y; |
HenryWTriff | 6:5f76dd718dc3 | 31 | }; |
HenryWTriff | 6:5f76dd718dc3 | 32 | struct Line_2D { |
HenryWTriff | 6:5f76dd718dc3 | 33 | Point_2D from; |
HenryWTriff | 6:5f76dd718dc3 | 34 | Point_2D to; |
HenryWTriff | 6:5f76dd718dc3 | 35 | }; |
HenryWTriff | 6:5f76dd718dc3 | 36 | |
HenryWTriff | 6:5f76dd718dc3 | 37 | struct Square_2D { |
HenryWTriff | 6:5f76dd718dc3 | 38 | Point_2D TL; |
HenryWTriff | 6:5f76dd718dc3 | 39 | Point_2D BR; |
HenryWTriff | 6:5f76dd718dc3 | 40 | }; |
HenryWTriff | 6:5f76dd718dc3 | 41 | struct Triangle_2D { |
HenryWTriff | 6:5f76dd718dc3 | 42 | Point_2D TL; |
HenryWTriff | 6:5f76dd718dc3 | 43 | Point_2D BR; |
HenryWTriff | 6:5f76dd718dc3 | 44 | int Type; |
HenryWTriff | 6:5f76dd718dc3 | 45 | }; |
HenryWTriff | 6:5f76dd718dc3 | 46 | |
HenryWTriff | 6:5f76dd718dc3 | 47 | struct Map_Data { |
HenryWTriff | 6:5f76dd718dc3 | 48 | int number_of_track_lines; |
HenryWTriff | 6:5f76dd718dc3 | 49 | int number_of_dotted_lines; |
HenryWTriff | 6:5f76dd718dc3 | 50 | int number_of_flags; |
HenryWTriff | 6:5f76dd718dc3 | 51 | int number_of_walls; |
HenryWTriff | 6:5f76dd718dc3 | 52 | int number_of_off_track_squares; |
HenryWTriff | 6:5f76dd718dc3 | 53 | int number_of_off_track_triangles; |
HenryWTriff | 6:5f76dd718dc3 | 54 | int number_of_out_of_bounds_squares; |
HenryWTriff | 6:5f76dd718dc3 | 55 | int number_of_out_of_bounds_triangles; |
HenryWTriff | 6:5f76dd718dc3 | 56 | int number_of_gates; |
HenryWTriff | 6:5f76dd718dc3 | 57 | int number_of_boost_plates; |
HenryWTriff | 6:5f76dd718dc3 | 58 | }; |
HenryWTriff | 6:5f76dd718dc3 | 59 | |
HenryWTriff | 6:5f76dd718dc3 | 60 | struct Time { |
HenryWTriff | 6:5f76dd718dc3 | 61 | int mins; |
HenryWTriff | 6:5f76dd718dc3 | 62 | int secs; |
HenryWTriff | 6:5f76dd718dc3 | 63 | int milis; |
HenryWTriff | 6:5f76dd718dc3 | 64 | }; |
HenryWTriff | 6:5f76dd718dc3 | 65 | |
HenryWTriff | 6:5f76dd718dc3 | 66 | struct Gyro_Data { |
HenryWTriff | 6:5f76dd718dc3 | 67 | float ax; |
HenryWTriff | 6:5f76dd718dc3 | 68 | float ay; |
HenryWTriff | 6:5f76dd718dc3 | 69 | float az; |
HenryWTriff | 6:5f76dd718dc3 | 70 | float mx; |
HenryWTriff | 6:5f76dd718dc3 | 71 | float my; |
HenryWTriff | 6:5f76dd718dc3 | 72 | float mz; |
HenryWTriff | 6:5f76dd718dc3 | 73 | }; |
HenryWTriff | 6:5f76dd718dc3 | 74 | |
HenryWTriff | 6:5f76dd718dc3 | 75 | #endif |
HenryWTriff | 6:5f76dd718dc3 | 76 | |
HenryWTriff | 6:5f76dd718dc3 | 77 | static Point_2D Ghost_Data[6000]; |
HenryWTriff | 6:5f76dd718dc3 | 78 | static int Ghost_Held_Data_Time = 0; |
HenryWTriff | 6:5f76dd718dc3 | 79 | static Point_2D Ghost_Held_Data[6000]; |
HenryWTriff | 6:5f76dd718dc3 | 80 | |
HenryWTriff | 10:29126a41b1da | 81 | #ifndef ENUMS |
HenryWTriff | 10:29126a41b1da | 82 | #define ENUMS |
HenryWTriff | 10:29126a41b1da | 83 | enum track {Small, Medium, Large}; |
HenryWTriff | 10:29126a41b1da | 84 | enum cars {Basic, Offroad, Drifter, Sportscar, Racecar, Stupid}; |
HenryWTriff | 10:29126a41b1da | 85 | #endif |
HenryWTriff | 10:29126a41b1da | 86 | |
HenryWTriff | 6:5f76dd718dc3 | 87 | class Ghost |
HenryWTriff | 6:5f76dd718dc3 | 88 | { |
HenryWTriff | 6:5f76dd718dc3 | 89 | public: |
HenryWTriff | 6:5f76dd718dc3 | 90 | |
HenryWTriff | 16:17f91f51358f | 91 | /** Constructor */ |
HenryWTriff | 16:17f91f51358f | 92 | Ghost(); |
HenryWTriff | 16:17f91f51358f | 93 | |
HenryWTriff | 16:17f91f51358f | 94 | /** Destructor */ |
HenryWTriff | 16:17f91f51358f | 95 | ~Ghost(); |
HenryWTriff | 16:17f91f51358f | 96 | |
HenryWTriff | 16:17f91f51358f | 97 | /** Formats the SD card with the correct text files and fills them with temporary data. |
HenryWTriff | 16:17f91f51358f | 98 | * @param SD The object for the SDFileSystem class (object). |
HenryWTriff | 16:17f91f51358f | 99 | */ |
HenryWTriff | 16:17f91f51358f | 100 | void SD_init(SDFileSystem &SD); |
HenryWTriff | 16:17f91f51358f | 101 | |
HenryWTriff | 16:17f91f51358f | 102 | /** Copies the ghost data int the txt file associated with the track-car combination to RAM |
HenryWTriff | 16:17f91f51358f | 103 | * @param track The user selected track (int) |
HenryWTriff | 16:17f91f51358f | 104 | * @param car The user selected car (int) |
HenryWTriff | 16:17f91f51358f | 105 | * @param SD The object for the SDFileSystem class (object) |
HenryWTriff | 16:17f91f51358f | 106 | */ |
HenryWTriff | 10:29126a41b1da | 107 | void SD_Read(int track, int car, SDFileSystem &SD); |
HenryWTriff | 10:29126a41b1da | 108 | |
HenryWTriff | 16:17f91f51358f | 109 | /** Adds the current position of the car to a Ghost_Data array |
HenryWTriff | 16:17f91f51358f | 110 | * @param position The current coordinate position of the players car (Point_2D) |
HenryWTriff | 16:17f91f51358f | 111 | * @param race_time The current number of frames elapsed during race |
HenryWTriff | 16:17f91f51358f | 112 | */ |
HenryWTriff | 16:17f91f51358f | 113 | void Record(Point_2D position, int race_time); |
HenryWTriff | 16:17f91f51358f | 114 | |
HenryWTriff | 16:17f91f51358f | 115 | /** If the race that was just run was faster than previos races, this copies the data in the Ghost_Data array to the SD card |
HenryWTriff | 16:17f91f51358f | 116 | * @param race_time The number of frames elapsed during race |
HenryWTriff | 16:17f91f51358f | 117 | * @param track The user selected track (int) |
HenryWTriff | 16:17f91f51358f | 118 | * @param car The user selected car (int) |
HenryWTriff | 16:17f91f51358f | 119 | * @param SD The object for the SDFileSystem class (object) |
HenryWTriff | 16:17f91f51358f | 120 | */ |
HenryWTriff | 16:17f91f51358f | 121 | void Copy(int race_time, int track, int car, SDFileSystem &SD); |
HenryWTriff | 16:17f91f51358f | 122 | |
HenryWTriff | 16:17f91f51358f | 123 | /** Returns the position of the ghost for a given race_time |
HenryWTriff | 16:17f91f51358f | 124 | * @param ghost_available Is the game in ghost mode (bool) |
HenryWTriff | 16:17f91f51358f | 125 | * @param race_time The current number of frames elapsed during race (int) |
HenryWTriff | 16:17f91f51358f | 126 | * @return Current position of the ghost |
HenryWTriff | 16:17f91f51358f | 127 | */ |
HenryWTriff | 16:17f91f51358f | 128 | Point_2D Play(bool ghost_available, int race_time); |
HenryWTriff | 16:17f91f51358f | 129 | |
HenryWTriff | 16:17f91f51358f | 130 | private: |
HenryWTriff | 16:17f91f51358f | 131 | |
HenryWTriff | 16:17f91f51358f | 132 | void SD_Write(int track, int car, int race_time, SDFileSystem &SD); |
HenryWTriff | 10:29126a41b1da | 133 | void SD_Write_Data(string name, int race_time, SDFileSystem &SD); |
HenryWTriff | 10:29126a41b1da | 134 | void SD_Write_Time(int track, int car, int race_time, SDFileSystem &SD); |
HenryWTriff | 10:29126a41b1da | 135 | void SD_Read_Data(string name, int race_time, SDFileSystem &SD); |
HenryWTriff | 10:29126a41b1da | 136 | void SD_Read_Time(int track, int car, SDFileSystem &SD); |
HenryWTriff | 10:29126a41b1da | 137 | int SD_Get_Time(int track, int car, SDFileSystem &SD); |
HenryWTriff | 6:5f76dd718dc3 | 138 | |
HenryWTriff | 6:5f76dd718dc3 | 139 | }; |
HenryWTriff | 6:5f76dd718dc3 | 140 | |
HenryWTriff | 6:5f76dd718dc3 | 141 | #endif |