Browse Source

Document all angles as being radians;

bjorn 5 years ago
parent
commit
30a071a61f

+ 19 - 19
api/init.lua

@@ -11347,7 +11347,7 @@ return {
                     {
                       name = "angle",
                       type = "number",
-                      description = "The angle to rotate the Mesh around its axis of rotation.",
+                      description = "The angle to rotate the Mesh around the axis of rotation, in radians.",
                       default = "0"
                     },
                     {
@@ -11970,7 +11970,7 @@ return {
                     {
                       name = "angle",
                       type = "number",
-                      description = "The angle to rotate the Model around its axis of rotation.",
+                      description = "The angle to rotate the Model around the axis of rotation, in radians.",
                       default = "0"
                     },
                     {
@@ -12463,7 +12463,7 @@ return {
                     {
                       name = "angle",
                       type = "number",
-                      description = "The angle of the orientation."
+                      description = "The angle of rotation around the axis, in radians."
                     },
                     {
                       name = "ax",
@@ -12514,7 +12514,7 @@ return {
                     {
                       name = "angle",
                       type = "number",
-                      description = "The angle of the orientation."
+                      description = "The angle of rotation around the axis, in radians."
                     },
                     {
                       name = "ax",
@@ -15587,7 +15587,7 @@ return {
             {
               name = "fov",
               summary = "Set a projection using raw FoV angles.",
-              description = "Sets a projection matrix using raw projection values.\n\nThis can be used for asymmetric or oblique projections.",
+              description = "Sets a projection matrix using raw projection angles and clipping planes.\n\nThis can be used for asymmetric or oblique projections.",
               key = "Mat4:fov",
               module = "lovr.math",
               related = {
@@ -15601,22 +15601,22 @@ return {
                     {
                       name = "left",
                       type = "number",
-                      description = "The left angle of the projection."
+                      description = "The left half-angle of the projection, in radians."
                     },
                     {
                       name = "right",
                       type = "number",
-                      description = "The right angle of the projection."
+                      description = "The right half-angle of the projection, in radians."
                     },
                     {
                       name = "up",
                       type = "number",
-                      description = "The top angle of the projection."
+                      description = "The top half-angle of the projection, in radians."
                     },
                     {
-                      name = "bottom",
+                      name = "down",
                       type = "number",
-                      description = "The bottom angle of the projection."
+                      description = "The bottom half-angle of the projection, in radians."
                     },
                     {
                       name = "near",
@@ -20740,7 +20740,7 @@ return {
                     {
                       name = "angle",
                       type = "number",
-                      description = "The hinge angle."
+                      description = "The hinge angle, in radians."
                     }
                   }
                 }
@@ -20795,12 +20795,12 @@ return {
                     {
                       name = "lower",
                       type = "number",
-                      description = "The lower limit."
+                      description = "The lower limit, in radians."
                     },
                     {
                       name = "upper",
                       type = "number",
-                      description = "The upper limit."
+                      description = "The upper limit, in radians."
                     }
                   }
                 }
@@ -20826,7 +20826,7 @@ return {
                     {
                       name = "limit",
                       type = "number",
-                      description = "The lower limit."
+                      description = "The lower limit, in radians."
                     }
                   }
                 }
@@ -20852,7 +20852,7 @@ return {
                     {
                       name = "limit",
                       type = "number",
-                      description = "The upper limit."
+                      description = "The upper limit, in radians."
                     }
                   }
                 }
@@ -20935,12 +20935,12 @@ return {
                     {
                       name = "lower",
                       type = "number",
-                      description = "The lower limit."
+                      description = "The lower limit, in radians."
                     },
                     {
                       name = "upper",
                       type = "number",
-                      description = "The upper limit."
+                      description = "The upper limit, in radians."
                     }
                   },
                   returns = {}
@@ -20966,7 +20966,7 @@ return {
                     {
                       name = "limit",
                       type = "number",
-                      description = "The lower limit."
+                      description = "The lower limit, in radians."
                     }
                   },
                   returns = {}
@@ -20992,7 +20992,7 @@ return {
                     {
                       name = "limit",
                       type = "number",
-                      description = "The upper limit."
+                      description = "The upper limit, in radians."
                     }
                   },
                   returns = {}

+ 1 - 1
api/lovr/graphics/Mesh/draw.lua

@@ -25,7 +25,7 @@ return {
     angle = {
       type = 'number',
       default = '0',
-      description = 'The angle to rotate the Mesh around its axis of rotation.'
+      description = 'The angle to rotate the Mesh around the axis of rotation, in radians.'
     },
     ax = {
       type = 'number',

+ 1 - 1
api/lovr/graphics/Model/draw.lua

@@ -25,7 +25,7 @@ return {
     angle = {
       type = 'number',
       default = '0',
-      description = 'The angle to rotate the Model around its axis of rotation.'
+      description = 'The angle to rotate the Model around the axis of rotation, in radians.'
     },
     ax = {
       type = 'number',

+ 1 - 1
api/lovr/graphics/Model/pose.lua

@@ -30,7 +30,7 @@ return {
     },
     angle = {
       type = 'number',
-      description = 'The angle of the orientation.'
+      description = 'The angle of rotation around the axis, in radians.'
     },
     ax = {
       type = 'number',

+ 6 - 6
api/lovr/math/Mat4/fov.lua

@@ -1,7 +1,7 @@
 return {
   summary = 'Set a projection using raw FoV angles.',
   description = [[
-    Sets a projection matrix using raw projection values.
+    Sets a projection matrix using raw projection angles and clipping planes.
 
     This can be used for asymmetric or oblique projections.
   ]],
@@ -9,22 +9,22 @@ return {
     {
       name = 'left',
       type = 'number',
-      description = 'The left angle of the projection.'
+      description = 'The left half-angle of the projection, in radians.'
     },
     {
       name = 'right',
       type = 'number',
-      description = 'The right angle of the projection.'
+      description = 'The right half-angle of the projection, in radians.'
     },
     {
       name = 'up',
       type = 'number',
-      description = 'The top angle of the projection.'
+      description = 'The top half-angle of the projection, in radians.'
     },
     {
-      name = 'bottom',
+      name = 'down',
       type = 'number',
-      description = 'The bottom angle of the projection.'
+      description = 'The bottom half-angle of the projection, in radians.'
     },
     {
       name = 'near',

+ 1 - 1
api/lovr/physics/HingeJoint/getAngle.lua

@@ -9,7 +9,7 @@ return {
     {
       name = 'angle',
       type = 'number',
-      description = 'The hinge angle.'
+      description = 'The hinge angle, in radians.'
     }
   }
 }

+ 2 - 2
api/lovr/physics/HingeJoint/getLimits.lua

@@ -8,12 +8,12 @@ return {
     {
       name = 'lower',
       type = 'number',
-      description = 'The lower limit.'
+      description = 'The lower limit, in radians.'
     },
     {
       name = 'upper',
       type = 'number',
-      description = 'The upper limit.'
+      description = 'The upper limit, in radians.'
     }
   },
   related = {

+ 1 - 1
api/lovr/physics/HingeJoint/getLowerLimit.lua

@@ -6,7 +6,7 @@ return {
     {
       name = 'limit',
       type = 'number',
-      description = 'The lower limit.'
+      description = 'The lower limit, in radians.'
     }
   },
   related = {

+ 1 - 1
api/lovr/physics/HingeJoint/getUpperLimit.lua

@@ -6,7 +6,7 @@ return {
     {
       name = 'limit',
       type = 'number',
-      description = 'The upper limit.'
+      description = 'The upper limit, in radians.'
     }
   },
   related = {

+ 2 - 2
api/lovr/physics/HingeJoint/setLimits.lua

@@ -7,12 +7,12 @@ return {
     {
       name = 'lower',
       type = 'number',
-      description = 'The lower limit.'
+      description = 'The lower limit, in radians.'
     },
     {
       name = 'upper',
       type = 'number',
-      description = 'The upper limit.'
+      description = 'The upper limit, in radians.'
     }
   },
   returns = {},

+ 1 - 1
api/lovr/physics/HingeJoint/setLowerLimit.lua

@@ -5,7 +5,7 @@ return {
     {
       name = 'limit',
       type = 'number',
-      description = 'The lower limit.'
+      description = 'The lower limit, in radians.'
     }
   },
   returns = {},

+ 1 - 1
api/lovr/physics/HingeJoint/setUpperLimit.lua

@@ -5,7 +5,7 @@ return {
     {
       name = 'limit',
       type = 'number',
-      description = 'The upper limit.'
+      description = 'The upper limit, in radians.'
     }
   },
   returns = {},