Blender V5.3
BLI_math_rotation_c.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
5#pragma once
6
10
11#include "BLI_math_base_c.hh" // IWYU pragma: keep
12#include "BLI_math_constants.hh" // IWYU pragma: keep
13#include "BLI_utildefines.hh"
14
15#include "DNA_vec_types.h"
16
17namespace blender {
18
19/* -------------------------------------------------------------------- */
23
24/* Initialize */
25
26/* Convenience, avoids setting Y axis everywhere. */
27
28void unit_axis_angle(float axis[3], float *angle);
29void unit_qt(float q[4]);
30void copy_qt_qt(float q[4], const float a[4]);
31
32/* Arithmetic. */
33
34void mul_qt_qtqt(float q[4], const float a[4], const float b[4]);
54void mul_qt_v3(const float q[4], float r[3]);
58void mul_qt_fl(float q[4], float f);
59
63void pow_qt_fl_normalized(float q[4], float fac);
64
65void sub_qt_qtqt(float q[4], const float a[4], const float b[4]);
66
67void invert_qt(float q[4]);
68void invert_qt_qt(float q1[4], const float q2[4]);
74void invert_qt_normalized(float q[4]);
75void invert_qt_qt_normalized(float q1[4], const float q2[4]);
76void conjugate_qt(float q[4]);
77void conjugate_qt_qt(float q1[4], const float q2[4]);
78float dot_qtqt(const float a[4], const float b[4]);
79float normalize_qt(float q[4]);
80float normalize_qt_qt(float r[4], const float q[4]);
81
82/* Comparison. */
83
84bool is_zero_qt(const float q[4]);
85
86/* interpolation */
95void interp_dot_slerp(float t, float cosom, float r_w[2]);
96void interp_qt_qtqt(float q[4], const float a[4], const float b[4], float t);
97void add_qt_qtqt(float q[4], const float a[4], const float b[4], float t);
98
99/* Conversion. */
100
101void quat_to_mat3(float m[3][3], const float q[4]);
102void quat_to_mat4(float m[4][4], const float q[4]);
103
108void quat_to_compatible_quat(float q[4], const float a[4], const float old[4]);
109
113void mat3_normalized_to_quat_fast(float q[4], const float mat[3][3]);
114
115void mat3_normalized_to_quat(float q[4], const float mat[3][3]);
116void mat4_normalized_to_quat(float q[4], const float mat[4][4]);
117void mat3_to_quat(float q[4], const float mat[3][3]);
118void mat4_to_quat(float q[4], const float mat[4][4]);
123void tri_to_quat_ex(float quat[4],
124 const float v1[3],
125 const float v2[3],
126 const float v3[3],
127 const float no_orig[3]);
131float tri_to_quat(float q[4], const float a[3], const float b[3], const float c[3]);
132void vec_to_quat(float q[4], const float vec[3], short axis, short upflag);
137void rotation_between_vecs_to_mat3(float m[3][3], const float v1[3], const float v2[3]);
141void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3]);
142void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4]);
143
154float quat_split_swing_and_twist(const float q_in[4],
155 int axis,
156 float r_swing[4],
157 float r_twist[4]);
158
159float angle_normalized_qt(const float q[4]);
160float angle_normalized_qtqt(const float q1[4], const float q2[4]);
161float angle_qt(const float q[4]);
162float angle_qtqt(const float q1[4], const float q2[4]);
163
164float angle_signed_normalized_qt(const float q[4]);
165float angle_signed_normalized_qtqt(const float q1[4], const float q2[4]);
166float angle_signed_qt(const float q[4]);
167float angle_signed_qtqt(const float q1[4], const float q2[4]);
168
173void mat3_to_quat_legacy(float q[4], const float wmat[3][3]);
174
175/* Other. */
176
194void sin_cos_from_fraction(int numerator, int denominator, float *r_sin, float *r_cos);
195
196void print_qt(const char *str, const float q[4]);
197
198#define print_qt_id(q) print_qt(STRINGIFY(q), q)
199
201
202/* -------------------------------------------------------------------- */
205
206/* Conversion. */
207
208void axis_angle_normalized_to_quat(float r[4], const float axis[3], float angle);
209void axis_angle_to_quat(float r[4], const float axis[3], float angle);
213void axis_angle_to_mat3(float R[3][3], const float axis[3], float angle);
223void axis_angle_normalized_to_mat3_ex(float mat[3][3],
224 const float axis[3],
225 float angle_sin,
226 float angle_cos);
227void axis_angle_normalized_to_mat3(float R[3][3], const float axis[3], float angle);
231void axis_angle_to_mat4(float R[4][4], const float axis[3], float angle);
232
236void mat3_normalized_to_axis_angle(float axis[3], float *angle, const float mat[3][3]);
240void mat4_normalized_to_axis_angle(float axis[3], float *angle, const float mat[4][4]);
241void mat3_to_axis_angle(float axis[3], float *angle, const float mat[3][3]);
245void mat4_to_axis_angle(float axis[3], float *angle, const float mat[4][4]);
249void quat_to_axis_angle(float axis[3], float *angle, const float q[4]);
250
251void angle_to_mat2(float R[2][2], float angle);
255void axis_angle_to_mat3_single(float R[3][3], char axis, float angle);
259void axis_angle_to_mat4_single(float R[4][4], char axis, float angle);
260
261void axis_angle_to_quat_single(float q[4], char axis, float angle);
262
264
265/* -------------------------------------------------------------------- */
268
269void quat_to_expmap(float expmap[3], const float q[4]);
270void quat_normalized_to_expmap(float expmap[3], const float q[4]);
271void expmap_to_quat(float r[4], const float expmap[3]);
272
274
275/* -------------------------------------------------------------------- */
278
279void eul_to_quat(float quat[4], const float eul[3]);
280void eul_to_mat3(float mat[3][3], const float eul[3]);
281void eul_to_mat4(float mat[4][4], const float eul[3]);
282
283void mat3_normalized_to_eul(float eul[3], const float mat[3][3]);
284void mat4_normalized_to_eul(float eul[3], const float m[4][4]);
285void mat3_to_eul(float eul[3], const float mat[3][3]);
286void mat4_to_eul(float eul[3], const float mat[4][4]);
287void quat_to_eul(float eul[3], const float quat[4]);
288
289void mat3_normalized_to_compatible_eul(float eul[3], const float oldrot[3], float mat[3][3]);
290void mat3_to_compatible_eul(float eul[3], const float oldrot[3], float mat[3][3]);
291void quat_to_compatible_eul(float eul[3], const float oldrot[3], const float quat[4]);
292void rotate_eul(float beul[3], char axis, float angle);
293
294/* Order independent. */
295
303void compatible_eul(float eul[3], const float oldrot[3]);
304
305void add_eul_euleul(float r_eul[3], float a[3], float b[3], short order);
306void sub_eul_euleul(float r_eul[3], float a[3], float b[3], short order);
307
309
310/* -------------------------------------------------------------------- */
313
314/* WARNING: must match the #eRotationModes in `DNA_action_types.h`
315 * order matters - types are saved to file. */
316
318 EULER_ORDER_DEFAULT = 1, /* blender classic = XYZ */
325 /* There are 6 more entries with duplicate entries included. */
326};
327
331void eulO_to_quat(float q[4], const float e[3], short order);
335void eulO_to_mat3(float M[3][3], const float e[3], short order);
339void eulO_to_mat4(float mat[4][4], const float e[3], short order);
343void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], short order);
347void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], short order);
348
352void mat3_normalized_to_eulO(float eul[3], short order, const float m[3][3]);
356void mat4_normalized_to_eulO(float eul[3], short order, const float m[4][4]);
357void mat3_to_eulO(float eul[3], short order, const float m[3][3]);
358void mat4_to_eulO(float eul[3], short order, const float m[4][4]);
362void quat_to_eulO(float e[3], short order, const float q[4]);
366void axis_angle_to_eulO(float eul[3], short order, const float axis[3], float angle);
367
368/* Uses 2 methods to retrieve eulers, and picks the closest. */
369
370void mat3_normalized_to_compatible_eulO(float eul[3],
371 const float oldrot[3],
372 short order,
373 const float mat[3][3]);
374void mat4_normalized_to_compatible_eulO(float eul[3],
375 const float oldrot[3],
376 short order,
377 const float mat[4][4]);
378void mat3_to_compatible_eulO(float eul[3],
379 const float oldrot[3],
380 short order,
381 const float mat[3][3]);
382void mat4_to_compatible_eulO(float eul[3],
383 const float oldrot[3],
384 short order,
385 const float mat[4][4]);
386void quat_to_compatible_eulO(float eul[3],
387 const float oldrot[3],
388 short order,
389 const float quat[4]);
390
391void rotate_eulO(float beul[3], short order, char axis, float angle);
392
394
395/* -------------------------------------------------------------------- */
398
399void copy_dq_dq(DualQuat *r, const DualQuat *dq);
400void normalize_dq(DualQuat *dq, float totweight);
401void add_weighted_dq_dq(DualQuat *dq_sum, const DualQuat *dq, float weight);
406void add_weighted_dq_dq_pivot(DualQuat *dq_sum,
407 const DualQuat *dq,
408 const float pivot[3],
409 float weight,
410 bool compute_scale_matrix);
411void mul_v3m3_dq(float r[3], float R[3][3], DualQuat *dq);
412
413void mat4_to_dquat(DualQuat *dq, const float basemat[4][4], const float mat[4][4]);
414void dquat_to_mat4(float R[4][4], const DualQuat *dq);
415
419void quat_apply_track(float quat[4], short axis, short upflag);
420void vec_apply_track(float vec[3], short axis);
421
425float focallength_to_fov(float focal_length, float sensor);
426float fov_to_focallength(float hfov, float sensor);
427
428float angle_wrap_rad(float angle);
429float angle_wrap_deg(float angle);
430
434float angle_compat_rad(float angle, float angle_compat);
435
441 int src_forward, int src_up, int dst_forward, int dst_up, float r_mat[3][3]);
445bool mat3_from_axis_conversion_single(int src_axis, int dst_axis, float r_mat[3][3]);
446
448
449} // namespace blender
SIMD_FORCE_INLINE btScalar angle(const btVector3 &v) const
Return the angle between this and another vector.
Definition btVector3.h:356
#define str(s)
#define M
#define R
BMesh Iterators.
void eul_to_mat3(float mat[3][3], const float eul[3])
void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q2[4])
void axis_angle_to_eulO(float eul[3], short order, const float axis[3], float angle)
float angle_signed_normalized_qtqt(const float q1[4], const float q2[4])
void mat4_to_quat(float q[4], const float mat[4][4])
void conjugate_qt(float q[4])
void mat3_normalized_to_axis_angle(float axis[3], float *angle, const float mat[3][3])
float quat_split_swing_and_twist(const float q_in[4], int axis, float r_swing[4], float r_twist[4])
void axis_angle_normalized_to_quat(float r[4], const float axis[3], float angle)
void invert_qt(float q[4])
void mat3_to_compatible_eul(float eul[3], const float oldrot[3], float mat[3][3])
void vec_to_quat(float q[4], const float vec[3], short axis, short upflag)
float angle_compat_rad(float angle, float angle_compat)
void mat3_normalized_to_quat(float q[4], const float mat[3][3])
float angle_normalized_qt(const float q[4])
float tri_to_quat(float q[4], const float a[3], const float b[3], const float c[3])
void copy_dq_dq(DualQuat *r, const DualQuat *dq)
float normalize_qt(float q[4])
void mat4_normalized_to_quat(float q[4], const float mat[4][4])
float dot_qtqt(const float a[4], const float b[4])
void rotate_eul(float beul[3], char axis, float angle)
void add_weighted_dq_dq_pivot(DualQuat *dq_sum, const DualQuat *dq, const float pivot[3], float weight, bool compute_scale_matrix)
void quat_to_eul(float eul[3], const float quat[4])
void mat3_to_compatible_eulO(float eul[3], const float oldrot[3], short order, const float mat[3][3])
void axis_angle_to_mat3(float R[3][3], const float axis[3], float angle)
void axis_angle_to_quat(float r[4], const float axis[3], float angle)
void expmap_to_quat(float r[4], const float expmap[3])
void mat4_to_eul(float eul[3], const float mat[4][4])
void mat4_normalized_to_eulO(float eul[3], short order, const float m[4][4])
void rotation_between_vecs_to_quat(float q[4], const float v1[3], const float v2[3])
void axis_angle_to_mat4(float R[4][4], const float axis[3], float angle)
void interp_dot_slerp(float t, float cosom, float r_w[2])
void mul_qt_qtqt(float q[4], const float a[4], const float b[4])
float angle_signed_normalized_qt(const float q[4])
void invert_qt_qt(float q1[4], const float q2[4])
void mat3_normalized_to_compatible_eulO(float eul[3], const float oldrot[3], short order, const float mat[3][3])
void mat3_normalized_to_eul(float eul[3], const float mat[3][3])
void sub_eul_euleul(float r_eul[3], float a[3], float b[3], short order)
void sin_cos_from_fraction(int numerator, int denominator, float *r_sin, float *r_cos)
bool mat3_from_axis_conversion_single(int src_axis, int dst_axis, float r_mat[3][3])
void eulO_to_gimbal_axis(float gmat[3][3], const float eul[3], short order)
void quat_to_compatible_eulO(float eul[3], const float oldrot[3], short order, const float quat[4])
void quat_to_compatible_quat(float q[4], const float a[4], const float old[4])
void mul_qt_v3(const float q[4], float r[3])
void eulO_to_mat3(float M[3][3], const float e[3], short order)
void add_eul_euleul(float r_eul[3], float a[3], float b[3], short order)
void unit_axis_angle(float axis[3], float *angle)
void unit_qt(float q[4])
void quat_to_mat3(float m[3][3], const float q[4])
float focallength_to_fov(float focal_length, float sensor)
void normalize_dq(DualQuat *dq, float totweight)
void quat_to_compatible_eul(float eul[3], const float oldrot[3], const float quat[4])
void vec_apply_track(float vec[3], short axis)
void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], short order)
void mat3_normalized_to_quat_fast(float q[4], const float mat[3][3])
void copy_qt_qt(float q[4], const float a[4])
void sub_qt_qtqt(float q[4], const float a[4], const float b[4])
void interp_qt_qtqt(float q[4], const float a[4], const float b[4], float t)
void print_qt(const char *str, const float q[4])
void eul_to_quat(float quat[4], const float eul[3])
void axis_angle_to_quat_single(float q[4], char axis, float angle)
void quat_to_eulO(float e[3], short order, const float q[4])
void mat3_to_quat_legacy(float q[4], const float wmat[3][3])
void mat3_to_eul(float eul[3], const float mat[3][3])
void quat_to_axis_angle(float axis[3], float *angle, const float q[4])
bool mat3_from_axis_conversion(int src_forward, int src_up, int dst_forward, int dst_up, float r_mat[3][3])
void invert_qt_normalized(float q[4])
void mat4_to_compatible_eulO(float eul[3], const float oldrot[3], short order, const float mat[4][4])
float angle_wrap_deg(float angle)
void mat3_to_axis_angle(float axis[3], float *angle, const float mat[3][3])
void angle_to_mat2(float R[2][2], float angle)
void mat4_to_eulO(float eul[3], short order, const float m[4][4])
void quat_apply_track(float quat[4], short axis, short upflag)
void mat3_normalized_to_compatible_eul(float eul[3], const float oldrot[3], float mat[3][3])
float angle_normalized_qtqt(const float q1[4], const float q2[4])
float angle_qtqt(const float q1[4], const float q2[4])
void mat4_to_dquat(DualQuat *dq, const float basemat[4][4], const float mat[4][4])
void eul_to_mat4(float mat[4][4], const float eul[3])
void mat4_to_axis_angle(float axis[3], float *angle, const float mat[4][4])
void axis_angle_to_mat4_single(float R[4][4], char axis, float angle)
void mat4_normalized_to_compatible_eulO(float eul[3], const float oldrot[3], short order, const float mat[4][4])
ATTR_WARN_UNUSED_RESULT const BMVert * v2
float fov_to_focallength(float hfov, float sensor)
void mat4_normalized_to_axis_angle(float axis[3], float *angle, const float mat[4][4])
bool is_zero_qt(const float q[4])
void eulO_to_quat(float q[4], const float e[3], short order)
void add_qt_qtqt(float q[4], const float a[4], const float b[4], float t)
float angle_signed_qt(const float q[4])
void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3], float angle_sin, float angle_cos)
void dquat_to_mat4(float R[4][4], const DualQuat *dq)
void eulO_to_mat4(float mat[4][4], const float e[3], short order)
void quat_to_expmap(float expmap[3], const float q[4])
void mat4_normalized_to_eul(float eul[3], const float m[4][4])
void invert_qt_qt_normalized(float q1[4], const float q2[4])
void quat_normalized_to_expmap(float expmap[3], const float q[4])
void add_weighted_dq_dq(DualQuat *dq_sum, const DualQuat *dq, float weight)
void tri_to_quat_ex(float quat[4], const float v1[3], const float v2[3], const float v3[3], const float no_orig[3])
void compatible_eul(float eul[3], const float oldrot[3])
void conjugate_qt_qt(float q1[4], const float q2[4])
void mat3_to_eulO(float eul[3], short order, const float m[3][3])
float angle_signed_qtqt(const float q1[4], const float q2[4])
void axis_angle_normalized_to_mat3(float R[3][3], const float axis[3], float angle)
void mul_v3m3_dq(float r[3], float R[3][3], DualQuat *dq)
float angle_qt(const float q[4])
void mul_qt_fl(float q[4], float f)
void mat3_to_quat(float q[4], const float mat[3][3])
void rotation_between_vecs_to_mat3(float m[3][3], const float v1[3], const float v2[3])
ATTR_WARN_UNUSED_RESULT const BMVert const BMEdge * e
void mat3_normalized_to_eulO(float eul[3], short order, const float m[3][3])
void axis_angle_to_mat3_single(float R[3][3], char axis, float angle)
void quat_to_mat4(float m[4][4], const float q[4])
void pow_qt_fl_normalized(float q[4], float fac)
float normalize_qt_qt(float r[4], const float q[4])
void rotate_eulO(float beul[3], short order, char axis, float angle)
float angle_wrap_rad(float angle)