document ragdolldata::constrainrot

project-imprimis · Feb 10, 2025 · 4ea2bc5 · 4ea2bc5
1 parent 54d65b3
commit 4ea2bc5
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/src/engine/model/ragdoll.cpp b/src/engine/model/ragdoll.cpp
@@ -339,7 +339,7 @@ void ragdolldata::applyrotlimit(const ragdollskel::tri &t1, const ragdollskel::t
 
 void ragdolldata::constrainrot()
 {
-    calctris();
+    calctris(); //set up shadowing matrix3 objects for skel->tris
     for(const ragdollskel::rotlimit &r : skel->rotlimits)
     {
         matrix3 rot;
@@ -349,6 +349,7 @@ void ragdolldata::constrainrot()
         vec axis;
         float angle;
         const float tr = rot.trace();
+        //calculate angle and axis from the matrix `rot`, if possible
         if(tr >= r.maxtrace || !rot.calcangleaxis(tr, angle, axis))
         {
             continue;

diff --git a/src/engine/model/ragdoll.h b/src/engine/model/ragdoll.h
@@ -223,6 +223,13 @@ class ragdolldata final
          * @param axis the axis by which to rotate around
          */
         void applyrotlimit(const ragdollskel::tri &t1, const ragdollskel::tri &t2, float angle, const vec &axis);
+
+        /**
+         * @brief Calculates and applies a rotation limit each defined rotation limit
+         *
+         * For each rotlimit in the associated skeleton, calculates the angle and rotation
+         * from that rotlimit and applies it to the associated vertices.
+         */
         void constrainrot();
 
         /**