Files
jak-project/goal_src/jak1/engine/math/transformq.gc
ManDude cd68cb671e deftype and defmethod syntax major changes (#3094)
Major change to how `deftype` shows up in our code:
- the decompiler will no longer emit the `offset-assert`,
`method-count-assert`, `size-assert` and `flag-assert` parameters. There
are extremely few cases where having this in the decompiled code is
helpful, as the types there come from `all-types` which already has
those parameters. This also doesn't break type consistency because:
  - the asserts aren't compared.
- the first step of the test uses `all-types`, which has the asserts,
which will throw an error if they're bad.
- the decompiler won't emit the `heap-base` parameter unless necessary
now.
- the decompiler will try its hardest to turn a fixed-offset field into
an `overlay-at` field. It falls back to the old offset if all else
fails.
- `overlay-at` now supports field "dereferencing" to specify the offset
that's within a field that's a structure, e.g.:
```lisp
(deftype foobar (structure)
  ((vec    vector  :inline)
   (flags  int32   :overlay-at (-> vec w))
   )
  )
```
in this structure, the offset of `flags` will be 12 because that is the
final offset of `vec`'s `w` field within this structure.
- **removed ID from all method declarations.** IDs are only ever
automatically assigned now. Fixes #3068.
- added an `:overlay` parameter to method declarations, in order to
declare a new method that goes on top of a previously-defined method.
Syntax is `:overlay <method-name>`. Please do not ever use this.
- added `state-methods` list parameter. This lets you quickly specify a
list of states to be put in the method table. Same syntax as the
`states` list parameter. The decompiler will try to put as many states
in this as it can without messing with the method ID order.

Also changes `defmethod` to make the first type definition (before the
arguments) optional. The type can now be inferred from the first
argument. Fixes #3093.

---------

Co-authored-by: Hat Kid <6624576+Hat-Kid@users.noreply.github.com>
2023-10-30 03:20:02 +00:00

400 lines
14 KiB
Common Lisp

;;-*-Lisp-*-
(in-package goal)
;; name: transformq.gc
;; name in dgo: transformq
;; dgos: GAME, ENGINE
;; DECOMP BEGINS
(defmethod print ((this transformq))
"Print a transformq"
(format #t "#<transformq @ #x~X~%" this)
(format #t "~T~Ttrans:~F ~F ~F ~F ~%" (-> this trans x) (-> this trans y) (-> this trans z) (-> this trans w))
(format #t "~T~Tquat: ~F ~F ~F ~F ~%" (-> this quat x) (-> this quat y) (-> this quat z) (-> this quat w))
(format #t "~T~Tscale:~F ~F ~F ~F>" (-> this scale x) (-> this scale y) (-> this scale z) (-> this scale w))
this
)
(defmethod get-quaternion ((this trsqv))
"Get the rotation as a quaternion."
(-> this quat)
)
(defmethod set-quaternion! ((this trsqv) (arg0 quaternion))
"Set the rotation as a quaternion"
(quaternion-copy! (get-quaternion this) arg0)
)
(defmethod rot->dir-targ! ((this trsqv))
"Set the dir-targ to our current orientation"
(quaternion-copy! (-> this dir-targ) (get-quaternion this))
)
(defmethod y-angle ((this trsqv))
"Get our current y-angle (y is up, so yaw)"
(quaternion-y-angle (get-quaternion this))
)
(defmethod seek-toward-heading-vec! ((this trsqv) (dir vector) (vel float) (frame-count time-frame))
"Adjust the orientation to point along dir, only changing our yaw.
The vel is a maximum velocity limit.
The frame count is the time constant (first order).
There's some logic to avoid rapidly changing directions"
(let* ((yaw-error (deg-diff (quaternion-y-angle (-> this quat)) (vector-y-angle dir)))
;; limit both on a max velocity, and a proportional to error term.
(yaw-limit (fmin (* vel (seconds-per-frame)) (/ (* 5.0 (fabs yaw-error)) (the float frame-count))))
;; saturate the yaw error
(saturated-yaw (fmax (fmin yaw-error yaw-limit) (- yaw-limit)))
)
(let ((old-diff (-> this old-y-angle-diff)))
(set! saturated-yaw
(cond
;; I have no idea what this crazy thing is.
;; But it prevents changes in direction from happening too often.
((or (= old-diff 0.0)
(and (< 0.0 saturated-yaw) (< 0.0 old-diff))
(or (and (< saturated-yaw 0.0) (< old-diff 0.0)) (time-elapsed? (-> this angle-change-time) (seconds 0.2)))
)
(set-time! (-> this angle-change-time))
saturated-yaw
)
(else
;; not sure why this isn't 0.
(* 0.000000001 saturated-yaw)
)
)
)
)
(set! (-> this old-y-angle-diff) saturated-yaw)
(let ((quat (get-quaternion this)))
(quaternion-rotate-y! quat quat saturated-yaw)
)
)
)
(defmethod set-heading-vec! ((this trsqv) (arg0 vector))
"Makes us look in the arg0 direction immediately. Pitch will be unchanged."
(let ((s3-0 (get-quaternion this)))
(forward-up-nopitch->quaternion
s3-0
(vector-normalize-copy! (new 'stack-no-clear 'vector) arg0 1.0) ;; forward is the given dir.
(vector-y-quaternion! (new 'stack-no-clear 'vector) s3-0) ;; use the old up
)
)
)
(defmethod seek-to-point-toward-point! ((this trsqv) (arg0 vector) (arg1 float) (arg2 time-frame))
"Seek toward pointing toward arg0 from our current location."
(seek-toward-heading-vec! this (vector-! (new 'stack-no-clear 'vector) arg0 (-> this trans)) arg1 arg2)
)
(defmethod point-toward-point! ((this trsqv) (arg0 vector))
"Immediately point toward arg0"
(let ((s3-0 (get-quaternion this)))
(forward-up-nopitch->quaternion
s3-0
(vector-normalize! (vector-! (new 'stack-no-clear 'vector) arg0 (-> this trans)) 1.0)
(vector-y-quaternion! (new 'stack-no-clear 'vector) s3-0)
)
)
)
(defmethod seek-toward-yaw-angle! ((this trsqv) (yaw float) (vel float) (frame-count time-frame))
"Seek toward the given yaw angle."
(seek-toward-heading-vec! this
;; make a vector that points toward +z (forward) rotated by the yaw.
(set-vector! (new 'stack-no-clear 'vector) (sin yaw) 0.0 (cos yaw) 1.0)
vel
frame-count)
)
(defmethod set-yaw-angle-clear-roll-pitch! ((this trsqv) (yaw float))
"Immediately clear our roll and pitch and set yaw to the given angle"
(set-heading-vec-clear-roll-pitch! this (set-vector! (new 'stack-no-clear 'vector) (sin yaw) 0.0 (cos yaw) 1.0))
)
(defmethod set-roll-to-grav! ((this trsqv) (arg0 float))
"Set our roll so that our local down aligns with standard gravity"
(set-roll-to-grav-2! this arg0)
)
(defmethod set-roll-to-grav-2! ((this trsqv) (arg0 float))
"Set our roll so that our local down aligns with standard gravity"
(let* ((quat (get-quaternion this)) ;; our orientation
(grav (-> *standard-dynamics* gravity-normal)) ;; dir of gravity
(rot-mat (quaternion->matrix (new 'stack-no-clear 'matrix) quat)) ;; our orientation
)
(let ((dir-z (-> rot-mat vector 2))) ;; this is the direction of the z-axis.
;; this projects world gravity into our local z plane (killing its pitch component),
;; then updates the rotation matrix so that this is our y axis (up)
(vector-normalize! (vector-flatten! (-> rot-mat vector 1) grav dir-z) 1.0)
;; fix up the rotation matrix x vector to make the matrix orthonormal again.
(vector-cross! (the-as vector (-> rot-mat vector)) (-> rot-mat vector 1) dir-z)
)
;; add some additional roll offset
(let ((a1-5 (matrix-rotate-z! (new 'stack-no-clear 'matrix) arg0)))
(matrix*! rot-mat a1-5 rot-mat)
)
;; write it back.
(matrix->quaternion quat rot-mat)
)
)
(defmethod roll-relative-to-gravity ((this trsqv))
"Get our roll, relative to 'down' from gravity"
(let* ((quat (get-quaternion this))
(dir-z (vector-z-quaternion! (new 'stack-no-clear 'vector) quat))
(dir-y (vector-y-quaternion! (new 'stack-no-clear 'vector) quat))
(dir-grav (-> *standard-dynamics* gravity-normal))
;; project gravity to our z plane (kills pitch)
(grav-z-plane (vector-normalize! (vector-flatten! (new 'stack-no-clear 'vector) dir-grav dir-z) 1.0))
(grav-dot (vector-dot grav-z-plane dir-y))
)
;; normally we'd just do (acos (vector-dot grav-z-plane y))
;; but this won't give us the correct sign if we're rolled negatively.
;; this check below manually inverts the acos as needed.
(if (< (vector-dot (vector-cross! (new 'stack-no-clear 'vector) grav-z-plane dir-y) dir-z) 0.0)
(- (acos grav-dot))
(acos grav-dot)
)
)
)
(defmethod rotate-toward-orientation! ((this trsqv) (target quaternion) (y-rate float) (z-rate float))
"Adjust our orientation toward target, subject to some rate limits.
I don't think this is a very robust function and probably doesn't work right in cases
where an axis flips by 180 degrees."
;; the basic idea is that we apply two rotations:
;; the first moves our y axis toward the desired's y axis, and the second moves
;; out z axis. These are both rate limited.
(local-vars (sv-96 vector))
(let ((quat (get-quaternion this)))
(let ((temp-quat (new 'stack-no-clear 'quaternion)))
(when (< 0.0 z-rate)
(let ((s1-0 quaternion-from-two-vectors-max-angle!)
(s0-0 temp-quat)
)
(set! sv-96 (vector-y-quaternion! (new 'stack-no-clear 'vector) quat))
(let ((a2-1 (vector-y-quaternion! (new 'stack-no-clear 'vector) target))
(a3-1 (* z-rate (seconds-per-frame)))
)
(s1-0 s0-0 sv-96 a2-1 a3-1)
)
)
(quaternion-normalize! (quaternion*! quat temp-quat quat))
)
(when (< 0.0 y-rate)
(quaternion-from-two-vectors-max-angle!
temp-quat
(vector-z-quaternion! (new 'stack-no-clear 'vector) quat)
(vector-z-quaternion! (new 'stack-no-clear 'vector) target)
(* y-rate (seconds-per-frame))
)
(quaternion-normalize! (quaternion*! quat temp-quat quat))
)
)
quat
)
)
(defmethod set-heading-vec-clear-roll-pitch! ((this trsqv) (arg0 vector))
"Set our rotation to point along the given heading, with no roll or pitch."
(forward-up->quaternion
(get-quaternion this)
(vector-normalize-copy! (new 'stack-no-clear 'vector) arg0 1.0)
(new 'static 'vector :y 1.0 :w 1.0)
)
)
(defmethod point-toward-point-clear-roll-pitch! ((this trsqv) (arg0 vector))
"Set our orientation to point toward arg0, clearing roll and pitch"
(forward-up->quaternion
(get-quaternion this)
(vector-normalize! (vector-! (new 'stack-no-clear 'vector) arg0 (-> this trans)) 1.0)
(new 'static 'vector :y 1.0 :w 1.0)
)
)
(defun transformq-copy! ((arg0 transformq) (arg1 transformq))
"Set arg0 = arg1"
(set! (-> arg0 trans quad) (-> arg1 trans quad))
(set! (-> arg0 rot quad) (-> arg1 rot quad))
(set! (-> arg0 scale quad) (-> arg1 scale quad))
arg0
)
(defun matrix<-transformq! ((arg0 matrix) (arg1 transformq))
"Convert to 4x4 affine transform."
(local-vars (v1-1 float))
(rlet ((vf0 :class vf)
(vf1 :class vf)
(vf2 :class vf)
(vf3 :class vf)
(vf4 :class vf)
(vf5 :class vf)
)
(init-vf0-vector)
(quaternion->matrix arg0 (-> arg1 quat))
(cond
(#f
(set! (-> arg0 vector 3 quad) (-> arg1 trans quad))
)
(else
(.lvf vf1 (&-> arg1 scale quad))
(.lvf vf2 (&-> arg1 trans quad))
(.lvf vf3 (&-> arg0 vector 0 quad))
(.lvf vf4 (&-> arg0 vector 1 quad))
(.lvf vf5 (&-> arg0 vector 2 quad))
(.mov.vf vf2 vf0 :mask #b1000)
(.mul.x.vf vf3 vf3 vf1)
(.mul.y.vf vf4 vf4 vf1)
(.mul.z.vf vf5 vf5 vf1)
(.svf (&-> arg0 vector 3 quad) vf2)
(.svf (&-> arg0 vector 0 quad) vf3)
(.svf (&-> arg0 vector 1 quad) vf4)
(.svf (&-> arg0 vector 2 quad) vf5)
(.mov v1-1 vf5)
)
)
arg0
)
)
(defun matrix<-no-trans-transformq! ((arg0 matrix) (arg1 transformq))
"Create 4x4 affine transform with no translation."
(rlet ((vf0 :class vf)
(vf1 :class vf)
(vf2 :class vf)
(vf3 :class vf)
(vf4 :class vf)
(vf5 :class vf)
)
(init-vf0-vector)
(quaternion->matrix arg0 (-> arg1 quat))
(.lvf vf1 (&-> arg1 scale quad))
(.lvf vf3 (&-> arg0 vector 0 quad))
(.lvf vf4 (&-> arg0 vector 1 quad))
(.lvf vf5 (&-> arg0 vector 2 quad))
(.mov.vf vf2 vf0)
(.mul.x.vf vf3 vf3 vf1)
(.mul.y.vf vf4 vf4 vf1)
(.mul.z.vf vf5 vf5 vf1)
(.svf (&-> arg0 vector 3 quad) vf2)
(.svf (&-> arg0 vector 0 quad) vf3)
(.svf (&-> arg0 vector 1 quad) vf4)
(.svf (&-> arg0 vector 2 quad) vf5)
arg0
)
)
(defun matrix<-transformq+trans! ((arg0 matrix) (arg1 transformq) (arg2 vector))
"Convert to affine transform with an additional translation (in the local frame)."
(rlet ((acc :class vf)
(vf0 :class vf)
(vf1 :class vf)
(vf2 :class vf)
(vf3 :class vf)
(vf4 :class vf)
(vf5 :class vf)
(vf6 :class vf)
)
(init-vf0-vector)
(quaternion->matrix arg0 (-> arg1 quat))
(.lvf vf1 (&-> arg1 scale quad))
(.lvf vf2 (&-> arg1 trans quad))
(.lvf vf6 (&-> arg2 quad))
(.lvf vf3 (&-> arg0 vector 0 quad))
(.lvf vf4 (&-> arg0 vector 1 quad))
(.lvf vf5 (&-> arg0 vector 2 quad))
(.mov.vf vf2 vf0 :mask #b1000)
(.mul.x.vf vf3 vf3 vf1)
(.mul.y.vf vf4 vf4 vf1)
(.mul.z.vf vf5 vf5 vf1)
(.mul.x.vf acc vf3 vf6)
(.add.mul.y.vf acc vf4 vf6 acc)
(.add.mul.z.vf acc vf5 vf6 acc)
(.add.mul.w.vf vf2 vf2 vf0 acc :mask #b111)
(.svf (&-> arg0 vector 3 quad) vf2)
(.svf (&-> arg0 vector 0 quad) vf3)
(.svf (&-> arg0 vector 1 quad) vf4)
(.svf (&-> arg0 vector 2 quad) vf5)
arg0
)
)
(defun matrix<-transformq+world-trans! ((arg0 matrix) (arg1 transformq) (arg2 vector))
"Convert to affine transform with an additional translation in the world frame (not rotated)"
(rlet ((vf0 :class vf)
(vf1 :class vf)
(vf2 :class vf)
(vf3 :class vf)
(vf4 :class vf)
(vf5 :class vf)
(vf6 :class vf)
)
(init-vf0-vector)
(quaternion->matrix arg0 (-> arg1 quat))
(.lvf vf1 (&-> arg1 scale quad))
(.lvf vf2 (&-> arg1 trans quad))
(.lvf vf6 (&-> arg2 quad))
(.lvf vf3 (&-> arg0 vector 0 quad))
(.lvf vf4 (&-> arg0 vector 1 quad))
(.lvf vf5 (&-> arg0 vector 2 quad))
(.mov.vf vf2 vf0 :mask #b1000)
(.mul.x.vf vf3 vf3 vf1)
(.mul.y.vf vf4 vf4 vf1)
(.mul.z.vf vf5 vf5 vf1)
(.add.vf vf2 vf2 vf6 :mask #b111)
(.svf (&-> arg0 vector 3 quad) vf2)
(.svf (&-> arg0 vector 0 quad) vf3)
(.svf (&-> arg0 vector 1 quad) vf4)
(.svf (&-> arg0 vector 2 quad) vf5)
arg0
)
)
(defun matrix<-parented-transformq! ((arg0 matrix) (arg1 transformq) (arg2 vector))
"Unused. Seems like the parented thing means there's an inverse scale in arg2."
(local-vars (v1-1 float))
(rlet ((vf0 :class vf)
(vf1 :class vf)
(vf2 :class vf)
(vf3 :class vf)
(vf4 :class vf)
(vf5 :class vf)
(vf6 :class vf)
)
(init-vf0-vector)
(quaternion->matrix arg0 (-> arg1 quat))
(let ((v1-0 (new 'stack-no-clear 'vector)))
(set! (-> v1-0 x) (/ 1.0 (-> arg2 x)))
(set! (-> v1-0 y) (/ 1.0 (-> arg2 y)))
(set! (-> v1-0 z) (/ 1.0 (-> arg2 z)))
(.lvf vf1 (&-> arg1 scale quad))
(.lvf vf2 (&-> arg1 trans quad))
(.mov.vf vf2 vf0 :mask #b1000)
(.lvf vf4 (&-> arg0 vector 0 quad))
(.lvf vf5 (&-> arg0 vector 1 quad))
(.lvf vf6 (&-> arg0 vector 2 quad))
(.mul.x.vf vf4 vf4 vf1)
(.mul.y.vf vf5 vf5 vf1)
(.mul.z.vf vf6 vf6 vf1)
(.lvf vf3 (&-> v1-0 quad))
)
(.mul.vf vf4 vf4 vf3)
(.mul.vf vf5 vf5 vf3)
(.mul.vf vf6 vf6 vf3)
(.svf (&-> arg0 vector 3 quad) vf2)
(.svf (&-> arg0 vector 0 quad) vf4)
(.svf (&-> arg0 vector 1 quad) vf5)
(.svf (&-> arg0 vector 2 quad) vf6)
(.mov v1-1 vf6)
arg0
)
)