Remove workaround for drawing the rotation gizmo

Since [0], transform gizmos are no longer hidden during transform.

The same can be observed for rotation gizmos.

However, as a workaround for these rotation gizmos, there was already a
drawing utility running.

With the gizmo and the utility this drawing is now being done twice.

So remove the utility/workaround and update the gizmo accordingly.

[0] {648350e456490f8d6258e7de9bf94d3a6a34dbb2}

Differential Revision: https://developer.blender.org/D9542

7 files changed, 149 insertions, 156 deletions

diff --git a/source/blender/editors/gizmo_library/gizmo_types/dial3d_gizmo.c b/source/blender/editors/gizmo_library/gizmo_types/dial3d_gizmo.c
index 1d9fc35eda8..71db88419d5 100644
--- a/source/blender/editors/gizmo_library/gizmo_types/dial3d_gizmo.c
+++ b/source/blender/editors/gizmo_library/gizmo_types/dial3d_gizmo.c
@@ -77,6 +77,21 @@ typedef struct DialInteraction {
 #define DIAL_CLIP_BIAS 0.02
 
 /* -------------------------------------------------------------------- */
+struct Dial3dParams {
+  int draw_options;
+  float angle_ofs;
+  float angle_delta;
+  float angle_increment;
+  float arc_partial_angle;
+  float arc_inner_factor;
+  float *clip_plane;
+};
+static void dial_3d_draw_util(const float matrix_basis[4][4],
+                              const float matrix_final[4][4],
+                              const float line_width,
+                              const float color[4],
+                              const bool select,
+                              struct Dial3dParams *params);
 
 static void dial_geom_draw(const float color[4],
                            const float line_width,
@@ -411,23 +426,24 @@ static void dial_draw_intern(
       if (WM_gizmo_target_property_is_valid(gz_prop)) {
         angle_delta = WM_gizmo_target_property_float_get(gz, gz_prop);
       }
+      angle_increment = RNA_float_get(gz->ptr, "incremental_angle");
     }
   }
 
-  ED_gizmotypes_dial_3d_draw_util(gz->matrix_basis,
-                                  matrix_final,
-                                  gz->line_width,
-                                  color,
-                                  select,
-                                  &(struct Dial3dParams){
-                                      .draw_options = draw_options,
-                                      .angle_ofs = angle_ofs,
-                                      .angle_delta = angle_delta,
-                                      .angle_increment = angle_increment,
-                                      .arc_partial_angle = arc_partial_angle,
-                                      .arc_inner_factor = arc_inner_factor,
-                                      .clip_plane = clip_plane,
-                                  });
+  dial_3d_draw_util(gz->matrix_basis,
+                    matrix_final,
+                    gz->line_width,
+                    color,
+                    select,
+                    &(struct Dial3dParams){
+                        .draw_options = draw_options,
+                        .angle_ofs = angle_ofs,
+                        .angle_delta = angle_delta,
+                        .angle_increment = angle_increment,
+                        .arc_partial_angle = arc_partial_angle,
+                        .arc_inner_factor = arc_inner_factor,
+                        .clip_plane = clip_plane,
+                    });
 }
 
 static void gizmo_dial_draw_select(const bContext *C, wmGizmo *gz, int select_id)
@@ -479,6 +495,10 @@ static int gizmo_dial_modal(bContext *C,
                             eWM_GizmoFlagTweak tweak_flag)
 {
   DialInteraction *inter = gz->interaction_data;
+  if (!inter) {
+    return OPERATOR_CANCELLED;
+  }
+
   if ((event->type != MOUSEMOVE) && (inter->prev.tweak_flag == tweak_flag)) {
     return OPERATOR_RUNNING_MODAL;
   }
@@ -522,11 +542,13 @@ static void gizmo_dial_exit(bContext *C, wmGizmo *gz, const bool cancel)
   bool use_reset_value = false;
   float reset_value = 0.0f;
   if (cancel) {
-    /* Set the property for the operator and call its modal function. */
-    wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
-    if (WM_gizmo_target_property_is_valid(gz_prop)) {
-      use_reset_value = true;
-      reset_value = inter->init.prop_angle;
+    if (inter) {
+      /* Set the property for the operator and call its modal function. */
+      wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
+      if (WM_gizmo_target_property_is_valid(gz_prop)) {
+        use_reset_value = true;
+        reset_value = inter->init.prop_angle;
+      }
     }
   }
   else {
@@ -564,6 +586,11 @@ static void gizmo_dial_setup(wmGizmo *gz)
 
 static int gizmo_dial_invoke(bContext *UNUSED(C), wmGizmo *gz, const wmEvent *event)
 {
+  if (gz->custom_modal) {
+    /* #DialInteraction is only used for the inner modal. */
+    return OPERATOR_RUNNING_MODAL;
+  }
+
   DialInteraction *inter = MEM_callocN(sizeof(DialInteraction), __func__);
 
   inter->init.mval[0] = event->mval[0];
@@ -583,12 +610,12 @@ static int gizmo_dial_invoke(bContext *UNUSED(C), wmGizmo *gz, const wmEvent *ev
 /** \name Dial Gizmo API
  * \{ */
 
-void ED_gizmotypes_dial_3d_draw_util(const float matrix_basis[4][4],
-                                     const float matrix_final[4][4],
-                                     const float line_width,
-                                     const float color[4],
-                                     const bool select,
-                                     struct Dial3dParams *params)
+static void dial_3d_draw_util(const float matrix_basis[4][4],
+                              const float matrix_final[4][4],
+                              const float line_width,
+                              const float color[4],
+                              const bool select,
+                              struct Dial3dParams *params)
 {
   GPU_matrix_push();
   GPU_matrix_mul(matrix_final);
diff --git a/source/blender/editors/include/ED_gizmo_library.h b/source/blender/editors/include/ED_gizmo_library.h
index f8df4ba2a0c..31c1f93f5bc 100644
--- a/source/blender/editors/include/ED_gizmo_library.h
+++ b/source/blender/editors/include/ED_gizmo_library.h
@@ -225,24 +225,6 @@ enum {
 /* -------------------------------------------------------------------- */
 /* Specific gizmos utils */
 
-/* dial3d_gizmo.c */
-
-struct Dial3dParams {
-  int draw_options;
-  float angle_ofs;
-  float angle_delta;
-  float angle_increment;
-  float arc_partial_angle;
-  float arc_inner_factor;
-  float *clip_plane;
-};
-void ED_gizmotypes_dial_3d_draw_util(const float matrix_basis[4][4],
-                                     const float matrix_final[4][4],
-                                     float line_width,
-                                     const float color[4],
-                                     bool select,
-                                     struct Dial3dParams *params);
-
 /* snap3d_gizmo.c */
 
 struct SnapObjectContext *ED_gizmotypes_snap_3d_context_ensure(struct Scene *scene,
diff --git a/source/blender/editors/transform/transform.c b/source/blender/editors/transform/transform.c
index 8e0ea82bb32..960d9a25ca7 100644
--- a/source/blender/editors/transform/transform.c
+++ b/source/blender/editors/transform/transform.c
@@ -1425,9 +1425,6 @@ static void drawTransformView(const struct bContext *C, ARegion *region, void *a
     /* edge slide, vert slide */
     drawEdgeSlide(t);
     drawVertSlide(t);
-
-    /* Rotation */
-    drawDial3d(t);
   }
 }
 
diff --git a/source/blender/editors/transform/transform.h b/source/blender/editors/transform/transform.h
index e5ce1842a8e..a35942aedec 100644
--- a/source/blender/editors/transform/transform.h
+++ b/source/blender/editors/transform/transform.h
@@ -743,7 +743,6 @@ void transform_final_value_get(const TransInfo *t, float *value, int value_num);
 
 bool gimbal_axis_pose(struct Object *ob, const struct bPoseChannel *pchan, float gmat[3][3]);
 bool gimbal_axis_object(struct Object *ob, float gmat[3][3]);
-void drawDial3d(const TransInfo *t);
 
 /** \} */
 
diff --git a/source/blender/editors/transform/transform_gizmo_3d.c b/source/blender/editors/transform/transform_gizmo_3d.c
index 7b1666f0985..5b749e05052 100644
--- a/source/blender/editors/transform/transform_gizmo_3d.c
+++ b/source/blender/editors/transform/transform_gizmo_3d.c
@@ -45,7 +45,6 @@
 #include "WM_api.h"
 #include "WM_message.h"
 #include "WM_types.h"
-#include "wm.h"
 
 #include "ED_armature.h"
 #include "ED_gizmo_library.h"
@@ -159,6 +158,9 @@ typedef struct GizmoGroup {
     float viewinv_m3[3][3];
   } prev;
 
+  /* Only for Rotate operator. */
+  float rotation;
+
   struct wmGizmo *gizmos[MAN_AXIS_LAST];
 } GizmoGroup;
 
@@ -1273,103 +1275,31 @@ static void gizmo_xform_message_subscribe(wmGizmoGroup *gzgroup,
   WM_msg_subscribe_rna_anon_prop(mbus, EditBone, lock, &msg_sub_value_gz_tag_refresh);
 }
 
-void drawDial3d(const TransInfo *t)
+static void gizmo_3d_dial_matrixbasis_calc(const ARegion *region,
+                                           float axis[3],
+                                           float center_global[3],
+                                           float mval_init[2],
+                                           float r_mat_basis[4][4])
 {
-  if (t->mode == TFM_ROTATION && t->spacetype == SPACE_VIEW3D) {
-    if (t->options & CTX_PAINT_CURVE) {
-      /* Matrices are in the screen space. Not supported. */
-      return;
-    }
-
-    wmGizmo *gz = wm_gizmomap_modal_get(t->region->gizmo_map);
-    if (gz == NULL) {
-      /* We only draw Dial3d if the operator has been called by a gizmo. */
-      return;
-    }
-
-    float mat_basis[4][4];
-    float mat_final[4][4];
-    float color[4];
-    float increment = 0.0f;
-    float line_with = GIZMO_AXIS_LINE_WIDTH + 1.0f;
-    float scale = UI_DPI_FAC * U.gizmo_size;
-
-    int axis_idx;
-
-    const TransCon *tc = &(t->con);
-    if (tc->mode & CON_APPLY) {
-      if (tc->mode & CON_AXIS0) {
-        axis_idx = MAN_AXIS_ROT_X;
-        negate_v3_v3(mat_basis[2], t->spacemtx[0]);
-      }
-      else if (tc->mode & CON_AXIS1) {
-        axis_idx = MAN_AXIS_ROT_Y;
-        negate_v3_v3(mat_basis[2], t->spacemtx[1]);
-      }
-      else {
-        BLI_assert((tc->mode & CON_AXIS2) != 0);
-        axis_idx = MAN_AXIS_ROT_Z;
-        negate_v3_v3(mat_basis[2], t->spacemtx[2]);
-      }
-    }
-    else {
-      axis_idx = MAN_AXIS_ROT_C;
-      copy_v3_v3(mat_basis[2], t->spacemtx[t->orient_axis]);
-      scale *= 1.2f;
-      line_with -= 1.0f;
-    }
-
-    copy_v3_v3(mat_basis[3], t->center_global);
-    mat_basis[2][3] = -dot_v3v3(mat_basis[2], mat_basis[3]);
-
-    if (ED_view3d_win_to_3d_on_plane(
-            t->region, mat_basis[2], (float[2]){UNPACK2(t->mouse.imval)}, false, mat_basis[1])) {
-      sub_v3_v3(mat_basis[1], mat_basis[3]);
-      normalize_v3(mat_basis[1]);
-      cross_v3_v3v3(mat_basis[0], mat_basis[1], mat_basis[2]);
-    }
-    else {
-      /* The plane and the mouse direction are parallel.
-       * Calculate a matrix orthogonal to the axis. */
-      ortho_basis_v3v3_v3(mat_basis[0], mat_basis[1], mat_basis[2]);
-    }
-
-    mat_basis[0][3] = 0.0f;
-    mat_basis[1][3] = 0.0f;
-    mat_basis[2][3] = 0.0f;
-    mat_basis[3][3] = 1.0f;
-
-    copy_m4_m4(mat_final, mat_basis);
-    scale *= ED_view3d_pixel_size_no_ui_scale(t->region->regiondata, mat_final[3]);
-    mul_mat3_m4_fl(mat_final, scale);
-
-    if (activeSnap(t) && (!transformModeUseSnap(t) ||
-                          (t->tsnap.mode & (SCE_SNAP_MODE_INCREMENT | SCE_SNAP_MODE_GRID)))) {
-      increment = (t->modifiers & MOD_PRECISION) ? t->snap[1] : t->snap[0];
-    }
-
-    BLI_assert(axis_idx >= MAN_AXIS_RANGE_ROT_START && axis_idx < MAN_AXIS_RANGE_ROT_END);
-    gizmo_get_axis_color(axis_idx, NULL, color, color);
+  copy_v3_v3(r_mat_basis[2], axis);
+  copy_v3_v3(r_mat_basis[3], center_global);
+  r_mat_basis[2][3] = -dot_v3v3(axis, center_global);
 
-    GPU_depth_test(GPU_DEPTH_NONE);
-    GPU_blend(GPU_BLEND_ALPHA);
-    GPU_line_smooth(true);
-
-    ED_gizmotypes_dial_3d_draw_util(mat_basis,
-                                    mat_final,
-                                    line_with,
-                                    color,
-                                    false,
-                                    &(struct Dial3dParams){
-                                        .draw_options = ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE,
-                                        .angle_delta = t->values_final[0],
-                                        .angle_increment = increment,
-                                    });
-
-    GPU_line_smooth(false);
-    GPU_depth_test(GPU_DEPTH_LESS_EQUAL);
-    GPU_blend(GPU_BLEND_NONE);
+  if (ED_view3d_win_to_3d_on_plane(region, axis, mval_init, false, r_mat_basis[1])) {
+    sub_v3_v3(r_mat_basis[1], center_global);
+    normalize_v3(r_mat_basis[1]);
+    cross_v3_v3v3(r_mat_basis[0], r_mat_basis[1], r_mat_basis[2]);
+  }
+  else {
+    /* The plane and the mouse direction are parallel.
+     * Calculate a matrix orthogonal to the axis. */
+    ortho_basis_v3v3_v3(r_mat_basis[0], r_mat_basis[1], r_mat_basis[2]);
   }
+
+  r_mat_basis[0][3] = 0.0f;
+  r_mat_basis[1][3] = 0.0f;
+  r_mat_basis[2][3] = 0.0f;
+  r_mat_basis[3][3] = 1.0f;
 }
 
 /** \} */
@@ -1383,6 +1313,18 @@ void drawDial3d(const TransInfo *t)
 /** Offset of the two-axis planes, depends on the gizmos scale. Define to avoid repeating. */
 #define MAN_AXIS_SCALE_PLANE_OFFSET 7.0f
 
+static void rotation_get_fn(const wmGizmo *UNUSED(gz), wmGizmoProperty *gz_prop, void *value)
+{
+  const GizmoGroup *ggd = (const GizmoGroup *)gz_prop->custom_func.user_data;
+  *(float *)value = ggd->rotation;
+}
+
+static void rotation_set_fn(const wmGizmo *UNUSED(gz), wmGizmoProperty *gz_prop, const void *value)
+{
+  GizmoGroup *ggd = (GizmoGroup *)gz_prop->custom_func.user_data;
+  ggd->rotation = *(const float *)value;
+}
+
 static GizmoGroup *gizmogroup_init(wmGizmoGroup *gzgroup)
 {
   GizmoGroup *ggd;
@@ -1393,6 +1335,9 @@ static GizmoGroup *gizmogroup_init(wmGizmoGroup *gzgroup)
   const wmGizmoType *gzt_dial = WM_gizmotype_find("GIZMO_GT_dial_3d", true);
   const wmGizmoType *gzt_prim = WM_gizmotype_find("GIZMO_GT_primitive_3d", true);
 
+  wmGizmoPropertyFnParams params = {
+      .value_get_fn = rotation_get_fn, .value_set_fn = rotation_set_fn, .user_data = ggd};
+
 #define GIZMO_NEW_ARROW(v, draw_style) \
   { \
     ggd->gizmos[v] = WM_gizmo_new_ptr(gzt_arrow, gzgroup, NULL); \
@@ -1403,6 +1348,7 @@ static GizmoGroup *gizmogroup_init(wmGizmoGroup *gzgroup)
   { \
     ggd->gizmos[v] = WM_gizmo_new_ptr(gzt_dial, gzgroup, NULL); \
     RNA_enum_set(ggd->gizmos[v]->ptr, "draw_options", draw_options); \
+    WM_gizmo_target_property_def_func(ggd->gizmos[v], "offset", &params); \
   } \
   ((void)0)
 #define GIZMO_NEW_PRIM(v, draw_style) \
@@ -1550,6 +1496,14 @@ static int gizmo_modal(bContext *C,
         transform_final_value_get(op->customdata, scale, 3);
         update = true;
       }
+      else if (axis_type == MAN_AXES_ROTATE) {
+        transform_final_value_get(op->customdata, &ggd->rotation, 1);
+        if (widget != ggd->gizmos[MAN_AXIS_ROT_C]) {
+          ggd->rotation *= -1;
+        }
+        RNA_float_set(
+            widget->ptr, "incremental_angle", transform_snap_increment_get(op->customdata));
+      }
       else if (transform_apply_matrix(op->customdata, twmat)) {
         update = true;
       }
@@ -1789,8 +1743,18 @@ static void gizmo_refresh_from_matrix(wmGizmoGroup *gzgroup,
       case MAN_AXIS_ROT_X:
       case MAN_AXIS_ROT_Y:
       case MAN_AXIS_ROT_Z:
-        WM_gizmo_set_matrix_rotation_from_z_axis(axis, twmat[aidx_norm]);
-        break;
+      case MAN_AXIS_ROT_C: {
+        if (axis_idx != MAN_AXIS_ROT_C) {
+          WM_gizmo_set_matrix_rotation_from_z_axis(axis, twmat[aidx_norm]);
+        }
+
+        /* Remove #ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE. It is used only for modal drawing. */
+        PropertyRNA *prop = RNA_struct_find_property(axis->ptr, "draw_options");
+        RNA_property_enum_set(axis->ptr,
+                              prop,
+                              RNA_property_enum_get(axis->ptr, prop) &
+                                  ~ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE);
+      } break;
       case MAN_AXIS_TRANS_XY:
       case MAN_AXIS_TRANS_YZ:
       case MAN_AXIS_TRANS_ZX:
@@ -1894,11 +1858,11 @@ static void WIDGETGROUP_gizmo_draw_prepare(const bContext *C, wmGizmoGroup *gzgr
   float idot[3];
 
   /* Re-calculate hidden unless modal. */
-  bool calc_hidden = true;
+  bool is_modal = false;
   {
     wmGizmo *gz = WM_gizmomap_get_modal(region->gizmo_map);
     if (gz && gz->parent_gzgroup == gzgroup) {
-      calc_hidden = false;
+      is_modal = true;
     }
   }
 
@@ -1906,7 +1870,7 @@ static void WIDGETGROUP_gizmo_draw_prepare(const bContext *C, wmGizmoGroup *gzgr
    * exact same position as the view, skip so we don't break selection */
   if (ggd->all_hidden || fabsf(ED_view3d_pixel_size(rv3d, rv3d->twmat[3])) < 5e-7f) {
     MAN_ITER_AXES_BEGIN (axis, axis_idx) {
-      if (calc_hidden) {
+      if (!is_modal) {
         WM_gizmo_set_flag(axis, WM_GIZMO_HIDDEN, true);
       }
     }
@@ -1920,12 +1884,12 @@ static void WIDGETGROUP_gizmo_draw_prepare(const bContext *C, wmGizmoGroup *gzgr
     const short axis_type = gizmo_get_axis_type(axis_idx);
     /* XXX maybe unset _HIDDEN flag on redraw? */
     if (gizmo_is_axis_visible(rv3d, ggd->twtype, idot, axis_type, axis_idx)) {
-      if (calc_hidden) {
+      if (!is_modal) {
         WM_gizmo_set_flag(axis, WM_GIZMO_HIDDEN, false);
       }
     }
     else {
-      if (calc_hidden) {
+      if (!is_modal) {
         WM_gizmo_set_flag(axis, WM_GIZMO_HIDDEN, true);
       }
       continue;
@@ -1936,13 +1900,15 @@ static void WIDGETGROUP_gizmo_draw_prepare(const bContext *C, wmGizmoGroup *gzgr
     WM_gizmo_set_color(axis, color);
     WM_gizmo_set_color_highlight(axis, color_hi);
 
-    switch (axis_idx) {
-      case MAN_AXIS_TRANS_C:
-      case MAN_AXIS_ROT_C:
-      case MAN_AXIS_SCALE_C:
-      case MAN_AXIS_ROT_T:
-        WM_gizmo_set_matrix_rotation_from_z_axis(axis, rv3d->viewinv[2]);
-        break;
+    if (!is_modal) {
+      switch (axis_idx) {
+        case MAN_AXIS_TRANS_C:
+        case MAN_AXIS_ROT_C:
+        case MAN_AXIS_SCALE_C:
+        case MAN_AXIS_ROT_T:
+          WM_gizmo_set_matrix_rotation_from_z_axis(axis, rv3d->viewinv[2]);
+          break;
+      }
     }
   }
   MAN_ITER_AXES_END;
@@ -2030,6 +1996,17 @@ static void WIDGETGROUP_gizmo_invoke_prepare(const bContext *C,
       }
     }
   }
+  else if (ELEM(axis_idx, MAN_AXIS_ROT_X, MAN_AXIS_ROT_Y, MAN_AXIS_ROT_Z, MAN_AXIS_ROT_C)) {
+    gizmo_3d_dial_matrixbasis_calc(CTX_wm_region(C),
+                                   gz->matrix_basis[2],
+                                   gz->matrix_basis[3],
+                                   (float[2]){UNPACK2(event->mval)},
+                                   gz->matrix_basis);
+    PropertyRNA *prop = RNA_struct_find_property(gz->ptr, "draw_options");
+    RNA_property_enum_set(
+        gz->ptr, prop, RNA_property_enum_get(gz->ptr, prop) | ED_GIZMO_DIAL_DRAW_FLAG_ANGLE_VALUE);
+    RNA_float_set(gz->ptr, "incremental_angle", 0.0f);
+  }
 }
 
 static bool WIDGETGROUP_gizmo_poll_generic(View3D *v3d)
diff --git a/source/blender/editors/transform/transform_snap.c b/source/blender/editors/transform/transform_snap.c
index 400c351a5d5..62afc6ea1b5 100644
--- a/source/blender/editors/transform/transform_snap.c
+++ b/source/blender/editors/transform/transform_snap.c
@@ -1682,6 +1682,16 @@ bool transform_snap_increment(const TransInfo *t, float *r_val)
   return transform_snap_increment_ex(t, false, r_val);
 }
 
+float transform_snap_increment_get(const TransInfo *t)
+{
+  if (activeSnap(t) && (!transformModeUseSnap(t) ||
+                        (t->tsnap.mode & (SCE_SNAP_MODE_INCREMENT | SCE_SNAP_MODE_GRID)))) {
+    return (t->modifiers & MOD_PRECISION) ? t->snap[1] : t->snap[0];
+  }
+
+  return 0.0f;
+}
+
 /** \} */
 
 /* -------------------------------------------------------------------- */
diff --git a/source/blender/editors/transform/transform_snap.h b/source/blender/editors/transform/transform_snap.h
index 031584c7fbc..6db027df067 100644
--- a/source/blender/editors/transform/transform_snap.h
+++ b/source/blender/editors/transform/transform_snap.h
@@ -36,6 +36,7 @@ bool transformModeUseSnap(const TransInfo *t);
 
 bool transform_snap_increment_ex(const TransInfo *t, bool use_local_space, float *r_val);
 bool transform_snap_increment(const TransInfo *t, float *val);
+float transform_snap_increment_get(const TransInfo *t);
 bool transform_snap_grid(TransInfo *t, float *val);
 
 bool activeSnap(const TransInfo *t);