Docs: diagram for reflect_v3_v3v3

2017-04-21 17:26:27 +10:00 · 2017-04-21 17:26:27 +10:00 · 55a3d48046
commit 55a3d48046
parent 13ee5ba467
1 changed files with 13 additions and 1 deletions
--- a/source/blender/blenlib/intern/math_vector.c
+++ b/source/blender/blenlib/intern/math_vector.c
@ -697,7 +697,19 @@ void bisect_v3_v3v3v3(float out[3], const float v1[3], const float v2[3], const

 /**
 * Returns a reflection vector from a vector and a normal vector
- * reflect = vec - ((2 * DotVecs(vec, mirror)) * mirror)
+ * reflect = vec - ((2 * dot(vec, mirror)) * mirror).
+ *
+ * <pre>
+ * v
+ * +  ^
+ *  \ |
+ *   \|
+ *    + normal: axis of reflection
+ *   /
+ *  /
+ * +
+ * out: result (negate for a 'bounce').
+ * </pre>
 */
 void reflect_v3_v3v3(float out[3], const float v[3], const float normal[3])
 {