A reimplementation of Mario Kart Wii's physics engine in C++
Loading...
Searching...
No Matches
Common.hh
Go to the documentation of this file.
1
3
4#pragma once
5
6#include <Logger.hh>
7
8#include <egg/core/Heap.hh>
9
10#include <array>
11#include <cassert>
12#include <limits>
13#include <type_traits>
14#include <utility>
15
16typedef int8_t s8;
17typedef int16_t s16;
18typedef int32_t s32;
19typedef int64_t s64;
20
21typedef uint8_t u8;
22typedef uint16_t u16;
23typedef uint32_t u32;
24typedef uint64_t u64;
25
26typedef float f32;
27typedef double f64;
28
29enum class Course {
30 Mario_Circuit = 0,
31 Moo_Moo_Meadows = 1,
32 Mushroom_Gorge = 2,
33 Grumble_Volcano = 3,
34 Toads_Factory = 4,
35 Coconut_Mall = 5,
36 DK_Summit = 6,
37 Wario_Gold_Mine = 7,
38 Luigi_Circuit = 8,
39 Daisy_Circuit = 9,
40 Moonview_Highway = 10,
41 Maple_Treeway = 11,
42 Bowsers_Castle = 12,
43 Rainbow_Road = 13,
44 Dry_Dry_Ruins = 14,
45 Koopa_Cape = 15,
46 GCN_Peach_Beach = 16,
47 GCN_Mario_Circuit = 17,
48 GCN_Waluigi_Stadium = 18,
49 GCN_DK_Mountain = 19,
50 DS_Yoshi_Falls = 20,
51 DS_Desert_Hills = 21,
52 DS_Peach_Gardens = 22,
53 DS_Delfino_Square = 23,
54 SNES_Mario_Circuit_3 = 24,
55 SNES_Ghost_Valley_2 = 25,
56 N64_Mario_Raceway = 26,
57 N64_Sherbet_Land = 27,
58 N64_Bowsers_Castle = 28,
59 N64_DKs_Jungle_Parkway = 29,
60 GBA_Bowser_Castle_3 = 30,
61 GBA_Shy_Guy_Beach = 31,
62 Delfino_Pier = 32,
63 Block_Plaza = 33,
64 Chain_Chomp_Roulette = 34,
65 Funky_Stadium = 35,
66 Thwomp_Desert = 36,
67 GCN_Cookie_Land = 37,
68 DS_Twilight_House = 38,
69 SNES_Battle_Course_4 = 39,
70 GBA_Battle_Course_3 = 40,
71 N64_Skyscraper = 41,
72 Galaxy_Colosseum = 54,
73 Win_Demo = 55,
74 Lose_Demo = 56,
75 Draw_Demo = 57,
76 Ending_Demo = 58,
77};
78
79enum class Vehicle {
80 Standard_Kart_S = 0,
81 Standard_Kart_M = 1,
82 Standard_Kart_L = 2,
83 Baby_Booster = 3,
84 Classic_Dragster = 4,
85 Offroader = 5,
86 Mini_Beast = 6,
87 Wild_Wing = 7,
88 Flame_Flyer = 8,
89 Cheep_Charger = 9,
90 Super_Blooper = 10,
91 Piranha_Prowler = 11,
92 Tiny_Titan = 12,
93 Daytripper = 13,
94 Jetsetter = 14,
95 Blue_Falcon = 15,
96 Sprinter = 16,
97 Honeycoupe = 17,
98 Standard_Bike_S = 18,
99 Standard_Bike_M = 19,
100 Standard_Bike_L = 20,
101 Bullet_Bike = 21,
102 Mach_Bike = 22,
103 Flame_Runner = 23,
104 Bit_Bike = 24,
105 Sugarscoot = 25,
106 Wario_Bike = 26,
107 Quacker = 27,
108 Zip_Zip = 28,
109 Shooting_Star = 29,
110 Magikruiser = 30,
111 Sneakster = 31,
112 Spear = 32,
113 Jet_Bubble = 33,
114 Dolphin_Dasher = 34,
115 Phantom = 35,
116 Max = 36,
117};
118
119enum class Character {
120 Mario = 0,
121 Baby_Peach = 1,
122 Waluigi = 2,
123 Bowser = 3,
124 Baby_Daisy = 4,
125 Dry_Bones = 5,
126 Baby_Mario = 6,
127 Luigi = 7,
128 Toad = 8,
129 Donkey_Kong = 9,
130 Yoshi = 10,
131 Wario = 11,
132 Baby_Luigi = 12,
133 Toadette = 13,
134 Koopa_Troopa = 14,
135 Daisy = 15,
136 Peach = 16,
137 Birdo = 17,
138 Diddy_Kong = 18,
139 King_Boo = 19,
140 Bowser_Jr = 20,
141 Dry_Bowser = 21,
142 Funky_Kong = 22,
143 Rosalina = 23,
144 Small_Mii_Outfit_A_Male = 24,
145 Small_Mii_Outfit_A_Female = 25,
146 Small_Mii_Outfit_B_Male = 26,
147 Small_Mii_Outfit_B_Female = 27,
148 Small_Mii_Outfit_C_Male = 28,
149 Small_Mii_Outfit_C_Female = 29,
150 Medium_Mii_Outfit_A_Male = 30,
151 Medium_Mii_Outfit_A_Female = 31,
152 Medium_Mii_Outfit_B_Male = 32,
153 Medium_Mii_Outfit_B_Female = 33,
154 Medium_Mii_Outfit_C_Male = 34,
155 Medium_Mii_Outfit_C_Female = 35,
156 Large_Mii_Outfit_A_Male = 36,
157 Large_Mii_Outfit_A_Female = 37,
158 Large_Mii_Outfit_B_Male = 38,
159 Large_Mii_Outfit_B_Female = 39,
160 Large_Mii_Outfit_C_Male = 40,
161 Large_Mii_Outfit_C_Female = 41,
162 Medium_Mii = 42,
163 Small_Mii = 43,
164 Large_Mii = 44,
165 Peach_Biker_Outfit = 45,
166 Daisy_Biker_Outfit = 46,
167 Rosalina_Biker_Outfit = 47,
168 Max = 48,
169};
170
171enum class WeightClass {
172 Invalid = -1,
173 Light = 0,
174 Medium = 1,
175 Heavy = 2,
176};
177
178enum class GroupID : u16 {
179 None = 0,
180 Race = 1,
181 Gfx = 2,
182 Kart = 3,
183 Object = 4,
184 Course = 5,
185 UI = 6,
186 Effect = 7,
187 Sound = 8,
188 Resource = 10,
189 HomeMenu = 11,
190 Item = 12,
191 Net = 13,
192};
193
194static constexpr WeightClass CharacterToWeight(Character character) {
195 switch (character) {
196 case Character::Baby_Peach:
197 case Character::Baby_Daisy... Character::Baby_Mario:
198 case Character::Toad:
199 case Character::Baby_Luigi... Character::Koopa_Troopa:
200 case Character::Small_Mii_Outfit_A_Male... Character::Small_Mii_Outfit_C_Female:
201 case Character::Small_Mii:
202 return WeightClass::Light;
203 case Character::Mario:
204 case Character::Luigi:
205 case Character::Yoshi:
206 case Character::Daisy... Character::Diddy_Kong:
207 case Character::Bowser_Jr:
208 case Character::Medium_Mii_Outfit_A_Male... Character::Medium_Mii_Outfit_C_Female:
209 case Character::Medium_Mii:
210 case Character::Peach_Biker_Outfit:
211 case Character::Daisy_Biker_Outfit:
212 return WeightClass::Medium;
213 case Character::Waluigi:
214 case Character::Bowser:
215 case Character::Donkey_Kong:
216 case Character::Wario:
217 case Character::King_Boo:
218 case Character::Dry_Bowser... Character::Rosalina:
219 case Character::Large_Mii_Outfit_A_Male... Character::Large_Mii_Outfit_C_Female:
220 case Character::Large_Mii:
221 case Character::Rosalina_Biker_Outfit:
222 return WeightClass::Heavy;
223 default:
224 return WeightClass::Invalid;
225 }
226}
227
228static constexpr WeightClass VehicleToWeight(Vehicle vehicle) {
229 switch (vehicle) {
230 case Vehicle::Standard_Kart_S:
231 case Vehicle::Baby_Booster:
232 case Vehicle::Mini_Beast:
233 case Vehicle::Cheep_Charger:
234 case Vehicle::Tiny_Titan:
235 case Vehicle::Blue_Falcon:
236 case Vehicle::Standard_Bike_S:
237 case Vehicle::Bullet_Bike:
238 case Vehicle::Bit_Bike:
239 case Vehicle::Quacker:
240 case Vehicle::Magikruiser:
241 case Vehicle::Jet_Bubble:
242 return WeightClass::Light;
243 case Vehicle::Standard_Kart_M:
244 case Vehicle::Classic_Dragster:
245 case Vehicle::Wild_Wing:
246 case Vehicle::Super_Blooper:
247 case Vehicle::Daytripper:
248 case Vehicle::Sprinter:
249 case Vehicle::Standard_Bike_M:
250 case Vehicle::Mach_Bike:
251 case Vehicle::Sugarscoot:
252 case Vehicle::Zip_Zip:
253 case Vehicle::Sneakster:
254 case Vehicle::Dolphin_Dasher:
255 return WeightClass::Medium;
256 case Vehicle::Standard_Kart_L:
257 case Vehicle::Offroader:
258 case Vehicle::Flame_Flyer:
259 case Vehicle::Piranha_Prowler:
260 case Vehicle::Jetsetter:
261 case Vehicle::Honeycoupe:
262 case Vehicle::Standard_Bike_L:
263 case Vehicle::Flame_Runner:
264 case Vehicle::Wario_Bike:
265 case Vehicle::Shooting_Star:
266 case Vehicle::Spear:
267 case Vehicle::Phantom:
268 return WeightClass::Heavy;
269 default:
270 return WeightClass::Invalid;
271 }
272}
273
274static constexpr const char *COURSE_NAMES[59] = {
275 "castle_course",
276 "farm_course",
277 "kinoko_course",
278 "volcano_course",
279 "factory_course",
280 "shopping_course",
281 "boardcross_course",
282 "truck_course",
283 "beginner_course",
284 "senior_course",
285 "ridgehighway_course",
286 "treehouse_course",
287 "koopa_course",
288 "rainbow_course",
289 "desert_course",
290 "water_course",
291 "old_peach_gc",
292 "old_mario_gc",
293 "old_waluigi_gc",
294 "old_donkey_gc",
295 "old_falls_ds",
296 "old_desert_ds",
297 "old_garden_ds",
298 "old_town_ds",
299 "old_mario_sfc",
300 "old_obake_sfc",
301 "old_mario_64",
302 "old_sherbet_64",
303 "old_koopa_64",
304 "old_donkey_64",
305 "old_koopa_gba",
306 "old_heyho_gba",
307 "venice_battle",
308 "block_battle",
309 "casino_battle",
310 "skate_battle",
311 "sand_battle",
312 "old_CookieLand_gc",
313 "old_House_ds",
314 "old_battle4_sfc",
315 "old_battle3_gba",
316 "old_matenro_64",
317 nullptr,
318 nullptr,
319 nullptr,
320 nullptr,
321 nullptr,
322 nullptr,
323 nullptr,
324 nullptr,
325 nullptr,
326 nullptr,
327 nullptr,
328 nullptr,
329 "ring_mission",
330 "winningrun_demo",
331 "loser_demo",
332 "draw_dmeo",
333 "ending_demo",
334};
335
336static constexpr const char *VEHICLE_NAMES[36] = {
337 "sdf_kart",
338 "mdf_kart",
339 "ldf_kart",
340 "sa_kart",
341 "ma_kart",
342 "la_kart",
343 "sb_kart",
344 "mb_kart",
345 "lb_kart",
346 "sc_kart",
347 "mc_kart",
348 "lc_kart",
349 "sd_kart",
350 "md_kart",
351 "ld_kart",
352 "se_kart",
353 "me_kart",
354 "le_kart",
355 "sdf_bike",
356 "mdf_bike",
357 "ldf_bike",
358 "sa_bike",
359 "ma_bike",
360 "la_bike",
361 "sb_bike",
362 "mb_bike",
363 "lb_bike",
364 "sc_bike",
365 "mc_bike",
366 "lc_bike",
367 "sd_bike",
368 "md_bike",
369 "ld_bike",
370 "se_bike",
371 "me_bike",
372 "le_bike",
373};
374
375STATIC_ASSERT(std::numeric_limits<f32>::epsilon() == 1.0f / 8388608.0f);
376STATIC_ASSERT(
377 std::endian::native == std::endian::big || std::endian::native == std::endian::little);
378
382template <template <typename...> class Base, typename Derived>
383struct is_derived_from_template {
384private:
385 template <typename... Ts>
386 static std::true_type test(const Base<Ts...> *);
387
388 static std::false_type test(...);
389
390public:
391 static constexpr bool value = decltype(test(std::declval<Derived *>()))::value;
392};
393
394template <template <typename...> class Base, typename Derived>
395inline constexpr bool is_derived_from_template_v = is_derived_from_template<Base, Derived>::value;
396
397template <typename T>
398concept IntegralType = std::is_integral_v<T>;
399
400template <typename T>
401concept ParseableType = std::is_integral_v<T> ||
402 (std::is_floating_point_v<T> && (sizeof(T) == 4 || sizeof(T) == 8));
403
404// Form data into integral value
405template <IntegralType T>
406static inline T form(const u8 *data) {
407 T result = 0;
408 for (size_t i = 0; i < sizeof(T); ++i) {
409 result = (result << 8) | data[i];
410 }
411 return result;
412}
413
414// Consistent file parsing with byte-swappable values
415template <ParseableType T>
416static inline constexpr T parse(T val, std::endian endian = std::endian::big) {
417 if constexpr (std::is_integral_v<T>) {
418 return endian == std::endian::native ? val : std::byteswap(val);
419 } else {
420 if constexpr (sizeof(T) == 4) {
421 return std::bit_cast<T>(parse<u32>(std::bit_cast<u32>(val), endian));
422 } else {
423 return std::bit_cast<T>(parse<u64>(std::bit_cast<u64>(val), endian));
424 }
425 }
426}
427
428// Helper function to allow hex representation of f32
429static inline constexpr u32 f2u(f32 val) {
430 return std::bit_cast<u32>(val);
431}
uint16_t
Item
Pertains to item handling.
Definition ItemDirector.cc:5
Kart
Pertains to kart-related functionality.
Definition BoxColManager.hh:6
is_derived_from_template
Helper template which uses function overloading and implict up-casting to determine whether or not a ...
Definition Common.hh:383