doxygen: add newline after \file
[blender.git] / source / blender / blenlib / intern / math_geom_inline.c
index 0e243c5..58262b9 100644 (file)
@@ -1,6 +1,4 @@
 /*
- * ***** BEGIN GPL LICENSE BLOCK *****
- *
  * This program is free software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License
  * as published by the Free Software Foundation; either version 2
  *
  * The Original Code is: some of this file.
  *
- * ***** END GPL LICENSE BLOCK *****
  * */
 
-/** \file blender/blenlib/intern/math_geom_inline.c
- *  \ingroup bli
+/** \file
+ * \ingroup bli
  */
 
 #ifndef __MATH_GEOM_INLINE_C__
@@ -34,6 +31,9 @@
 
 #include <string.h>
 
+/* A few small defines. Keep'em local! */
+#define SMALL_NUMBER  1.e-8f
+
 /********************************** Polygons *********************************/
 
 MINLINE float cross_tri_v2(const float v1[2], const float v2[2], const float v3[2])
@@ -51,6 +51,12 @@ MINLINE float area_tri_v2(const float v1[2], const float v2[2], const float v3[2
        return fabsf(area_tri_signed_v2(v1, v2, v3));
 }
 
+MINLINE float area_squared_tri_v2(const float v1[2], const float v2[2], const float v3[2])
+{
+       float area = area_tri_signed_v2(v1, v2, v3);
+       return area * area;
+}
+
 /****************************** Spherical Harmonics **************************/
 
 MINLINE void zero_sh(float r[9])
@@ -190,6 +196,17 @@ MINLINE int axis_dominant_v3_single(const float vec[3])
               ((y > z) ? 1 : 2));
 }
 
+/* the dominant axis of an orthogonal vector */
+MINLINE int axis_dominant_v3_ortho_single(const float vec[3])
+{
+       const float x = fabsf(vec[0]);
+       const float y = fabsf(vec[1]);
+       const float z = fabsf(vec[2]);
+       return ((x < y) ?
+              ((x < z) ? 0 : 2) :
+              ((y < z) ? 1 : 2));
+}
+
 MINLINE int max_axis_v3(const float vec[3])
 {
        const float x = vec[0];
@@ -213,8 +230,8 @@ MINLINE int min_axis_v3(const float vec[3])
 /**
  * Simple method to find how many tri's we need when we already know the corner+poly count.
  *
- * \param poly_count The number of ngon's/tris (1-2 sided faces will give incorrect results)
- * \param corner_count - also known as loops in BMesh/DNA
+ * \param poly_count: The number of ngon's/tris (1-2 sided faces will give incorrect results)
+ * \param corner_count: also known as loops in BMesh/DNA
  */
 MINLINE int poly_to_tri_count(const int poly_count, const int corner_count)
 {
@@ -227,4 +244,63 @@ MINLINE float plane_point_side_v3(const float plane[4], const float co[3])
        return dot_v3v3(co, plane) + plane[3];
 }
 
+/* useful to calculate an even width shell, by taking the angle between 2 planes.
+ * The return value is a scale on the offset.
+ * no angle between planes is 1.0, as the angle between the 2 planes approaches 180d
+ * the distance gets very high, 180d would be inf, but this case isn't valid */
+MINLINE float shell_angle_to_dist(const float angle)
+{
+       return (UNLIKELY(angle < SMALL_NUMBER)) ? 1.0f : fabsf(1.0f / cosf(angle));
+}
+/**
+ * equivalent to ``shell_angle_to_dist(angle_normalized_v3v3(a, b))``
+ */
+MINLINE float shell_v3v3_normalized_to_dist(const float a[3], const float b[3])
+{
+       const float angle_cos = fabsf(dot_v3v3(a, b));
+       BLI_ASSERT_UNIT_V3(a);
+       BLI_ASSERT_UNIT_V3(b);
+       return (UNLIKELY(angle_cos < SMALL_NUMBER)) ? 1.0f : (1.0f / angle_cos);
+}
+/**
+ * equivalent to ``shell_angle_to_dist(angle_normalized_v2v2(a, b))``
+ */
+MINLINE float shell_v2v2_normalized_to_dist(const float a[2], const float b[2])
+{
+       const float angle_cos = fabsf(dot_v2v2(a, b));
+       BLI_ASSERT_UNIT_V2(a);
+       BLI_ASSERT_UNIT_V2(b);
+       return (UNLIKELY(angle_cos < SMALL_NUMBER)) ? 1.0f : (1.0f / angle_cos);
+}
+
+/**
+ * equivalent to ``shell_angle_to_dist(angle_normalized_v3v3(a, b) / 2)``
+ */
+MINLINE float shell_v3v3_mid_normalized_to_dist(const float a[3], const float b[3])
+{
+       float angle_cos;
+       float ab[3];
+       BLI_ASSERT_UNIT_V3(a);
+       BLI_ASSERT_UNIT_V3(b);
+       add_v3_v3v3(ab, a, b);
+       angle_cos = (normalize_v3(ab) != 0.0f) ? fabsf(dot_v3v3(a, ab)) : 0.0f;
+       return (UNLIKELY(angle_cos < SMALL_NUMBER)) ? 1.0f : (1.0f / angle_cos);
+}
+
+/**
+ * equivalent to ``shell_angle_to_dist(angle_normalized_v2v2(a, b) / 2)``
+ */
+MINLINE float shell_v2v2_mid_normalized_to_dist(const float a[2], const float b[2])
+{
+       float angle_cos;
+       float ab[2];
+       BLI_ASSERT_UNIT_V2(a);
+       BLI_ASSERT_UNIT_V2(b);
+       add_v2_v2v2(ab, a, b);
+       angle_cos = (normalize_v2(ab) != 0.0f) ? fabsf(dot_v2v2(a, ab)) : 0.0f;
+       return (UNLIKELY(angle_cos < SMALL_NUMBER)) ? 1.0f : (1.0f / angle_cos);
+}
+
+#undef SMALL_NUMBER
+
 #endif /* __MATH_GEOM_INLINE_C__ */