Gizmo: dial3d option to show the final angle
[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  * We can't use this for the #wmGizmoType.matrix_basis_get callback, it conflicts with depth picking.
107  */
108 static void dial_calc_matrix(const wmGizmo *gz, float mat[4][4])
109 {
110         float rot[3][3];
111         const float up[3] = {0.0f, 0.0f, 1.0f};
112
113         rotation_between_vecs_to_mat3(rot, up, gz->matrix_basis[2]);
114         copy_m4_m3(mat, rot);
115         copy_v3_v3(mat[3], gz->matrix_basis[3]);
116 }
117
118 /* -------------------------------------------------------------------- */
119
120 static void dial_geom_draw(
121         const wmGizmo *gz, const float color[4], const bool select,
122         float axis_modal_mat[4][4], float clip_plane[4])
123 {
124 #ifdef USE_GIZMO_CUSTOM_DIAL
125         UNUSED_VARS(dial, col, axis_modal_mat, clip_plane);
126         wm_gizmo_geometryinfo_draw(&wm_gizmo_geom_data_dial, select);
127 #else
128         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
129         const bool filled = (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_FILL) != 0;
130
131         GPU_line_width(gz->line_width);
132
133         GPUVertFormat *format = immVertexFormat();
134         uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
135
136         if (clip_plane) {
137                 immBindBuiltinProgram(GPU_SHADER_3D_CLIPPED_UNIFORM_COLOR);
138                 float clip_plane_f[4] = {clip_plane[0], clip_plane[1], clip_plane[2], clip_plane[3]};
139                 immUniform4fv("ClipPlane", clip_plane_f);
140                 immUniformMatrix4fv("ModelMatrix", axis_modal_mat);
141         }
142         else {
143                 immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
144         }
145
146         immUniformColor4fv(color);
147
148         if (filled) {
149                 imm_draw_circle_fill_2d(pos, 0, 0, 1.0, DIAL_RESOLUTION);
150         }
151         else {
152                 imm_draw_circle_wire_2d(pos, 0, 0, 1.0, DIAL_RESOLUTION);
153         }
154
155         immUnbindProgram();
156
157         UNUSED_VARS(select);
158 #endif
159 }
160
161 /**
162  * Draws a line from (0, 0, 0) to \a co_outer, at \a angle.
163  */
164 static void dial_ghostarc_draw_helpline(const float angle, const float co_outer[3], const float color[4])
165 {
166         GPU_line_width(1.0f);
167
168         GPU_matrix_push();
169         GPU_matrix_rotate_3f(RAD2DEGF(angle), 0.0f, 0.0f, -1.0f);
170
171         uint pos = GPU_vertformat_attr_add(immVertexFormat(), "pos", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
172
173         immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
174
175         immUniformColor4fv(color);
176
177         immBegin(GPU_PRIM_LINE_STRIP, 2);
178         immVertex3f(pos, 0.0f, 0.0f, 0.0f);
179         immVertex3fv(pos, co_outer);
180         immEnd();
181
182         immUnbindProgram();
183
184         GPU_matrix_pop();
185 }
186
187 static void dial_ghostarc_draw(
188         const wmGizmo *gz, const float angle_ofs, const float angle_delta, const float color[4])
189 {
190         const float width_inner = DIAL_WIDTH - gz->line_width * 0.5f / U.gizmo_size;
191
192         GPUVertFormat *format = immVertexFormat();
193         uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 2, GPU_FETCH_FLOAT);
194         immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
195         immUniformColor4fv(color);
196         imm_draw_disk_partial_fill_2d(
197                 pos, 0, 0, 0.0, width_inner, DIAL_RESOLUTION, RAD2DEGF(angle_ofs), RAD2DEGF(angle_delta));
198         immUnbindProgram();
199 }
200
201 static void dial_ghostarc_get_angles(
202         struct Depsgraph *depsgraph,
203         const wmGizmo *gz,
204         const wmEvent *event,
205         const ARegion *ar, const View3D *v3d,
206         float mat[4][4], const float co_outer[3],
207         float *r_start, float *r_delta)
208 {
209         DialInteraction *inter = gz->interaction_data;
210         const RegionView3D *rv3d = ar->regiondata;
211         const float mval[2] = {event->x - ar->winrct.xmin, event->y - ar->winrct.ymin};
212
213         /* we might need to invert the direction of the angles */
214         float view_vec[3], axis_vec[3];
215         ED_view3d_global_to_vector(rv3d, gz->matrix_basis[3], view_vec);
216         normalize_v3_v3(axis_vec, gz->matrix_basis[2]);
217
218         float proj_outer_rel[3];
219         mul_v3_project_m4_v3(proj_outer_rel, mat, co_outer);
220         sub_v3_v3(proj_outer_rel, gz->matrix_basis[3]);
221
222         float proj_mval_new_rel[3];
223         float proj_mval_init_rel[3];
224         float dial_plane[4];
225         float ray_co[3], ray_no[3];
226         float ray_lambda;
227
228         plane_from_point_normal_v3(dial_plane, gz->matrix_basis[3], axis_vec);
229
230         if (!ED_view3d_win_to_ray(depsgraph, ar, v3d, inter->init.mval, ray_co, ray_no, false) ||
231             !isect_ray_plane_v3(ray_co, ray_no, dial_plane, &ray_lambda, false))
232         {
233                 goto fail;
234         }
235         madd_v3_v3v3fl(proj_mval_init_rel, ray_co, ray_no, ray_lambda);
236         sub_v3_v3(proj_mval_init_rel, gz->matrix_basis[3]);
237
238         if (!ED_view3d_win_to_ray(depsgraph, ar, v3d, mval, ray_co, ray_no, false) ||
239             !isect_ray_plane_v3(ray_co, ray_no, dial_plane, &ray_lambda, false))
240         {
241                 goto fail;
242         }
243         madd_v3_v3v3fl(proj_mval_new_rel, ray_co, ray_no, ray_lambda);
244         sub_v3_v3(proj_mval_new_rel, gz->matrix_basis[3]);
245
246         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
247
248         /* Start direction from mouse or set by user */
249         const float *proj_init_rel =
250                 (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_START_Y) ?
251                 gz->matrix_basis[1] : proj_mval_init_rel;
252
253         /* return angles */
254         const float start = angle_wrap_rad(angle_signed_on_axis_v3v3_v3(proj_outer_rel, proj_init_rel, axis_vec));
255         const float delta = angle_wrap_rad(angle_signed_on_axis_v3v3_v3(proj_mval_init_rel, proj_mval_new_rel, axis_vec));
256
257         /* Change of sign, we passed the 180 degree threshold. This means we need to add a turn
258          * to distinguish between transition from 0 to -1 and -PI to +PI, use comparison with PI/2.
259          * Logic taken from BLI_dial_angle */
260         if ((delta * inter->prev.angle < 0.0f) &&
261             (fabsf(inter->prev.angle) > (float)M_PI_2))
262         {
263                 if (inter->prev.angle < 0.0f)
264                         inter->rotations--;
265                 else
266                         inter->rotations++;
267         }
268         inter->prev.angle = delta;
269
270         const bool wrap_angle = RNA_boolean_get(gz->ptr, "wrap_angle");
271         const double delta_final = (double)delta + ((2 * M_PI) * (double)inter->rotations);
272         *r_start = start;
273         *r_delta = (float)(wrap_angle ? fmod(delta_final, 2 * M_PI) : delta_final);
274         return;
275
276         /* If we can't project (unlikely). */
277 fail:
278         *r_start = 0.0;
279         *r_delta = 0.0;
280 }
281
282 static void dial_ghostarc_draw_with_helplines(wmGizmo *gz, float angle_ofs, float angle_delta, float color_helpline[4])
283 {
284         const float co_outer[4] = {0.0f, DIAL_WIDTH, 0.0f}; /* coordinate at which the arc drawing will be started */
285         GPU_polygon_smooth(false);
286         dial_ghostarc_draw(gz, angle_ofs, angle_delta, (const float[4]){0.8f, 0.8f, 0.8f, 0.4f});
287         GPU_polygon_smooth(true);
288
289         dial_ghostarc_draw_helpline(angle_ofs, co_outer, color_helpline);
290         dial_ghostarc_draw_helpline(angle_ofs + angle_delta, co_outer, color_helpline);
291 }
292
293 static void dial_draw_intern(
294         const bContext *C, wmGizmo *gz,
295         const bool select, const bool highlight, float clip_plane[4])
296 {
297         float matrix_basis_adjust[4][4];
298         float matrix_final[4][4];
299         float color[4];
300
301         BLI_assert(CTX_wm_area(C)->spacetype == SPACE_VIEW3D);
302
303         gizmo_color_get(gz, highlight, color);
304
305         dial_calc_matrix(gz, matrix_basis_adjust);
306
307         WM_gizmo_calc_matrix_final_params(
308                 gz, &((struct WM_GizmoMatrixParams) {
309                     .matrix_basis = (void *)matrix_basis_adjust,
310                 }), matrix_final);
311
312         GPU_matrix_push();
313         GPU_matrix_mul(matrix_final);
314
315         /* FIXME(campbell): look into removing this. */
316         if ((gz->flag & WM_GIZMO_DRAW_VALUE) &&
317             (gz->state & WM_GIZMO_STATE_MODAL))
318         {
319                 /* XXX, View3D rotation gizmo doesn't call modal. */
320                 if (!WM_gizmo_target_property_is_valid_any(gz)) {
321                         wmWindow *win = CTX_wm_window(C);
322                         gizmo_dial_modal((bContext *)C, gz, win->eventstate, 0);
323                 }
324         }
325
326         {
327                 float angle_ofs = 0.0f;
328                 float angle_delta = 0.0f;
329                 bool show_ghostarc = false;
330
331                 /* Draw rotation indicator arc first. */
332                 wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
333                 const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
334
335                 if (WM_gizmo_target_property_is_valid(gz_prop) &&
336                     (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE))
337                 {
338                         angle_ofs = 0.0f;
339                         angle_delta = WM_gizmo_target_property_float_get(gz, gz_prop);
340                         show_ghostarc = true;
341                 }
342                 else if ((gz->flag & WM_GIZMO_DRAW_VALUE) &&
343                          (gz->state & WM_GIZMO_STATE_MODAL))
344                 {
345                         DialInteraction *inter = gz->interaction_data;
346                         angle_ofs = inter->output.angle_ofs;
347                         angle_delta = inter->output.angle_delta;
348                         show_ghostarc = true;
349                 }
350
351                 if (show_ghostarc) {
352                         dial_ghostarc_draw_with_helplines(gz, angle_ofs, angle_delta, color);
353                         if ((draw_options & ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_MIRROR) != 0) {
354                                 angle_ofs += M_PI;
355                                 dial_ghostarc_draw_with_helplines(gz, angle_ofs, angle_delta, color);
356                         }
357                 }
358         }
359
360         /* draw actual dial gizmo */
361         dial_geom_draw(gz, color, select, matrix_basis_adjust, clip_plane);
362
363         GPU_matrix_pop();
364 }
365
366 static void gizmo_dial_draw_select(const bContext *C, wmGizmo *gz, int select_id)
367 {
368         float clip_plane_buf[4];
369         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
370         float *clip_plane = (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_CLIP) ? clip_plane_buf : NULL;
371
372         /* enable clipping if needed */
373         if (clip_plane) {
374                 ARegion *ar = CTX_wm_region(C);
375                 RegionView3D *rv3d = ar->regiondata;
376
377                 copy_v3_v3(clip_plane, rv3d->viewinv[2]);
378                 clip_plane[3] = -dot_v3v3(rv3d->viewinv[2], gz->matrix_basis[3]);
379                 clip_plane[3] += DIAL_CLIP_BIAS * gz->scale_final;
380                 glEnable(GL_CLIP_DISTANCE0);
381         }
382
383         GPU_select_load_id(select_id);
384         dial_draw_intern(C, gz, true, false, clip_plane);
385
386         if (clip_plane) {
387                 glDisable(GL_CLIP_DISTANCE0);
388         }
389 }
390
391 static void gizmo_dial_draw(const bContext *C, wmGizmo *gz)
392 {
393         const bool is_modal = gz->state & WM_GIZMO_STATE_MODAL;
394         const bool is_highlight = (gz->state & WM_GIZMO_STATE_HIGHLIGHT) != 0;
395         float clip_plane_buf[4];
396         const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
397         float *clip_plane = (!is_modal && (draw_options & ED_GIZMO_DIAL_DRAW_FLAG_CLIP)) ? clip_plane_buf : NULL;
398
399         /* enable clipping if needed */
400         if (clip_plane) {
401                 ARegion *ar = CTX_wm_region(C);
402                 RegionView3D *rv3d = ar->regiondata;
403
404                 copy_v3_v3(clip_plane, rv3d->viewinv[2]);
405                 clip_plane[3] = -dot_v3v3(rv3d->viewinv[2], gz->matrix_basis[3]);
406                 clip_plane[3] += DIAL_CLIP_BIAS * gz->scale_final;
407
408                 glEnable(GL_CLIP_DISTANCE0);
409         }
410
411         GPU_blend(true);
412         dial_draw_intern(C, gz, false, is_highlight, clip_plane);
413         GPU_blend(false);
414
415         if (clip_plane) {
416                 glDisable(GL_CLIP_DISTANCE0);
417         }
418 }
419
420 static int gizmo_dial_modal(
421         bContext *C, wmGizmo *gz, const wmEvent *event,
422         eWM_GizmoFlagTweak tweak_flag)
423 {
424         DialInteraction *inter = gz->interaction_data;
425         if ((event->type != MOUSEMOVE) && (inter->prev.tweak_flag == tweak_flag)) {
426                 return OPERATOR_RUNNING_MODAL;
427         }
428         const float co_outer[4] = {0.0f, DIAL_WIDTH, 0.0f}; /* coordinate at which the arc drawing will be started */
429         float angle_ofs, angle_delta;
430
431         float matrix[4][4];
432
433         dial_calc_matrix(gz, matrix);
434
435         dial_ghostarc_get_angles(
436                 CTX_data_depsgraph(C),
437                 gz, event, CTX_wm_region(C), CTX_wm_view3d(C), matrix, co_outer, &angle_ofs, &angle_delta);
438
439
440         if (tweak_flag & WM_GIZMO_TWEAK_SNAP) {
441                 const double snap = DEG2RAD(5);
442                 angle_delta = (float)roundf((double)angle_delta / snap) * snap;
443         }
444         if (tweak_flag & WM_GIZMO_TWEAK_PRECISE) {
445                 angle_delta *= 0.1f;
446         }
447         inter->output.angle_delta = angle_delta;
448         inter->output.angle_ofs = angle_ofs;
449
450         /* set the property for the operator and call its modal function */
451         wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
452         if (WM_gizmo_target_property_is_valid(gz_prop)) {
453                 WM_gizmo_target_property_float_set(C, gz, gz_prop, inter->init.prop_angle + angle_delta);
454         }
455
456         inter->prev.tweak_flag = tweak_flag;
457
458         return OPERATOR_RUNNING_MODAL;
459 }
460
461
462 static void gizmo_dial_setup(wmGizmo *gz)
463 {
464         const float dir_default[3] = {0.0f, 0.0f, 1.0f};
465
466         /* defaults */
467         copy_v3_v3(gz->matrix_basis[2], dir_default);
468 }
469
470 static int gizmo_dial_invoke(
471         bContext *UNUSED(C), wmGizmo *gz, const wmEvent *event)
472 {
473         DialInteraction *inter = MEM_callocN(sizeof(DialInteraction), __func__);
474
475         inter->init.mval[0] = event->mval[0];
476         inter->init.mval[1] = event->mval[1];
477
478         wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
479         if (WM_gizmo_target_property_is_valid(gz_prop)) {
480                 inter->init.prop_angle = WM_gizmo_target_property_float_get(gz, gz_prop);
481         }
482
483         gz->interaction_data = inter;
484
485         return OPERATOR_RUNNING_MODAL;
486 }
487
488 /* -------------------------------------------------------------------- */
489 /** \name Dial Gizmo API
490  *
491  * \{ */
492
493 static void GIZMO_GT_dial_3d(wmGizmoType *gzt)
494 {
495         /* identifiers */
496         gzt->idname = "GIZMO_GT_dial_3d";
497
498         /* api callbacks */
499         gzt->draw = gizmo_dial_draw;
500         gzt->draw_select = gizmo_dial_draw_select;
501         gzt->setup = gizmo_dial_setup;
502         gzt->invoke = gizmo_dial_invoke;
503         gzt->modal = gizmo_dial_modal;
504
505         gzt->struct_size = sizeof(wmGizmo);
506
507         /* rna */
508         static EnumPropertyItem rna_enum_draw_options[] = {
509                 {ED_GIZMO_DIAL_DRAW_FLAG_CLIP, "CLIP", 0, "Clipped", ""},
510                 {ED_GIZMO_DIAL_DRAW_FLAG_FILL, "FILL", 0, "Filled", ""},
511                 {ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_MIRROR, "ANGLE_MIRROR", 0, "Angle Mirror", ""},
512                 {ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_START_Y, "ANGLE_START_Y", 0, "Angle Start Y", ""},
513                 {ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE, "ANGLE_VALUE", 0, "Show Angle Value", ""},
514                 {0, NULL, 0, NULL, NULL}
515         };
516         RNA_def_enum_flag(gzt->srna, "draw_options", rna_enum_draw_options, 0, "Draw Options", "");
517         RNA_def_boolean(gzt->srna, "wrap_angle", true, "Wrap Angle", "");
518
519         WM_gizmotype_target_property_def(gzt, "offset", PROP_FLOAT, 1);
520 }
521
522 void ED_gizmotypes_dial_3d(void)
523 {
524         WM_gizmotype_append(GIZMO_GT_dial_3d);
525 }
526
527 /** \} */