Henry Triff / Mbed 2 deprecated ELEC2645_Project_el18ht

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.

Dependencies:   mbed

Mechanics/Mechanics.h@22:9065c457a45d, 2020-03-28 (annotated)

Committer:
HenryWTriff
Date:
Sat Mar 28 14:56:39 2020 +0000
Revision:
22:9065c457a45d
Parent:
20:f8d7b04471b8
Child:
25:31761087a83f
Trying to fix issues with producing doxygen documentation - 1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
HenryWTriff 5:2d9f3c36bcb9 1 #ifndef MECHANICS_H
HenryWTriff 5:2d9f3c36bcb9 2 #define MECHANICS_H
HenryWTriff 5:2d9f3c36bcb9 3
HenryWTriff 5:2d9f3c36bcb9 4 #include "mbed.h"
HenryWTriff 5:2d9f3c36bcb9 5 #include "Gamepad.h"
HenryWTriff 5:2d9f3c36bcb9 6 #include "N5110.h"
HenryWTriff 6:5f76dd718dc3 7 #include "FXOS8700CQ.h"
HenryWTriff 5:2d9f3c36bcb9 8 #include "Graphics.h"
HenryWTriff 6:5f76dd718dc3 9 #include "Mechanics.h"
HenryWTriff 6:5f76dd718dc3 10 #include "Menu.h"
HenryWTriff 6:5f76dd718dc3 11 #include "LEDs.h"
HenryWTriff 6:5f76dd718dc3 12 #include "Ghost.h"
HenryWTriff 6:5f76dd718dc3 13 #include <string>
HenryWTriff 5:2d9f3c36bcb9 14
HenryWTriff 5:2d9f3c36bcb9 15 #ifndef STRUCTS
HenryWTriff 5:2d9f3c36bcb9 16 #define STRUCTS
HenryWTriff 5:2d9f3c36bcb9 17
HenryWTriff 5:2d9f3c36bcb9 18 //STRUCTS
HenryWTriff 5:2d9f3c36bcb9 19 struct Point_2D {
HenryWTriff 5:2d9f3c36bcb9 20 float x;
HenryWTriff 5:2d9f3c36bcb9 21 float y;
HenryWTriff 5:2d9f3c36bcb9 22 };
HenryWTriff 5:2d9f3c36bcb9 23 struct Line_2D {
HenryWTriff 5:2d9f3c36bcb9 24 Point_2D from;
HenryWTriff 5:2d9f3c36bcb9 25 Point_2D to;
HenryWTriff 5:2d9f3c36bcb9 26 };
HenryWTriff 5:2d9f3c36bcb9 27
HenryWTriff 5:2d9f3c36bcb9 28 struct Square_2D {
HenryWTriff 5:2d9f3c36bcb9 29 Point_2D TL;
HenryWTriff 5:2d9f3c36bcb9 30 Point_2D BR;
HenryWTriff 5:2d9f3c36bcb9 31 };
HenryWTriff 5:2d9f3c36bcb9 32 struct Triangle_2D {
HenryWTriff 5:2d9f3c36bcb9 33 Point_2D TL;
HenryWTriff 5:2d9f3c36bcb9 34 Point_2D BR;
HenryWTriff 5:2d9f3c36bcb9 35 int Type;
HenryWTriff 5:2d9f3c36bcb9 36 };
HenryWTriff 5:2d9f3c36bcb9 37
HenryWTriff 5:2d9f3c36bcb9 38 struct Map_Data {
HenryWTriff 5:2d9f3c36bcb9 39 int number_of_track_lines;
HenryWTriff 5:2d9f3c36bcb9 40 int number_of_dotted_lines;
HenryWTriff 5:2d9f3c36bcb9 41 int number_of_flags;
HenryWTriff 5:2d9f3c36bcb9 42 int number_of_walls;
HenryWTriff 5:2d9f3c36bcb9 43 int number_of_off_track_squares;
HenryWTriff 5:2d9f3c36bcb9 44 int number_of_off_track_triangles;
HenryWTriff 5:2d9f3c36bcb9 45 int number_of_out_of_bounds_squares;
HenryWTriff 5:2d9f3c36bcb9 46 int number_of_out_of_bounds_triangles;
HenryWTriff 5:2d9f3c36bcb9 47 int number_of_gates;
HenryWTriff 6:5f76dd718dc3 48 int number_of_boost_plates;
HenryWTriff 6:5f76dd718dc3 49 };
HenryWTriff 6:5f76dd718dc3 50
HenryWTriff 6:5f76dd718dc3 51 struct Time {
HenryWTriff 6:5f76dd718dc3 52 int mins;
HenryWTriff 6:5f76dd718dc3 53 int secs;
HenryWTriff 6:5f76dd718dc3 54 int milis;
HenryWTriff 6:5f76dd718dc3 55 };
HenryWTriff 6:5f76dd718dc3 56
HenryWTriff 6:5f76dd718dc3 57 struct Gyro_Data {
HenryWTriff 6:5f76dd718dc3 58 float ax;
HenryWTriff 6:5f76dd718dc3 59 float ay;
HenryWTriff 6:5f76dd718dc3 60 float az;
HenryWTriff 6:5f76dd718dc3 61 float mx;
HenryWTriff 6:5f76dd718dc3 62 float my;
HenryWTriff 6:5f76dd718dc3 63 float mz;
HenryWTriff 5:2d9f3c36bcb9 64 };
HenryWTriff 5:2d9f3c36bcb9 65
HenryWTriff 11:7b12992156de 66 #endif
HenryWTriff 7:2ce6e90f6d47 67
HenryWTriff 11:7b12992156de 68 #ifndef ENUMS
HenryWTriff 11:7b12992156de 69 #define ENUMS
HenryWTriff 11:7b12992156de 70 enum track {Small, Medium, Large};
HenryWTriff 11:7b12992156de 71 enum cars {Basic, Offroad, Drifter, Sportscar, Racecar, Stupid};
HenryWTriff 5:2d9f3c36bcb9 72 #endif
HenryWTriff 5:2d9f3c36bcb9 73
HenryWTriff 22:9065c457a45d 74 /** Mechanics Class
HenryWTriff 22:9065c457a45d 75 * @brief Operates the game.
HenryWTriff 22:9065c457a45d 76 * @author Henry W Triff
HenryWTriff 22:9065c457a45d 77 * @date Mar, 2020
HenryWTriff 22:9065c457a45d 78 */
HenryWTriff 22:9065c457a45d 79
HenryWTriff 5:2d9f3c36bcb9 80 class Mechanics
HenryWTriff 5:2d9f3c36bcb9 81 {
HenryWTriff 6:5f76dd718dc3 82 public:
HenryWTriff 20:f8d7b04471b8 83
HenryWTriff 20:f8d7b04471b8 84 /** Constructor */
HenryWTriff 20:f8d7b04471b8 85 Mechanics();
HenryWTriff 20:f8d7b04471b8 86
HenryWTriff 20:f8d7b04471b8 87 /** Destructor */
HenryWTriff 20:f8d7b04471b8 88 ~Mechanics();
HenryWTriff 20:f8d7b04471b8 89
HenryWTriff 19:0245df53e919 90 /** Checks the current position of the player to see if they are in the next gate, returns either the current gate or increases the gate
HenryWTriff 19:0245df53e919 91 * @param gates[] The array containing all the gates (Square_2D)
HenryWTriff 19:0245df53e919 92 * @param number_of_gates Number of gates in the array (int)
HenryWTriff 19:0245df53e919 93 * @param position This is the current position of the player (Point_2D)
HenryWTriff 19:0245df53e919 94 * @param current_gate The current gate that has been driven over (int)
HenryWTriff 19:0245df53e919 95 * @return Current gate number (int)
HenryWTriff 19:0245df53e919 96 */
HenryWTriff 9:7b1093d3f03a 97 int Get_Gate(const Square_2D gates[], int number_of_gates, Point_2D position, int current_gate);
HenryWTriff 19:0245df53e919 98
HenryWTriff 19:0245df53e919 99 /** Checks the current position of the player to see if they are about to complete a lap
HenryWTriff 19:0245df53e919 100 * @param laps The current number of laps (int)
HenryWTriff 19:0245df53e919 101 * @param gates[] The array containing all the gates (Square_2D)
HenryWTriff 19:0245df53e919 102 * @param number_of_gates Number of gates in the array (int)
HenryWTriff 19:0245df53e919 103 * @param position This is the current position of the player (Point_2D)
HenryWTriff 19:0245df53e919 104 * @param current_gate The current gate that has been driven over (int)
HenryWTriff 19:0245df53e919 105 * @return The new current number of laps (int)
HenryWTriff 19:0245df53e919 106 */
HenryWTriff 9:7b1093d3f03a 107 int Get_Laps(int laps, const Square_2D gates[], int number_of_gates, Point_2D position, int current_gate);
HenryWTriff 7:2ce6e90f6d47 108
HenryWTriff 19:0245df53e919 109 /** Converts between the number of elapsed frames to time in min,sec,mili
HenryWTriff 19:0245df53e919 110 * @param game_fps The fps of the game (int)
HenryWTriff 19:0245df53e919 111 * @param number_of_frames The number of frames elapsed so far during the current race (int)
HenryWTriff 19:0245df53e919 112 * @return The time in minutes, seconds, miliseconds format (Time)
HenryWTriff 19:0245df53e919 113 */
HenryWTriff 6:5f76dd718dc3 114 Time Convert_To_Time(int game_fps, int number_of_frames);
HenryWTriff 19:0245df53e919 115
HenryWTriff 19:0245df53e919 116 /** Returns the current angle of rotation of the map using the previos rotation
HenryWTriff 19:0245df53e919 117 * @param angle The currrent angle of roatation of the map (int)
HenryWTriff 19:0245df53e919 118 * @param handling The maximum number of degrees of rotation for that given cars handling (int)
HenryWTriff 19:0245df53e919 119 * @param gyro_enabled Has gyroscope steering been enabled in settings (bool)
HenryWTriff 19:0245df53e919 120 * @param Gyro The gyroscope class object (object)
HenryWTriff 19:0245df53e919 121 * @param Device The gamepad class object (Device)
HenryWTriff 19:0245df53e919 122 * @return The new current angle of map rotation (int)
HenryWTriff 19:0245df53e919 123 */
HenryWTriff 7:2ce6e90f6d47 124 int Get_Angle(int angle, int handling, bool gyro_enabled, FXOS8700CQ &Gyro, Gamepad &Device);
HenryWTriff 7:2ce6e90f6d47 125
HenryWTriff 19:0245df53e919 126 /** Returns the current map translation usung the previos translation
HenryWTriff 19:0245df53e919 127 * @param in The currrent map translation(Point_2D)
HenryWTriff 19:0245df53e919 128 * @param angle The current angle of roataion of the map [Drection of travel] (float)
HenryWTriff 19:0245df53e919 129 * @param speed The current of the player (float)
HenryWTriff 19:0245df53e919 130 * @param *out_of_bounds_square The pointer for the array of square out of bounds areas(Square_2D)
HenryWTriff 19:0245df53e919 131 * @param *out_of_bounds_triangle The pointer for the array of triange out of bounds areas(Triangle_2D)
HenryWTriff 19:0245df53e919 132 * @param map_info The number of elements in each array above (Map_Data)
HenryWTriff 19:0245df53e919 133 * @param Device The gamepad class object (Device)
HenryWTriff 19:0245df53e919 134 * @return The new current translation (Point_2D)
HenryWTriff 19:0245df53e919 135 */
HenryWTriff 19:0245df53e919 136 Point_2D Get_Translation(
HenryWTriff 19:0245df53e919 137 Point_2D in,
HenryWTriff 19:0245df53e919 138 float angle,
HenryWTriff 19:0245df53e919 139 float speed,
HenryWTriff 19:0245df53e919 140 const Square_2D *out_of_bounds_square,
HenryWTriff 19:0245df53e919 141 const Triangle_2D *out_of_bounds_triangle,
HenryWTriff 19:0245df53e919 142 const Map_Data map_info,
HenryWTriff 19:0245df53e919 143 Gamepad &Device
HenryWTriff 19:0245df53e919 144 );
HenryWTriff 19:0245df53e919 145
HenryWTriff 19:0245df53e919 146 /** Returns the current speed using the previos speed
HenryWTriff 19:0245df53e919 147 * @param speed The currrent speed(float)
HenryWTriff 19:0245df53e919 148 * @param max_speed The maximum speed of the chosen car (float)
HenryWTriff 19:0245df53e919 149 * @param acceleration The acceleration of the chosen car (float)
HenryWTriff 19:0245df53e919 150 * @param deceleration The deceleration of the chosen car (float)
HenryWTriff 19:0245df53e919 151 * @param off_track_speed The maximum speed when off track of the chosen car (float)
HenryWTriff 19:0245df53e919 152 * @param position The current position of the car (Point_2D)
HenryWTriff 19:0245df53e919 153 * @param *offtrack_square The pointer for the array of square of off track areas(Square_2D)
HenryWTriff 19:0245df53e919 154 * @param *offtrack_triangle The pointer for the array of triange of off track areas(Triangle_2D)
HenryWTriff 19:0245df53e919 155 * @param *out_of_bounds_square The pointer for the array of square out of bounds areas(Square_2D)
HenryWTriff 19:0245df53e919 156 * @param *out_of_bounds_triangle The pointer for the array of triange out of bounds areas(Triangle_2D)
HenryWTriff 19:0245df53e919 157 * @param *plates The pointer for the boost plates array (Triangle_2D)
HenryWTriff 19:0245df53e919 158 * @param map_info The number of elements in each array above (Map_Data)
HenryWTriff 19:0245df53e919 159 * @param Device The gamepad class object (Device)
HenryWTriff 19:0245df53e919 160 * @return The new current speed (float)
HenryWTriff 19:0245df53e919 161 */
HenryWTriff 7:2ce6e90f6d47 162 float Get_Speed(
HenryWTriff 7:2ce6e90f6d47 163 float speed,
HenryWTriff 7:2ce6e90f6d47 164 float max_speed,
HenryWTriff 7:2ce6e90f6d47 165 float acceleration,
HenryWTriff 7:2ce6e90f6d47 166 float deceleration,
HenryWTriff 7:2ce6e90f6d47 167 float off_track_speed,
HenryWTriff 7:2ce6e90f6d47 168 Point_2D position,
HenryWTriff 9:7b1093d3f03a 169 const Square_2D *offtrack_square,
HenryWTriff 9:7b1093d3f03a 170 const Triangle_2D *offtrack_triangle,
HenryWTriff 9:7b1093d3f03a 171 const Square_2D *out_of_bounds_square,
HenryWTriff 9:7b1093d3f03a 172 const Triangle_2D *out_of_bounds_triangle,
HenryWTriff 9:7b1093d3f03a 173 const Triangle_2D *plates,
HenryWTriff 9:7b1093d3f03a 174 const Map_Data map_info,
HenryWTriff 7:2ce6e90f6d47 175 Gamepad &Device
HenryWTriff 7:2ce6e90f6d47 176 );
HenryWTriff 7:2ce6e90f6d47 177
HenryWTriff 19:0245df53e919 178 /** Returns the max speed for the chosen vehicle
HenryWTriff 19:0245df53e919 179 * @param car_model The chosen car model (int)
HenryWTriff 19:0245df53e919 180 * @return The maximum speed (float)
HenryWTriff 19:0245df53e919 181 */
HenryWTriff 7:2ce6e90f6d47 182 float Get_Max_Speed(int car_model);
HenryWTriff 19:0245df53e919 183
HenryWTriff 19:0245df53e919 184 /** Returns the acceleration for the chosen vehicle
HenryWTriff 19:0245df53e919 185 * @param car_model The chosen car model (int)
HenryWTriff 19:0245df53e919 186 * @return The acceleration (float)
HenryWTriff 19:0245df53e919 187 */
HenryWTriff 7:2ce6e90f6d47 188 float Get_Acceleration(int car_model);
HenryWTriff 19:0245df53e919 189
HenryWTriff 19:0245df53e919 190 /** Returns the decleration for the chosen vehicle
HenryWTriff 19:0245df53e919 191 * @param car_model The chosen car model (int)
HenryWTriff 19:0245df53e919 192 * @return The deceleration (float)
HenryWTriff 19:0245df53e919 193 */
HenryWTriff 7:2ce6e90f6d47 194 float Get_Deceleration(int car_model);
HenryWTriff 19:0245df53e919 195
HenryWTriff 19:0245df53e919 196 /** Returns the max speed when off road for the chosen vehicle
HenryWTriff 19:0245df53e919 197 * @param car_model The chosen car model (int)
HenryWTriff 19:0245df53e919 198 * @return The maximum speed when off road (float)
HenryWTriff 19:0245df53e919 199 */
HenryWTriff 7:2ce6e90f6d47 200 float Get_Off_Road_Speed(int car_model);
HenryWTriff 19:0245df53e919 201
HenryWTriff 19:0245df53e919 202 /** Returns the handling of the chosen vehicle
HenryWTriff 19:0245df53e919 203 * @param car_model The chosen car model (int)
HenryWTriff 19:0245df53e919 204 * @return The handling (float)
HenryWTriff 19:0245df53e919 205 */
HenryWTriff 7:2ce6e90f6d47 206 int Get_Handling(int car_model);
HenryWTriff 7:2ce6e90f6d47 207
HenryWTriff 6:5f76dd718dc3 208 private:
HenryWTriff 7:2ce6e90f6d47 209 //SPEED
HenryWTriff 9:7b1093d3f03a 210 bool Is_Offtrack(Point_2D position, const Square_2D offtrack_square[], const Triangle_2D offtrack_triangle[], const Map_Data map_info);
HenryWTriff 9:7b1093d3f03a 211 bool Is_Out_Of_Bounds(Point_2D position, const Square_2D offtrack_square[], const Triangle_2D offtrack_triangle[], const Map_Data map_info);
HenryWTriff 9:7b1093d3f03a 212 bool Is_Offtrack_Square(const Square_2D offtrack[], int size, Point_2D position);
HenryWTriff 9:7b1093d3f03a 213 bool Is_Offtrack_Triangle(const Triangle_2D offtrack[], int size, Point_2D position);
HenryWTriff 9:7b1093d3f03a 214 bool Is_Out_Of_Bounds_Square(const Square_2D out_of_bounds[], int size, Point_2D position);
HenryWTriff 9:7b1093d3f03a 215 bool Is_Out_Of_Bounds_Triangle(const Triangle_2D out_of_bounds[], int size, Point_2D position);
HenryWTriff 9:7b1093d3f03a 216 float Get_Boost_Speed(const Triangle_2D plates[], int number_of_plates, Point_2D position, float speed);
HenryWTriff 7:2ce6e90f6d47 217
HenryWTriff 5:2d9f3c36bcb9 218 };
HenryWTriff 5:2d9f3c36bcb9 219
HenryWTriff 5:2d9f3c36bcb9 220 #endif