Update decomp clang (#67)

* Update menus.c (#634)

* Update common_data.yml (#635)

* Renames for screenId and other changes (#636)

* screenId renames

* Rename surface map to collision mesh (#637)

* Rename some stack vars (#638)

* Fix syntax error (#639)

* Rename some stack vars

* Update collision.c

* Collision Documentation (#640)

* Collision related renames

* update doxygen (#649)

* change bool (#644)

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>

* Update (#642)

* Delete trig_tables_bss.c (#650)

* fix typo audio (#656)

* fix typo src actor (#657)

Co-authored-by: MegaMech <MegaMech@users.noreply.github.com>

* fix typo include (#658)

* fix course (#659)

* fix typo debug (#660)

* fix typo data (#661)

* replace number with const (#665)

* fix typo buffers (#655)

* fix typo buffers

* tweak ld file

* rename to sMemoryPool

* add a warning

---------

* fix typo src (#654)

* fix typo src

* fix non matcing

* Update code_80091750.c

---------

* fix typo racing (#653)

* fix typo racing

* get it match

* replace G_LINE3D to G_QUAD

---------

* fix typo src (#652)

* fix ending typo (#651)

* Action more info when it doesn't match and fix first diff (#662)

* Update linux-compile.yml

* fix first-diff

* Update first-diff.py

---------

* document texture of kart (#663)

* document texture of kart

* change screenPlayerId to screenId

* some documentation around object

* Revert "some documentation around object"

This reverts commit cbb39078e036bf2a417bed67359e910213acab28.

* more rename

---------

* Make evaluate_collision_players_palm_tree better (#667)

This matches just the same as before,	but using those two casts instead of
shifts seems more likely to be accurate to the original source code

Signed-off-by: Gabriel Ravier <gabravier@gmail.com>

* add fedora instruciton (#666)

* start documenting animation (#668)

* start documenting animation

* Update course_data.c

* change comment

* update libultra asm (#648)

* update libultra asm

* fix gcc __osThreadTail

---------

* Document Vehicles (#641)

* start doc collision

* fix merge

* finish rename fonction related to vehicle

* document around waypoint of vehicle

* make some modification

* make some change and rename one

* copy_ to oldPos

* doc smoke ferry and train

* some rename

* fix some renaming

* precise index

* rename a funciton

* simplify waypoint_vehicles

* change some name

* change some name

* rename move_to_point_direction

* fix some conflict

* Update code_80005FD0.c

* Update code_80005FD0.h

---------

* Label a save info loop (#645)

* save info

* more gcc progress

* fix a value and do a rename (#669)

* update clang and add action (#664)

* update clang and add action

* try clang on course folder only

* forget two file

* Update course_displaylists.inc.c

* forget few other file

* Update course_vertices.inc.c

* format all code while get it match

* second pass

* format other dir

* disable clang format on bad ido code

* fix some tabulation

* revert format on tool dir

* Update clang-format.yml

* ignore gbi.h

* add some read me instruction

* fix error

* format and fixing error

* Update README.md

---------

* Update linkonly_generator.py (#670)

* format more file

* update

* fix compilation issue

* remove course_metadata folder

* re add course metadata folder

* fix banshee bordwalk crash

* fix windows eurk

* Update CMakeLists.txt

---------

1 files changed, 35 insertions, 34 deletions

diff --git a/src/animation.h b/src/animation.h
index b363dcf1c..7fc35a6dd 100644
--- a/src/animation.h
+++ b/src/animation.h
@@ -6,10 +6,10 @@
 /*
 What I know about animation stuff so far
 
-Its not clear to me exactly what animations even are in MK64, my speculation is that their some form of matrix manipulation sequence.
-Presumably the "models" of the objects that are getting animated are a bunch of matrices and the animations somehow change them.
-animation appears to be responsible for the handling of animations.
-Animation seem to be reserved for objects, namely: seagulls in KTB, flags in YV, chain chomps in RR, and penguins in SL.
+Its not clear to me exactly what animations even are in MK64, my speculation is that their some form of matrix
+manipulation sequence. Presumably the "models" of the objects that are getting animated are a bunch of matrices and the
+animations somehow change them. animation appears to be responsible for the handling of animations. Animation seem to be
+reserved for objects, namely: seagulls in KTB, flags in YV, chain chomps in RR, and penguins in SL.
 
 Each object has 2 pointers of interest, at offsets 0x70 and 0x74  (unk_070 and unk_074).
 These are passed to render_animated_model, along with what appears to be an index and a timer.
@@ -37,7 +37,8 @@ Each "type" indicates a different action to take while iterating over the array.
 Type 1: Only used to modify Type 0's behaviour
 Type 2: Pop a matrix
 Type 3: End of array, stop processing
-Type 0: Always handles some part of the animation. If preceded by a Type 1 entry it will pop a matrix prior to the animation handling.
+Type 0: Always handles some part of the animation. If preceded by a Type 1 entry it will pop a matrix prior to the
+animation handling.
 
 The "size" entry is used in a weird way. If you have a set of entries like:
 
@@ -91,12 +92,12 @@ This is why I don't think referring to this as an "array" is really correct.
 Iterating over this data not like iterating over a proper array at all.
 
 I don't really understand the "thing" entries yet.
-They seem to be used in render_limb_or_add_mtx to set some values in Vec3f which is then used to set some values in a Mat4.
-This, I assume, is related to the matrix maniplation stuff that's used to actually accomplish the animation.
+They seem to be used in render_limb_or_add_mtx to set some values in Vec3f which is then used to set some values in a
+Mat4. This, I assume, is related to the matrix maniplation stuff that's used to actually accomplish the animation.
 
 The unk_074 pointer points to a list of other pointers.
-As best as I can tell only the penguins actually have multiple entries in this list, all the other animated objects have just 1 entry.
-The pointers in this list have entires that look like this struct:
+As best as I can tell only the penguins actually have multiple entries in this list, all the other animated objects have
+just 1 entry. The pointers in this list have entires that look like this struct:
 
 struct {
     s32 always_set_to_something_but_never_used;
@@ -136,7 +137,8 @@ So, for example, if you have a Struct 2 like:
     d_course_koopa_troopa_beach_unk_data2,
     d_course_koopa_troopa_beach_unk_data3,
 
-d_course_koopa_troopa_beach_unk_data2 should be a Type 2 array while d_course_koopa_troopa_beach_unk_data3 is a Type 3 array.
+d_course_koopa_troopa_beach_unk_data2 should be a Type 2 array while d_course_koopa_troopa_beach_unk_data3 is a Type 3
+array.
 
 d_course_koopa_troopa_beach_unk_data3 has entries that look like:
     //limiter //offset
@@ -144,17 +146,19 @@ d_course_koopa_troopa_beach_unk_data3 has entries that look like:
     0x0037,     0x0001,
     0x0001,     0x0000,
 
-In practice the limiter value is always 1 or the animation length, meaning that you either choose 0 or the current animation timer.
-There's never a situation where you will choose the animation timer until it hits X and then swap to 0.
+In practice the limiter value is always 1 or the animation length, meaning that you either choose 0 or the current
+animation timer. There's never a situation where you will choose the animation timer until it hits X and then swap to 0.
 Its always one or the other, never swapping.
 
-The first triplet is used in render_armature to access the Type 2 array and the values accessed is placed into sOriginalPosAnimation.
-sOriginalPosAnimation is a Vec3s is then used to set the values of some Vec3f in render_limb_or_add_mtx.
-All further triplets are used in render_limb_or_add_mtx to collect Type 2 values to another Vec3s local to the function.
-Both the local Vec3s and Vec3f are used to create a Mat4, which is then converted to a Mtx, which is then pushed into the matrix pool.
+The first triplet is used in render_armature to access the Type 2 array and the values accessed is placed into
+sOriginalPosAnimation. sOriginalPosAnimation is a Vec3s is then used to set the values of some Vec3f in
+render_limb_or_add_mtx. All further triplets are used in render_limb_or_add_mtx to collect Type 2 values to another
+Vec3s local to the function. Both the local Vec3s and Vec3f are used to create a Mat4, which is then converted to a Mtx,
+which is then pushed into the matrix pool.
 
 The chosen values are then used to access the Type 2 array and the value accessed is placed into sOriginalPosAnimation.
-sOriginalPosAnimation is a Vec3s that is used to set values in the some Vec3f that goes on to be used to modify the same Mat4 that the `thing` values are placed into.
+sOriginalPosAnimation is a Vec3s that is used to set values in the some Vec3f that goes on to be used to modify the same
+Mat4 that the `thing` values are placed into.
 
 */
 
@@ -164,27 +168,23 @@ sOriginalPosAnimation is a Vec3s that is used to set values in the some Vec3f th
 #define ANIMATION_POP_MATRIX SIMPLE_ANIMATION_INSTRUCTION(POP_MATRIX)
 #define ANIMATION_STOP SIMPLE_ANIMATION_INSTRUCTION(STOP_ANIMATION)
 //! the pos is relative to the previous RENDER_MODEL_OR_ADD_POS if ANIMATION_DISABLE_AUTOMATIC_POP is used
-#define ANIMATION_RENDER_MODEL_AT(model, x, y, z) RENDER_MODEL_OR_ADD_POS, 0x00000007, 0x00000000, (u32) model, x, y, z
+#define ANIMATION_RENDER_MODEL_AT(model, x, y, z) RENDER_MODEL_OR_ADD_POS, 0x00000007, 0x00000000, (s64) model, x, y, z
 //! use RENDER_MODEL_OR_ADD_POS
 #define ANIMATION_RENDER_MODEL(model) ANIMATION_RENDER_MODEL_AT(model, 0x00000000, 0x00000000, 0x00000000)
 //! use RENDER_MODEL_OR_ADD_POS
-#define ANIMATION_ADD_POS(x,y,z) ANIMATION_RENDER_MODEL_AT((u32)NULL, x, y, z)
+#define ANIMATION_ADD_POS(x, y, z) ANIMATION_RENDER_MODEL_AT((s64) NULL, x, y, z)
 
-enum animation_type {
-    RENDER_MODEL_OR_ADD_POS,
-    DISABLE_AUTOMATIC_POP_MATRIX,
-    POP_MATRIX,
-    STOP_ANIMATION
-};
+enum animation_type { RENDER_MODEL_OR_ADD_POS, DISABLE_AUTOMATIC_POP_MATRIX, POP_MATRIX, STOP_ANIMATION };
 
 /**
- * @brief The armature is associated with an AnimationLimbVector which is equal to the number of RENDER_MODEL_OR_ADD_POS in the armature
+ * @brief The armature is associated with an AnimationLimbVector which is equal to the number of RENDER_MODEL_OR_ADD_POS
+ * in the armature
  */
 typedef struct {
     /* 0x00 */ s64 type;
     /* 0x04 */ s64 size;
     /* 0x08 */ s64 always_zero_never_used;
-    /* 0x0C */ Gfx *model;
+    /* 0x0C */ Gfx* model;
     /* 0x10 */ s64 pos[3];
 } Armature;
 
@@ -193,7 +193,8 @@ typedef struct {
     /* 0x02 */ u16 indexCycle;
 } AnimationCycleSpec;
 
-//! the first are the original position and other are animation specification for each "limb" who correspond to each RENDER_MODEL_OR_ADD_POS so ANIMATION_RENDER_MODEL and ANIMATION_ADD_POS
+//! the first are the original position and other are animation specification for each "limb" who correspond to each
+//! RENDER_MODEL_OR_ADD_POS so ANIMATION_RENDER_MODEL and ANIMATION_ADD_POS
 typedef AnimationCycleSpec AnimationLimbVector[3];
 
 typedef struct {
@@ -201,17 +202,17 @@ typedef struct {
     /* 0x04 */ s32 always_zero_never_used;
     /* 0x08 */ s16 animation_length;
     /* 0x0A */ u16 has_value_but_never_used;
-    /* 0x0C */ s16 *angle_array;
-    /* 0x10 */ AnimationLimbVector *animation_cycle_spec_vector;
+    /* 0x0C */ s16* angle_array;
+    /* 0x10 */ AnimationLimbVector* animation_cycle_spec_vector;
 } Animation;
 
 /* Function Prototypes */
 
-void convert_to_fixed_point_matrix_animation(Mtx *dest, Mat4 src);
-void mtxf_translate_rotate2(Mat4 dest, Vec3f b, Vec3s c);
-s16  get_animation_length(Animation **, s16);
+void convert_to_fixed_point_matrix_animation(Mtx* dest, Mat4 src);
+void mtxf_translate_rotate2(Mat4 dest, Vec3f pos, Vec3s angle);
+s16 get_animation_length(Animation**, s16);
 void render_limb_or_add_mtx(Armature*, s16*, AnimationLimbVector, s32);
 void render_armature(Armature*, Animation*, s16);
-s16  render_animated_model(Armature*, Animation**, s16, s16);
+s16 render_animated_model(Armature*, Animation**, s16, s16);
 
 #endif