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