size -> diag, new sizev

duarm · Feb 23, 2024 · 131ac68 · 131ac68
1 parent 7e6a463
commit 131ac68
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 12 deletions.
diff --git a/docs/source/aabb2d.rst b/docs/source/aabb2d.rst
@@ -17,6 +17,10 @@ convert it before and after calling a cglm aabb2d function.
 Table of contents (click to go):
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+Macros:
+
+1. :c:func:`glm_aabb2d_size`
+
 Functions:
 
 1. :c:func:`glm_aabb2d_copy`
@@ -26,7 +30,8 @@ Functions:
 #. :c:func:`glm_aabb2d_crop_until`
 #. :c:func:`glm_aabb2d_invalidate`
 #. :c:func:`glm_aabb2d_isvalid`
-#. :c:func:`glm_aabb2d_size`
+#. :c:func:`glm_aabb2d_diag`
+#. :c:func:`glm_aabb2d_sizev`
 #. :c:func:`glm_aabb2d_radius`
 #. :c:func:`glm_aabb2d_center`
 #. :c:func:`glm_aabb2d_aabb`
@@ -111,16 +116,28 @@ Functions documentation
     Returns:
       returns true if aabb is valid otherwise false
 
-.. c:function:: float  glm_aabb2d_size(vec2 aabb[2])
+.. c:function:: float  glm_aabb2d_diag(vec2 aabb[2])
 
-    | distance between of min and max
+    | distance between min and max
 
     Parameters:
       | *[in]*   **aabb**     bounding box
 
     Returns:
       distance between min - max
 
+
+.. c:function:: void  glm_aabb2d_sizev(vec2 aabb[2], vec2 dest)
+
+    | size vector of aabb
+
+    Parameters:
+      | *[in]*   **aabb**     bounding box
+      | *[out]*  **dest**     size vector
+
+    Returns:
+      size vector of aabb max - min
+
 .. c:function:: float  glm_aabb2d_radius(vec2 aabb[2])
 
     | radius of sphere which surrounds AABB

diff --git a/include/cglm/aabb2d.h b/include/cglm/aabb2d.h
@@ -12,6 +12,9 @@
 #include "vec2.h"
 #include "util.h"
 
+/* DEPRECATED! use _diag */
+#define glm_aabb2d_size(aabb)         glm_aabb2d_diag(aabb)
+
 /*!
  * @brief copy all members of [aabb] to [dest]
  *
@@ -164,7 +167,7 @@ glm_aabb2d_isvalid(vec2 aabb[2]) {
  */
 CGLM_INLINE
 float
-glm_aabb2d_diagonal(vec2 aabb[2]) {
+glm_aabb2d_diag(vec2 aabb[2]) {
   return glm_vec2_distance(aabb[0], aabb[1]);
 }
 
@@ -176,7 +179,7 @@ glm_aabb2d_diagonal(vec2 aabb[2]) {
  */
 CGLM_INLINE
 void
-glm_aabb2d_size(vec2 aabb[2], vec2 dest) {
+glm_aabb2d_sizev(vec2 aabb[2], vec2 dest) {
   glm_vec2_sub(aabb[1], aabb[0], dest); 
 }
 
@@ -188,7 +191,7 @@ glm_aabb2d_size(vec2 aabb[2], vec2 dest) {
 CGLM_INLINE
 float
 glm_aabb2d_radius(vec2 aabb[2]) {
-  return glm_aabb2d_diagonal(aabb) * 0.5f;
+  return glm_aabb2d_diag(aabb) * 0.5f;
 }
 
 /*!

diff --git a/include/cglm/call/aabb2d.h b/include/cglm/call/aabb2d.h
@@ -50,11 +50,11 @@ glmc_aabb2d_isvalid(vec2 aabb[2]);
 
 CGLM_EXPORT
 float
-glmc_aabb2d_diagonal(vec2 aabb[2]);
+glmc_aabb2d_diag(vec2 aabb[2]);
 
 CGLM_EXPORT
 void
-glmc_aabb2d_size(vec2 aabb[2], vec2 dest);
+glmc_aabb2d_sizev(vec2 aabb[2], vec2 dest);
 
 CGLM_EXPORT
 float

diff --git a/src/aabb2d.c b/src/aabb2d.c
@@ -55,14 +55,14 @@ glmc_aabb2d_isvalid(vec2 aabb[2]) {
 
 CGLM_EXPORT
 float
-glmc_aabb2d_diagonal(vec2 aabb[2]) {
-  return glm_aabb2d_diagonal(aabb);
+glmc_aabb2d_diag(vec2 aabb[2]) {
+  return glm_aabb2d_diag(aabb);
 }
 
 CGLM_EXPORT
 void
-glmc_aabb2d_size(vec2 aabb[2], vec2 dest) {
-  return glm_aabb2d_size(aabb, dest);
+glmc_aabb2d_sizev(vec2 aabb[2], vec2 dest) {
+  glm_aabb2d_sizev(aabb, dest);
 }
 
 CGLM_EXPORT