diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 11:01:14 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-20 11:07:10 +0300 |
commit | fdb2167b4ad9f140708e38bfcc30fdbd3168bf1e (patch) | |
tree | 5d4ef81b5364de8ff13698cd719bcc43a49d19d7 /source/blender/blenlib/BLI_math_rotation.h | |
parent | 5c63c0a58ca34d12cf70bf0021cf851f4e6192d6 (diff) |
Docs: use doxygen formatting for BLI
Differentiate doc-strings from title/section text.
Diffstat (limited to 'source/blender/blenlib/BLI_math_rotation.h')
-rw-r--r-- | source/blender/blenlib/BLI_math_rotation.h | 30 |
1 files changed, 14 insertions, 16 deletions
diff --git a/source/blender/blenlib/BLI_math_rotation.h b/source/blender/blenlib/BLI_math_rotation.h index 5e72d502262..8106251684d 100644 --- a/source/blender/blenlib/BLI_math_rotation.h +++ b/source/blender/blenlib/BLI_math_rotation.h @@ -57,7 +57,8 @@ void unit_axis_angle(float axis[3], float *angle); void unit_qt(float q[4]); void copy_qt_qt(float q[4], const float a[4]); -/* arithmetic */ +/* Arithmetic. */ + void mul_qt_qtqt(float q[4], const float a[4], const float b[4]); /** * \note @@ -106,7 +107,8 @@ float dot_qtqt(const float a[4], const float b[4]); float normalize_qt(float q[4]); float normalize_qt_qt(float r[4], const float q[4]); -/* comparison */ +/* Comparison. */ + bool is_zero_qt(const float q[4]); /* interpolation */ @@ -122,7 +124,8 @@ void interp_dot_slerp(const float t, const float cosom, float r_w[2]); void interp_qt_qtqt(float q[4], const float a[4], const float b[4], const float t); void add_qt_qtqt(float q[4], const float a[4], const float b[4], const float t); -/* conversion */ +/* Conversion. */ + void quat_to_mat3(float mat[3][3], const float q[4]); void quat_to_mat4(float mat[4][4], const float q[4]); @@ -188,7 +191,8 @@ float angle_signed_qtqt(const float q1[4], const float q2[4]); */ void mat3_to_quat_is_ok(float q[4], const float mat[3][3]); -/* other */ +/* Other. */ + void print_qt(const char *str, const float q[4]); #define print_qt_id(q) print_qt(STRINGIFY(q), q) @@ -199,7 +203,8 @@ void print_qt(const char *str, const float q[4]); /** \name Axis Angle * \{ */ -/* conversion */ +/* Conversion. */ + void axis_angle_normalized_to_quat(float r[4], const float axis[3], const float angle); void axis_angle_to_quat(float r[4], const float axis[3], const float angle); /** @@ -271,32 +276,25 @@ void expmap_to_quat(float r[4], const float expmap[3]); /** \name XYZ Eulers * \{ */ -/* XYZ order. */ void eul_to_quat(float quat[4], const float eul[3]); -/* XYZ order */ void eul_to_mat3(float mat[3][3], const float eul[3]); -/* XYZ order */ void eul_to_mat4(float mat[4][4], const float eul[3]); -/* XYZ order */ void mat3_normalized_to_eul(float eul[3], const float mat[3][3]); -/* XYZ order */ void mat4_normalized_to_eul(float eul[3], const float mat[4][4]); void mat3_to_eul(float eul[3], const float mat[3][3]); void mat4_to_eul(float eul[3], const float mat[4][4]); -/* XYZ order */ void quat_to_eul(float eul[3], const float quat[4]); -/* XYZ order */ void mat3_normalized_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]); void mat3_to_compatible_eul(float eul[3], const float old[3], float mat[3][3]); void quat_to_compatible_eul(float eul[3], const float oldrot[3], const float quat[4]); -/* order independent! */ -void compatible_eul(float eul[3], const float old[3]); - -/* XYZ order */ void rotate_eul(float eul[3], const char axis, const float angle); +/* Order independent. */ + +void compatible_eul(float eul[3], const float old[3]); + void add_eul_euleul(float r_eul[3], float a[3], float b[3], const short order); void sub_eul_euleul(float r_eul[3], float a[3], float b[3], const short order); |