Gizmo: remove matrix rotation for the dial gizmo
[blender.git] / source / blender / editors / gizmo_library / gizmo_types / dial3d_gizmo.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2014 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file dial3d_gizmo.c
27  *  \ingroup edgizmolib
28  *
29  * \name Dial Gizmo
30  *
31  * 3D Gizmo
32  *
33  * \brief Circle shaped gizmo for circular interaction.
34  * Currently no own handling, use with operator only.
35  *
36  * - `matrix[0]` is derived from Y and Z.
37  * - `matrix[1]` is 'up' when DialGizmo.use_start_y_axis is set.
38  * - `matrix[2]` is the axis the dial rotates around (all dials).
39  */
40
41 #include "MEM_guardedalloc.h"
42
43 #include "BLI_math.h"
44
45 #include "BKE_context.h"
46
47 #include "BIF_gl.h"
48 #include "BIF_glutil.h"
49
50 #include "GPU_immediate.h"
51 #include "GPU_immediate_util.h"
52 #include "GPU_matrix.h"
53 #include "GPU_select.h"
54 #include "GPU_state.h"
55
56 #include "RNA_access.h"
57 #include "RNA_define.h"
58
59 #include "WM_api.h"
60 #include "WM_types.h"
61
62 #include "ED_screen.h"
63 #include "ED_view3d.h"
64 #include "ED_gizmo_library.h"
65
66 /* own includes */
67 #include "../gizmo_geometry.h"
68 #include "../gizmo_library_intern.h"
69
70 /* To use custom dials exported to geom_dial_gizmo.c */
71 // #define USE_GIZMO_CUSTOM_DIAL
72
73 static int gizmo_dial_modal(
74         bContext *C, wmGizmo *gz, const wmEvent *event,
75         eWM_GizmoFlagTweak tweak_flag);
76
77 typedef struct DialInteraction {
78         struct {
79                 float mval[2];
80                 /* Only for when using properties. */
81                 float prop_angle;
82         } init;
83         struct {
84                 /* Cache the last angle to detect rotations bigger than -/+ PI. */
85                 eWM_GizmoFlagTweak tweak_flag;
86                 float angle;
87         } prev;
88
89         /* Number of full rotations. */
90         int rotations;
91
92         /* Final output values, used for drawing. */
93         struct {
94                 float angle_ofs;
95                 float angle_delta;
96         } output;
97 } DialInteraction;
98
99 #define DIAL_WIDTH       1.0f
100 #define DIAL_RESOLUTION 48
101
102 /* Could make option, negative to clip more (don't show when view aligned). */
103 #define DIAL_CLIP_BIAS 0.02
104
105 /* -------------------------------------------------------------------- */
106
107 static void dial_geom_draw(
108         const wmGizmo *gz, const float color[4], const bool select,
109         float axis_modal_mat[4][4], float clip_plane[4])
110 {
111 #ifdef USE_GIZMO_CUSTOM_DIAL
112         UNUSED_VARS(gz, axis_modal_mat, clip_plane);
113         wm_gizmo_geometryinfo_draw(&wm_gizmo_geom_data_dial, select, color);
114 #else
115         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
116         const bool filled = (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_FILL) != 0;
117
118         GPU_line_width(gz->line_width);
119
120         GPUVertFormat *format = immVertexFormat();
121         uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
122
123         if (clip_plane) {
124                 immBindBuiltinProgram(GPU_SHADER_3D_CLIPPED_UNIFORM_COLOR);
125                 float clip_plane_f[4] = {clip_plane[0], clip_plane[1], clip_plane[2], clip_plane[3]};
126                 immUniform4fv("ClipPlane", clip_plane_f);
127                 immUniformMatrix4fv("ModelMatrix", axis_modal_mat);
128         }
129         else {
130                 immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
131         }
132
133         immUniformColor4fv(color);
134
135         if (filled) {
136                 imm_draw_circle_fill_2d(pos, 0, 0, 1.0, DIAL_RESOLUTION);
137         }
138         else {
139                 imm_draw_circle_wire_2d(pos, 0, 0, 1.0, DIAL_RESOLUTION);
140         }
141
142         immUnbindProgram();
143
144         UNUSED_VARS(select);
145 #endif
146 }
147
148 /**
149  * Draws a line from (0, 0, 0) to \a co_outer, at \a angle.
150  */
151 static void dial_ghostarc_draw_helpline(const float angle, const float co_outer[3], const float color[4])
152 {
153         GPU_line_width(1.0f);
154
155         GPU_matrix_push();
156         GPU_matrix_rotate_3f(RAD2DEGF(angle), 0.0f, 0.0f, -1.0f);
157
158         uint pos = GPU_vertformat_attr_add(immVertexFormat(), "pos", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
159
160         immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
161
162         immUniformColor4fv(color);
163
164         immBegin(GPU_PRIM_LINE_STRIP, 2);
165         immVertex3f(pos, 0.0f, 0.0f, 0.0f);
166         immVertex3fv(pos, co_outer);
167         immEnd();
168
169         immUnbindProgram();
170
171         GPU_matrix_pop();
172 }
173
174 static void dial_ghostarc_draw(
175         const wmGizmo *gz, const float angle_ofs, const float angle_delta, const float color[4])
176 {
177         const float width_inner = DIAL_WIDTH - gz->line_width * 0.5f / U.gizmo_size;
178
179         GPUVertFormat *format = immVertexFormat();
180         uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
181         immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
182         immUniformColor4fv(color);
183         imm_draw_disk_partial_fill_2d(
184                 pos, 0, 0, 0.0, width_inner, DIAL_RESOLUTION, RAD2DEGF(angle_ofs), RAD2DEGF(angle_delta));
185         immUnbindProgram();
186 }
187
188 static void dial_ghostarc_get_angles(
189         struct Depsgraph *depsgraph,
190         const wmGizmo *gz,
191         const wmEvent *event,
192         const ARegion *ar, const View3D *v3d,
193         float mat[4][4], const float co_outer[3],
194         float *r_start, float *r_delta)
195 {
196         DialInteraction *inter = gz->interaction_data;
197         const RegionView3D *rv3d = ar->regiondata;
198         const float mval[2] = {event->x - ar->winrct.xmin, event->y - ar->winrct.ymin};
199
200         /* We might need to invert the direction of the angles. */
201         float view_vec[3], axis_vec[3];
202         ED_view3d_global_to_vector(rv3d, gz->matrix_basis[3], view_vec);
203         normalize_v3_v3(axis_vec, gz->matrix_basis[2]);
204
205         float proj_outer_rel[3];
206         mul_v3_project_m4_v3(proj_outer_rel, mat, co_outer);
207         sub_v3_v3(proj_outer_rel, gz->matrix_basis[3]);
208
209         float proj_mval_new_rel[3];
210         float proj_mval_init_rel[3];
211         float dial_plane[4];
212         float ray_co[3], ray_no[3];
213         float ray_lambda;
214
215         plane_from_point_normal_v3(dial_plane, gz->matrix_basis[3], axis_vec);
216
217         if (!ED_view3d_win_to_ray(depsgraph, ar, v3d, inter->init.mval, ray_co, ray_no, false) ||
218             !isect_ray_plane_v3(ray_co, ray_no, dial_plane, &ray_lambda, false))
219         {
220                 goto fail;
221         }
222         madd_v3_v3v3fl(proj_mval_init_rel, ray_co, ray_no, ray_lambda);
223         sub_v3_v3(proj_mval_init_rel, gz->matrix_basis[3]);
224
225         if (!ED_view3d_win_to_ray(depsgraph, ar, v3d, mval, ray_co, ray_no, false) ||
226             !isect_ray_plane_v3(ray_co, ray_no, dial_plane, &ray_lambda, false))
227         {
228                 goto fail;
229         }
230         madd_v3_v3v3fl(proj_mval_new_rel, ray_co, ray_no, ray_lambda);
231         sub_v3_v3(proj_mval_new_rel, gz->matrix_basis[3]);
232
233         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
234
235         /* Start direction from mouse or set by user. */
236         const float *proj_init_rel =
237                 (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_START_Y) ?
238                 gz->matrix_basis[1] : proj_mval_init_rel;
239
240         /* Return angles. */
241         const float start = angle_wrap_rad(angle_signed_on_axis_v3v3_v3(proj_outer_rel, proj_init_rel, axis_vec));
242         const float delta = angle_wrap_rad(angle_signed_on_axis_v3v3_v3(proj_mval_init_rel, proj_mval_new_rel, axis_vec));
243
244         /* Change of sign, we passed the 180 degree threshold. This means we need to add a turn
245          * to distinguish between transition from 0 to -1 and -PI to +PI, use comparison with PI/2.
246          * Logic taken from #BLI_dial_angle */
247         if ((delta * inter->prev.angle < 0.0f) &&
248             (fabsf(inter->prev.angle) > (float)M_PI_2))
249         {
250                 if (inter->prev.angle < 0.0f) {
251                         inter->rotations--;
252                 }
253                 else {
254                         inter->rotations++;
255                 }
256         }
257         inter->prev.angle = delta;
258
259         const bool wrap_angle = RNA_boolean_get(gz->ptr, "wrap_angle");
260         const double delta_final = (double)delta + ((2 * M_PI) * (double)inter->rotations);
261         *r_start = start;
262         *r_delta = (float)(wrap_angle ? fmod(delta_final, 2 * M_PI) : delta_final);
263         return;
264
265         /* If we can't project (unlikely). */
266 fail:
267         *r_start = 0.0;
268         *r_delta = 0.0;
269 }
270
271 static void dial_ghostarc_draw_with_helplines(wmGizmo *gz, float angle_ofs, float angle_delta, float color_helpline[4])
272 {
273         /* Coordinate at which the arc drawing will be started. */
274         const float co_outer[4] = {0.0f, DIAL_WIDTH, 0.0f};
275         dial_ghostarc_draw(gz, angle_ofs, angle_delta, (const float[4]){0.8f, 0.8f, 0.8f, 0.4f});
276         GPU_polygon_smooth(true);
277         dial_ghostarc_draw_helpline(angle_ofs, co_outer, color_helpline);
278         dial_ghostarc_draw_helpline(angle_ofs + angle_delta, co_outer, color_helpline);
279         GPU_polygon_smooth(false);
280 }
281
282 static void dial_draw_intern(
283         const bContext *C, wmGizmo *gz,
284         const bool select, const bool highlight, float clip_plane[4])
285 {
286         float matrix_final[4][4];
287         float color[4];
288
289         BLI_assert(CTX_wm_area(C)->spacetype == SPACE_VIEW3D);
290
291         gizmo_color_get(gz, highlight, color);
292
293         WM_gizmo_calc_matrix_final(gz, matrix_final);
294
295         GPU_matrix_push();
296         GPU_matrix_mul(matrix_final);
297
298         /* FIXME(campbell): look into removing this. */
299         if ((gz->flag & WM_GIZMO_DRAW_VALUE) &&
300             (gz->state & WM_GIZMO_STATE_MODAL))
301         {
302                 /* XXX, View3D rotation gizmo doesn't call modal. */
303                 if (!WM_gizmo_target_property_is_valid_any(gz)) {
304                         wmWindow *win = CTX_wm_window(C);
305                         gizmo_dial_modal((bContext *)C, gz, win->eventstate, 0);
306                 }
307         }
308
309         {
310                 float angle_ofs = 0.0f;
311                 float angle_delta = 0.0f;
312                 bool show_ghostarc = false;
313
314                 /* Draw rotation indicator arc first. */
315                 wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
316                 const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
317
318                 if (WM_gizmo_target_property_is_valid(gz_prop) &&
319                     (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE))
320                 {
321                         angle_ofs = 0.0f;
322                         angle_delta = WM_gizmo_target_property_float_get(gz, gz_prop);
323                         show_ghostarc = true;
324                 }
325                 else if ((gz->flag & WM_GIZMO_DRAW_VALUE) &&
326                          (gz->state & WM_GIZMO_STATE_MODAL))
327                 {
328                         DialInteraction *inter = gz->interaction_data;
329                         angle_ofs = inter->output.angle_ofs;
330                         angle_delta = inter->output.angle_delta;
331                         show_ghostarc = true;
332                 }
333
334                 if (show_ghostarc) {
335                         dial_ghostarc_draw_with_helplines(gz, angle_ofs, angle_delta, color);
336                         if ((draw_options & ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_MIRROR) != 0) {
337                                 angle_ofs += M_PI;
338                                 dial_ghostarc_draw_with_helplines(gz, angle_ofs, angle_delta, color);
339                         }
340                 }
341         }
342
343         /* Draw actual dial gizmo. */
344         dial_geom_draw(gz, color, select, gz->matrix_basis, clip_plane);
345
346         GPU_matrix_pop();
347 }
348
349 static void gizmo_dial_draw_select(const bContext *C, wmGizmo *gz, int select_id)
350 {
351         float clip_plane_buf[4];
352         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
353         float *clip_plane = (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_CLIP) ? clip_plane_buf : NULL;
354
355         if (clip_plane) {
356                 ARegion *ar = CTX_wm_region(C);
357                 RegionView3D *rv3d = ar->regiondata;
358
359                 copy_v3_v3(clip_plane, rv3d->viewinv[2]);
360                 clip_plane[3] = -dot_v3v3(rv3d->viewinv[2], gz->matrix_basis[3]);
361                 clip_plane[3] += DIAL_CLIP_BIAS * gz->scale_final;
362                 glEnable(GL_CLIP_DISTANCE0);
363         }
364
365         GPU_select_load_id(select_id);
366         dial_draw_intern(C, gz, true, false, clip_plane);
367
368         if (clip_plane) {
369                 glDisable(GL_CLIP_DISTANCE0);
370         }
371 }
372
373 static void gizmo_dial_draw(const bContext *C, wmGizmo *gz)
374 {
375         const bool is_modal = gz->state & WM_GIZMO_STATE_MODAL;
376         const bool is_highlight = (gz->state & WM_GIZMO_STATE_HIGHLIGHT) != 0;
377         float clip_plane_buf[4];
378         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
379         float *clip_plane = (!is_modal && (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_CLIP)) ? clip_plane_buf : NULL;
380
381         if (clip_plane) {
382                 ARegion *ar = CTX_wm_region(C);
383                 RegionView3D *rv3d = ar->regiondata;
384
385                 copy_v3_v3(clip_plane, rv3d->viewinv[2]);
386                 clip_plane[3] = -dot_v3v3(rv3d->viewinv[2], gz->matrix_basis[3]);
387                 clip_plane[3] += DIAL_CLIP_BIAS * gz->scale_final;
388
389                 glEnable(GL_CLIP_DISTANCE0);
390         }
391
392         GPU_blend(true);
393         dial_draw_intern(C, gz, false, is_highlight, clip_plane);
394         GPU_blend(false);
395
396         if (clip_plane) {
397                 glDisable(GL_CLIP_DISTANCE0);
398         }
399 }
400
401 static int gizmo_dial_modal(
402         bContext *C, wmGizmo *gz, const wmEvent *event,
403         eWM_GizmoFlagTweak tweak_flag)
404 {
405         DialInteraction *inter = gz->interaction_data;
406         if ((event->type != MOUSEMOVE) && (inter->prev.tweak_flag == tweak_flag)) {
407                 return OPERATOR_RUNNING_MODAL;
408         }
409         /* Coordinate at which the arc drawing will be started. */
410         const float co_outer[4] = {0.0f, DIAL_WIDTH, 0.0f};
411         float angle_ofs, angle_delta;
412
413         dial_ghostarc_get_angles(
414                 CTX_data_depsgraph(C),
415                 gz, event, CTX_wm_region(C), CTX_wm_view3d(C), gz->matrix_basis, co_outer, &angle_ofs, &angle_delta);
416
417         if (tweak_flag & WM_GIZMO_TWEAK_SNAP) {
418                 const double snap = DEG2RAD(5);
419                 angle_delta = (float)roundf((double)angle_delta / snap) * snap;
420         }
421         if (tweak_flag & WM_GIZMO_TWEAK_PRECISE) {
422                 angle_delta *= 0.1f;
423         }
424         inter->output.angle_delta = angle_delta;
425         inter->output.angle_ofs = angle_ofs;
426
427         /* Set the property for the operator and call its modal function. */
428         wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
429         if (WM_gizmo_target_property_is_valid(gz_prop)) {
430                 WM_gizmo_target_property_float_set(C, gz, gz_prop, inter->init.prop_angle + angle_delta);
431         }
432
433         inter->prev.tweak_flag = tweak_flag;
434
435         return OPERATOR_RUNNING_MODAL;
436 }
437
438
439 static void gizmo_dial_setup(wmGizmo *gz)
440 {
441         const float dir_default[3] = {0.0f, 0.0f, 1.0f};
442
443         /* defaults */
444         copy_v3_v3(gz->matrix_basis[2], dir_default);
445 }
446
447 static int gizmo_dial_invoke(
448         bContext *UNUSED(C), wmGizmo *gz, const wmEvent *event)
449 {
450         DialInteraction *inter = MEM_callocN(sizeof(DialInteraction), __func__);
451
452         inter->init.mval[0] = event->mval[0];
453         inter->init.mval[1] = event->mval[1];
454
455         wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
456         if (WM_gizmo_target_property_is_valid(gz_prop)) {
457                 inter->init.prop_angle = WM_gizmo_target_property_float_get(gz, gz_prop);
458         }
459
460         gz->interaction_data = inter;
461
462         return OPERATOR_RUNNING_MODAL;
463 }
464
465 /* -------------------------------------------------------------------- */
466 /** \name Dial Gizmo API
467  *
468  * \{ */
469
470 static void GIZMO_GT_dial_3d(wmGizmoType *gzt)
471 {
472         /* identifiers */
473         gzt->idname = "GIZMO_GT_dial_3d";
474
475         /* api callbacks */
476         gzt->draw = gizmo_dial_draw;
477         gzt->draw_select = gizmo_dial_draw_select;
478         gzt->setup = gizmo_dial_setup;
479         gzt->invoke = gizmo_dial_invoke;
480         gzt->modal = gizmo_dial_modal;
481
482         gzt->struct_size = sizeof(wmGizmo);
483
484         /* rna */
485         static EnumPropertyItem rna_enum_draw_options[] = {
486                 {ED_GIZMO_DIAL_DRAW_FLAG_CLIP, "CLIP", 0, "Clipped", ""},
487                 {ED_GIZMO_DIAL_DRAW_FLAG_FILL, "FILL", 0, "Filled", ""},
488                 {ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_MIRROR, "ANGLE_MIRROR", 0, "Angle Mirror", ""},
489                 {ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_START_Y, "ANGLE_START_Y", 0, "Angle Start Y", ""},
490                 {ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE, "ANGLE_VALUE", 0, "Show Angle Value", ""},
491                 {0, NULL, 0, NULL, NULL}
492         };
493         RNA_def_enum_flag(gzt->srna, "draw_options", rna_enum_draw_options, 0, "Draw Options", "");
494         RNA_def_boolean(gzt->srna, "wrap_angle", true, "Wrap Angle", "");
495
496         WM_gizmotype_target_property_def(gzt, "offset", PROP_FLOAT, 1);
497 }
498
499 void ED_gizmotypes_dial_3d(void)
500 {
501         WM_gizmotype_append(GIZMO_GT_dial_3d);
502 }
503
504 /** \} */