Quake & Distortion Docs (Again) + Math Cleanup (Camera Prep) (#1129)

* more quake docs

* more docs

* more distortion docs

* math cleanup

* fix header

* cleanup

* only partial PR review

* PR Suggestions

* fix master merge

* reverb angle change macros

* more revert

* fix enum

tools/disasm/functions.txt

@@ -859,9 +859,9 @@
     0x800BC5B8:("Actor_IsTargeted",),
     0x800BC5EC:("Actor_OtherIsTargeted",),
     0x800BC620:("func_800BC620",),
-    0x800BC770:("Actor_AddQuake",),
-    0x800BC7D8:("Actor_AddQuakeWithSpeed",),
-    0x800BC848:("func_800BC848",),
+    0x800BC770:("Actor_RequestQuake",),
+    0x800BC7D8:("Actor_RequestQuakeWithSpeed",),
+    0x800BC848:("Actor_RequestQuakeAndRumble",),
     0x800BC8B8:("Actor_DrawDoorLock",),
     0x800BCB50:("Actor_SpawnShieldParticlesMetal",),
     0x800BCB70:("Actor_SetColorFilter",),
@@ -2072,17 +2072,17 @@
     0x8010C36C:("OLib_ClampMaxDist",),
     0x8010C3D4:("OLib_Vec3fDistNormalize",),
     0x8010C484:("OLib_VecSphToVec3f",),
-    0x8010C530:("OLib_VecSphGeoToVec3f",),
+    0x8010C530:("OLib_VecGeoToVec3f",),
     0x8010C574:("OLib_Vec3fToVecSph",),
-    0x8010C6C8:("OLib_Vec3fToVecSphGeo",),
+    0x8010C6C8:("OLib_Vec3fToVecGeo",),
     0x8010C710:("OLib_Vec3fDiffToVecSph",),
-    0x8010C764:("OLib_Vec3fDiffToVecSphGeo",),
-    0x8010C7B8:("OLib_VecSphAddToVec3f",),
+    0x8010C764:("OLib_Vec3fDiffToVecGeo",),
+    0x8010C7B8:("OLib_AddVecGeoToVec3f",),
     0x8010C838:("OLib_Vec3fDiffRad",),
     0x8010C8C8:("OLib_Vec3fDiffDegF",),
     0x8010C930:("OLib_Vec3fDiffBinAng",),
-    0x8010C9C8:("OLib_DbCameraVec3fDiff",),
-    0x8010CAA0:("OLib_DbCameraVec3fSum",),
+    0x8010C9C8:("OLib_Vec3fDiff",),
+    0x8010CAA0:("OLib_Vec3fAdd",),
     0x8010CB80:("Gfx_DrawTexRectRGBA16",),
     0x8010CD98:("Gfx_DrawTexRectIA8",),
     0x8010CFBC:("Gfx_DrawTexRectIA8_DropShadow",),
@@ -2289,28 +2289,28 @@
     0x8012A4D0:("Quake_CallbackType2",),
     0x8012A540:("Quake_CallbackType4",),
     0x8012A5D8:("Quake_GetFreeIndex",),
-    0x8012A638:("Quake_AddImpl",),
-    0x8012A6F0:("Quake_RemoveRequest",),
+    0x8012A638:("Quake_RequestImpl",),
+    0x8012A6F0:("Quake_Remove",),
     0x8012A718:("Quake_GetRequest",),
     0x8012A774:("Quake_SetValue",),
     0x8012A8A8:("Quake_SetSpeed",),
-    0x8012A8F0:("Quake_SetCountdown",),
-    0x8012A940:("Quake_GetCountdown",),
-    0x8012A978:("Quake_SetQuakeValues",),
-    0x8012A9E0:("Quake_SetQuakeValues2",),
+    0x8012A8F0:("Quake_SetDuration",),
+    0x8012A940:("Quake_GetTimeLeft",),
+    0x8012A978:("Quake_SetPerturbations",),
+    0x8012A9E0:("Quake_SetOrientation",),
     0x8012AA48:("Quake_Init",),
-    0x8012AA9C:("Quake_Add",),
-    0x8012AAC0:("Quake_Remove",),
-    0x8012AB08:("Quake_Calc",),
+    0x8012AA9C:("Quake_Request",),
+    0x8012AAC0:("Quake_RemoveRequest",),
+    0x8012AB08:("Quake_Update",),
     0x8012AE68:("Distortion_Init",),
-    0x8012AEAC:("Distortion_SetCountdown",),
-    0x8012AED4:("Distortion_GetCountdown",),
+    0x8012AEAC:("Distortion_SetDuration",),
+    0x8012AED4:("Distortion_GetTimeLeft",),
     0x8012AEE4:("Distortion_GetType",),
-    0x8012AEF4:("Distortion_SetType",),
-    0x8012AF18:("Distortion_ClearType",),
+    0x8012AEF4:("Distortion_Request",),
+    0x8012AF18:("Distortion_RemoveRequest",),
     0x8012AF38:("Distortion_GetUnderwaterCurrentSpeed",),
     0x8012AF9C:("Distortion_Update",),
-    0x8012BBE8:("Quake_NumActiveQuakes",),
+    0x8012BBE8:("Quake_GetNumActiveQuakes",),
     0x8012BC50:("Gfx_SetFog",),
     0x8012BD8C:("Gfx_SetFogWithSync",),
     0x8012BF08:("Gfx_SetFog2",),
@@ -9710,7 +9710,7 @@
     0x80A134B0:("func_80A134B0",),
     0x80A134F4:("func_80A134F4",),
     0x80A13564:("func_80A13564",),
-    0x80A136B8:("func_80A136B8",),
+    0x80A136B8:("EnGo_RequestQuake",),
     0x80A13728:("func_80A13728",),
     0x80A137C0:("func_80A137C0",),
     0x80A139E4:("func_80A139E4",),
@@ -10620,7 +10620,7 @@
     0x80A53E60:("func_80A53E60",),
     0x80A541F4:("func_80A541F4",),
     0x80A54600:("func_80A54600",),
-    0x80A54980:("ObjHugebombiwa_AddQuake",),
+    0x80A54980:("ObjHugebombiwa_RequestQuakeAndRumble",),
     0x80A54A0C:("func_80A54A0C",),
     0x80A54AC0:("ObjHugebombiwa_Init",),
     0x80A54BC4:("ObjHugebombiwa_Destroy",),
@@ -11433,7 +11433,7 @@
     0x80A9BC0C:("func_80A9BC0C",),
     0x80A9BD24:("func_80A9BD24",),
     0x80A9C058:("func_80A9C058",),
-    0x80A9C18C:("func_80A9C18C",),
+    0x80A9C18C:("BgHakuginPost_RequestQuakeAndRumble",),
     0x80A9C228:("func_80A9C228",),
     0x80A9C634:("func_80A9C634",),
     0x80A9C854:("func_80A9C854",),
@@ -12211,7 +12211,7 @@
     0x80AD566C:("EnTrt2_TransformLimbDraw",),
     0x80AD56E8:("func_80AD56E8",),
     0x80AD5BB0:("ObjTokeiStep_SetSysMatrix",),
-    0x80AD5BE8:("ObjTokeiStep_AddQuake",),
+    0x80AD5BE8:("ObjTokeiStep_RequestQuakeAndRumble",),
     0x80AD5C70:("ObjTokeiStep_SpawnDust",),
     0x80AD5DFC:("ObjTokeiStep_InitSteps",),
     0x80AD5EB8:("ObjTokeiStep_InitStepsOpen",),
@@ -16662,7 +16662,7 @@
     0x80C0A740:("func_80C0A740",),
     0x80C0A804:("func_80C0A804",),
     0x80C0A838:("func_80C0A838",),
-    0x80C0A86C:("func_80C0A86C",),
+    0x80C0A86C:("BgIkninSusceil_RequestQuakeAndRumble",),
     0x80C0A95C:("func_80C0A95C",),
     0x80C0AA70:("BgIkninSusceil_Init",),
     0x80C0AAE0:("BgIkninSusceil_Destroy",),

tools/disasm/variables.txt

@@ -1326,7 +1326,7 @@
     0x801C0EA0:("D_801C0EA0","UNK_TYPE1","",0x1),
     0x801C0EAC:("sSheathLimbModelShieldOnBackPos","Vec3f","",0xC),
     0x801C0EB8:("sSheathLimbModelShieldOnBackZyxRot","Vec3s","",0x6),
-    0x801C0EC0:("sIsQuakeInitialized","UNK_TYPE2","",0x2),
+    0x801C0EC0:("sQuakeUnused","UNK_TYPE2","",0x2),
     0x801C0EC4:("sQuakeRequestCount","s16","",0x2),
     0x801C0EC8:("sQuakeCallbacks","quake_callback_func","[7]",0x1c),
     0x801C0EE4:("D_801C0EE4","s16","",0x2),
@@ -4006,7 +4006,7 @@
     0x801F59E8:("sPlayerGetItemRefPos","Vec3f","",0xC),
     0x801F59F4:("sPlayerLeftHandType","s32","",0x4),
     0x801F59F8:("sPlayerRightHandType","s32","",0x4),
-    0x801F5A00:("sQuakeRequest","QuakeRequest","[4]",0x90),
+    0x801F5A00:("sQuakeRequests","QuakeRequest","[4]",0x90),
     0x801F5A90:("sDistortionRequest","DistortionRequest","",0xc),
     0x801F5AA0:("sMatAnimStep","s32","",0x4),
     0x801F5AA4:("sMatAnimFlags","u32","",0x4),
@@ -5679,8 +5679,8 @@
     0x80872E8C:("D_80872E8C","UNK_TYPE1","",0x1),
     0x80872E90:("D_80872E90","UNK_TYPE4","",0x4),
     0x80872E94:("D_80872E94","UNK_TYPE4","",0x4),
-    0x80872E98:("D_80872E98","UNK_TYPE1","",0x1),
-    0x80872E9C:("D_80872E9C","UNK_TYPE1","",0x1),
+    0x80872E98:("sQuakeY","UNK_TYPE1","",0x1),
+    0x80872E9C:("sQuakeDurations","UNK_TYPE1","",0x1),
     0x80872EA0:("D_80872EA0","UNK_TYPE4","",0x4),
     0x80872EAC:("D_80872EAC","UNK_TYPE4","",0x4),
     0x80872EB8:("D_80872EB8","UNK_TYPE4","",0x4),

tools/namefixer.py

@@ -321,7 +321,10 @@ wordReplace = {
     "func_800B86C8": "Actor_ChangeFocus",
     "func_800DF840": "Camera_ChangeMode",
     "func_800B90F4": "Actor_DeactivateLens",
-    "func_800BC770": "Actor_AddQuake",
+    "Actor_AddQuake": "Actor_RequestQuake",
+    "func_800BC770": "Actor_RequestQuake",
+    "Actor_AddQuakeWithSpeed": "Actor_RequestQuakeWithSpeed",
+    "func_800BC848": "Actor_RequestQuakeAndRumble",
     "func_800DF840": "Camera_ChangeMode",
     "zelda_malloc": "ZeldaArena_Malloc",
     "zelda_mallocR": "ZeldaArena_MallocR",
@@ -635,12 +638,22 @@ wordReplace = {
     "func_80114E90": "Inventory_HasEmptyBottle",
     "func_80114F2C": "Inventory_HasItemInBottle",
     "func_80123C90": "Player_SetEquipmentData",
-    "Quake2_ClearType": "Distortion_ClearType",
-    "Quake2_SetType": "Distortion_SetType",
-    "Quake2_SetCountdown": "Distortion_SetCountdown",
+    "Quake2_SetType": "Distortion_Request",
+    "Distortion_SetType": "Distortion_Request",
+    "Quake2_SetCountdown": "Distortion_SetDuration",
+    "Distortion_SetCountdown": "Distortion_SetDuration",
+    "Distortion_GetCountdown": "Distortion_GetTimeLeft",
+    "Quake2_ClearType": "Distortion_RemoveRequest",
+    "Distortion_ClearType": "Distortion_RemoveRequest",
     "func_800BE680": "Actor_DrawDamageEffects",
     "func_8012F22C": "Inventory_GetSkullTokenCount",
-    "Quake_RemoveFromIdx": "Quake_Remove",
+    "Quake_Add": "Quake_Request",
+    "Quake_SetQuakeValues": "Quake_SetPerturbations",
+    "Quake_SetCountdown": "Quake_SetDuration",
+    "Quake_GetCountdown": "Quake_GetTimeLeft",
+    "Quake_NumActiveQuakes": "Quake_GetNumActiveQuakes",
+    "Quake_RemoveFromIdx": "Quake_RemoveRequest",
+    "OLib_DbCameraVec3fSum":"OLib_Vec3fAdd",
 
     "func_8013AB00": "SubS_DrawTransformFlex",
     "func_8013A860": "SubS_DrawTransformFlexLimb",

tools/sizes/code_functions.csv

@@ -373,9 +373,9 @@ asm/non_matchings/code/z_actor/Actor_TestFloorInDirection.s,Actor_TestFloorInDir
 asm/non_matchings/code/z_actor/Actor_IsTargeted.s,Actor_IsTargeted,0x800BC5B8,0xD
 asm/non_matchings/code/z_actor/Actor_OtherIsTargeted.s,Actor_OtherIsTargeted,0x800BC5EC,0xD
 asm/non_matchings/code/z_actor/func_800BC620.s,func_800BC620,0x800BC620,0x54
-asm/non_matchings/code/z_actor/Actor_AddQuake.s,Actor_AddQuake,0x800BC770,0x1A
-asm/non_matchings/code/z_actor/Actor_AddQuakeWithSpeed.s,Actor_AddQuakeWithSpeed,0x800BC7D8,0x1C
-asm/non_matchings/code/z_actor/func_800BC848.s,func_800BC848,0x800BC848,0x1C
+asm/non_matchings/code/z_actor/Actor_RequestQuake.s,Actor_RequestQuake,0x800BC770,0x1A
+asm/non_matchings/code/z_actor/Actor_RequestQuakeWithSpeed.s,Actor_RequestQuakeWithSpeed,0x800BC7D8,0x1C
+asm/non_matchings/code/z_actor/Actor_RequestQuakeAndRumble.s,Actor_RequestQuakeAndRumble,0x800BC848,0x1C
 asm/non_matchings/code/z_actor/Actor_DrawDoorLock.s,Actor_DrawDoorLock,0x800BC8B8,0xA6
 asm/non_matchings/code/z_actor/Actor_SpawnShieldParticlesMetal.s,Actor_SpawnShieldParticlesMetal,0x800BCB50,0x8
 asm/non_matchings/code/z_actor/Actor_SetColorFilter.s,Actor_SetColorFilter,0x800BCB70,0x21
@@ -1586,17 +1586,17 @@ asm/non_matchings/code/z_olib/OLib_ClampMinDist.s,OLib_ClampMinDist,0x8010C304,0
 asm/non_matchings/code/z_olib/OLib_ClampMaxDist.s,OLib_ClampMaxDist,0x8010C36C,0x1A
 asm/non_matchings/code/z_olib/OLib_Vec3fDistNormalize.s,OLib_Vec3fDistNormalize,0x8010C3D4,0x2C
 asm/non_matchings/code/z_olib/OLib_VecSphToVec3f.s,OLib_VecSphToVec3f,0x8010C484,0x2B
-asm/non_matchings/code/z_olib/OLib_VecSphGeoToVec3f.s,OLib_VecSphGeoToVec3f,0x8010C530,0x11
+asm/non_matchings/code/z_olib/OLib_VecGeoToVec3f.s,OLib_VecGeoToVec3f,0x8010C530,0x11
 asm/non_matchings/code/z_olib/OLib_Vec3fToVecSph.s,OLib_Vec3fToVecSph,0x8010C574,0x55
-asm/non_matchings/code/z_olib/OLib_Vec3fToVecSphGeo.s,OLib_Vec3fToVecSphGeo,0x8010C6C8,0x12
+asm/non_matchings/code/z_olib/OLib_Vec3fToVecGeo.s,OLib_Vec3fToVecGeo,0x8010C6C8,0x12
 asm/non_matchings/code/z_olib/OLib_Vec3fDiffToVecSph.s,OLib_Vec3fDiffToVecSph,0x8010C710,0x15
-asm/non_matchings/code/z_olib/OLib_Vec3fDiffToVecSphGeo.s,OLib_Vec3fDiffToVecSphGeo,0x8010C764,0x15
-asm/non_matchings/code/z_olib/OLib_VecSphAddToVec3f.s,OLib_VecSphAddToVec3f,0x8010C7B8,0x20
+asm/non_matchings/code/z_olib/OLib_Vec3fDiffToVecGeo.s,OLib_Vec3fDiffToVecGeo,0x8010C764,0x15
+asm/non_matchings/code/z_olib/OLib_AddVecGeoToVec3f.s,OLib_AddVecGeoToVec3f,0x8010C7B8,0x20
 asm/non_matchings/code/z_olib/OLib_Vec3fDiffRad.s,OLib_Vec3fDiffRad,0x8010C838,0x24
 asm/non_matchings/code/z_olib/OLib_Vec3fDiffDegF.s,OLib_Vec3fDiffDegF,0x8010C8C8,0x1A
 asm/non_matchings/code/z_olib/OLib_Vec3fDiffBinAng.s,OLib_Vec3fDiffBinAng,0x8010C930,0x26
-asm/non_matchings/code/z_olib/OLib_DbCameraVec3fDiff.s,OLib_DbCameraVec3fDiff,0x8010C9C8,0x36
-asm/non_matchings/code/z_olib/OLib_DbCameraVec3fSum.s,OLib_DbCameraVec3fSum,0x8010CAA0,0x34
+asm/non_matchings/code/z_olib/OLib_Vec3fDiff.s,OLib_Vec3fDiff,0x8010C9C8,0x36
+asm/non_matchings/code/z_olib/OLib_Vec3fAdd.s,OLib_Vec3fAdd,0x8010CAA0,0x34
 asm/non_matchings/code/z_parameter/Gfx_DrawTexRectRGBA16.s,Gfx_DrawTexRectRGBA16,0x8010CB80,0x86
 asm/non_matchings/code/z_parameter/Gfx_DrawTexRectIA8.s,Gfx_DrawTexRectIA8,0x8010CD98,0x89
 asm/non_matchings/code/z_parameter/Gfx_DrawTexRectIA8_DropShadow.s,Gfx_DrawTexRectIA8_DropShadow,0x8010CFBC,0xC6
@@ -1803,28 +1803,28 @@ asm/non_matchings/code/z_quake/Quake_CallbackType3.s,Quake_CallbackType3,0x8012A
 asm/non_matchings/code/z_quake/Quake_CallbackType2.s,Quake_CallbackType2,0x8012A4D0,0x1C
 asm/non_matchings/code/z_quake/Quake_CallbackType4.s,Quake_CallbackType4,0x8012A540,0x26
 asm/non_matchings/code/z_quake/Quake_GetFreeIndex.s,Quake_GetFreeIndex,0x8012A5D8,0x18
-asm/non_matchings/code/z_quake/Quake_AddImpl.s,Quake_AddImpl,0x8012A638,0x2E
-asm/non_matchings/code/z_quake/Quake_RemoveRequest.s,Quake_RemoveRequest,0x8012A6F0,0xA
+asm/non_matchings/code/z_quake/Quake_RequestImpl.s,Quake_RequestImpl,0x8012A638,0x2E
+asm/non_matchings/code/z_quake/Quake_Remove.s,Quake_Remove,0x8012A6F0,0xA
 asm/non_matchings/code/z_quake/Quake_GetRequest.s,Quake_GetRequest,0x8012A718,0x17
 asm/non_matchings/code/z_quake/Quake_SetValue.s,Quake_SetValue,0x8012A774,0x4D
 asm/non_matchings/code/z_quake/Quake_SetSpeed.s,Quake_SetSpeed,0x8012A8A8,0x12
-asm/non_matchings/code/z_quake/Quake_SetCountdown.s,Quake_SetCountdown,0x8012A8F0,0x14
-asm/non_matchings/code/z_quake/Quake_GetCountdown.s,Quake_GetCountdown,0x8012A940,0xE
-asm/non_matchings/code/z_quake/Quake_SetQuakeValues.s,Quake_SetQuakeValues,0x8012A978,0x1A
-asm/non_matchings/code/z_quake/Quake_SetQuakeValues2.s,Quake_SetQuakeValues2,0x8012A9E0,0x1A
+asm/non_matchings/code/z_quake/Quake_SetDuration.s,Quake_SetDuration,0x8012A8F0,0x14
+asm/non_matchings/code/z_quake/Quake_GetTimeLeft.s,Quake_GetTimeLeft,0x8012A940,0xE
+asm/non_matchings/code/z_quake/Quake_SetPerturbations.s,Quake_SetPerturbations,0x8012A978,0x1A
+asm/non_matchings/code/z_quake/Quake_SetOrientation.s,Quake_SetOrientation,0x8012A9E0,0x1A
 asm/non_matchings/code/z_quake/Quake_Init.s,Quake_Init,0x8012AA48,0x15
-asm/non_matchings/code/z_quake/Quake_Add.s,Quake_Add,0x8012AA9C,0x9
-asm/non_matchings/code/z_quake/Quake_Remove.s,Quake_Remove,0x8012AAC0,0x12
-asm/non_matchings/code/z_quake/Quake_Calc.s,Quake_Calc,0x8012AB08,0xD8
+asm/non_matchings/code/z_quake/Quake_Request.s,Quake_Request,0x8012AA9C,0x9
+asm/non_matchings/code/z_quake/Quake_RemoveRequest.s,Quake_RemoveRequest,0x8012AAC0,0x12
+asm/non_matchings/code/z_quake/Quake_Update.s,Quake_Update,0x8012AB08,0xD8
 asm/non_matchings/code/z_quake/Distortion_Init.s,Distortion_Init,0x8012AE68,0x11
-asm/non_matchings/code/z_quake/Distortion_SetCountdown.s,Distortion_SetCountdown,0x8012AEAC,0xA
-asm/non_matchings/code/z_quake/Distortion_GetCountdown.s,Distortion_GetCountdown,0x8012AED4,0x4
+asm/non_matchings/code/z_quake/Distortion_SetDuration.s,Distortion_SetDuration,0x8012AEAC,0xA
+asm/non_matchings/code/z_quake/Distortion_GetTimeLeft.s,Distortion_GetTimeLeft,0x8012AED4,0x4
 asm/non_matchings/code/z_quake/Distortion_GetType.s,Distortion_GetType,0x8012AEE4,0x4
-asm/non_matchings/code/z_quake/Distortion_SetType.s,Distortion_SetType,0x8012AEF4,0x9
-asm/non_matchings/code/z_quake/Distortion_ClearType.s,Distortion_ClearType,0x8012AF18,0x8
+asm/non_matchings/code/z_quake/Distortion_Request.s,Distortion_Request,0x8012AEF4,0x9
+asm/non_matchings/code/z_quake/Distortion_RemoveRequest.s,Distortion_RemoveRequest,0x8012AF18,0x8
 asm/non_matchings/code/z_quake/Distortion_GetUnderwaterCurrentSpeed.s,Distortion_GetUnderwaterCurrentSpeed,0x8012AF38,0x19
 asm/non_matchings/code/z_quake/Distortion_Update.s,Distortion_Update,0x8012AF9C,0x313
-asm/non_matchings/code/z_quake/Quake_NumActiveQuakes.s,Quake_NumActiveQuakes,0x8012BBE8,0x1A
+asm/non_matchings/code/z_quake/Quake_GetNumActiveQuakes.s,Quake_GetNumActiveQuakes,0x8012BBE8,0x1A
 asm/non_matchings/code/z_rcp/Gfx_SetFog.s,Gfx_SetFog,0x8012BC50,0x4F
 asm/non_matchings/code/z_rcp/Gfx_SetFogWithSync.s,Gfx_SetFogWithSync,0x8012BD8C,0x5F
 asm/non_matchings/code/z_rcp/Gfx_SetFog2.s,Gfx_SetFog2,0x8012BF08,0xD