move3d_gizmo.cc

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#include "MEM_guardedalloc.h"
 
#include "BLI_math_matrix.h"
#include "BLI_math_vector_types.hh"
 
#include "BKE_context.hh"
 
#include "GPU_immediate.hh"
#include "GPU_immediate_util.hh"
#include "GPU_matrix.hh"
#include "GPU_select.hh"
#include "GPU_state.hh"
 
#include "RNA_access.hh"
#include "RNA_define.hh"
 
#include "WM_api.hh"
#include "WM_types.hh"
 
#include "ED_gizmo_library.hh"
#include "ED_screen.hh"
#include "ED_transform_snap_object_context.hh"
#include "ED_view3d.hh"
 
/* own includes */
#include "../gizmo_library_intern.hh"
 
#define MVAL_MAX_PX_DIST 12.0f
#define RING_2D_RESOLUTION 32
 
struct MoveGizmo3D {
  wmGizmo gizmo;
  /* Added to 'matrix_basis' when calculating the matrix. */
  float prop_co[3];
};
 
static void gizmo_move_matrix_basis_get(const wmGizmo *gz, float r_matrix[4][4])
{
  MoveGizmo3D *move = (MoveGizmo3D *)gz;
 
  copy_m4_m4(r_matrix, move->gizmo.matrix_basis);
  add_v3_v3(r_matrix[3], move->prop_co);
}
 
static int gizmo_move_modal(bContext *C,
                            wmGizmo *gz,
                            const wmEvent *event,
                            eWM_GizmoFlagTweak tweak_flag);
 
struct MoveInteraction {
  struct {
    float mval[2];
    /* Only for when using properties. */
    float prop_co[3];
    float matrix_final[4][4];
  } init;
  struct {
    eWM_GizmoFlagTweak tweak_flag;
  } prev;
 
  /* We could have other snap contexts, for now only support 3D view. */
  SnapObjectContext *snap_context_v3d;
};
 
/* -------------------------------------------------------------------- */
 
static void move_geom_draw(const wmGizmo *gz,
                           const float color[4],
                           const bool select,
                           const int draw_options)
{
#ifdef USE_GIZMO_CUSTOM_DIAL
  UNUSED_VARS(move3d, col, axis_modal_mat);
  wm_gizmo_geometryinfo_draw(&wm_gizmo_geom_data_move3d, select);
#else
  const int draw_style = RNA_enum_get(gz->ptr, "draw_style");
  const bool filled = (draw_style != ED_GIZMO_MOVE_STYLE_CROSS_2D) &&
                      (draw_options & (select ? (ED_GIZMO_MOVE_DRAW_FLAG_FILL |
                                                 ED_GIZMO_MOVE_DRAW_FLAG_FILL_SELECT) :
                                                ED_GIZMO_MOVE_DRAW_FLAG_FILL));
 
  GPUVertFormat *format = immVertexFormat();
  /* NOTE(Metal): Prefer using 3D coordinates with 3D shader, even if rendering 2D gizmo's. */
  uint pos = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
 
  immBindBuiltinProgram(filled ? GPU_SHADER_3D_UNIFORM_COLOR :
                                 GPU_SHADER_3D_POLYLINE_UNIFORM_COLOR);
 
  float viewport[4];
  GPU_viewport_size_get_f(viewport);
  immUniform2fv("viewportSize", &viewport[2]);
  immUniform1f("lineWidth", gz->line_width * U.pixelsize);
 
  immUniformColor4fv(color);
 
  /* Use the final scale as a radius if it's not already applied to the final matrix. */
  const float radius = (gz->flag & WM_GIZMO_DRAW_NO_SCALE) ? gz->scale_final : 1.0f;
 
  if (draw_style == ED_GIZMO_MOVE_STYLE_RING_2D) {
    if (filled) {
      imm_draw_circle_fill_3d(pos, 0.0f, 0.0f, radius, RING_2D_RESOLUTION);
    }
    else {
      imm_draw_circle_wire_3d(pos, 0.0f, 0.0f, radius, RING_2D_RESOLUTION);
    }
  }
  else if (draw_style == ED_GIZMO_MOVE_STYLE_CROSS_2D) {
    const float radius_diag = M_SQRT1_2 * radius;
    immBegin(GPU_PRIM_LINES, 4);
    immVertex3f(pos, radius_diag, radius_diag, 0.0f);
    immVertex3f(pos, -radius_diag, -radius_diag, 0.0f);
 
    immVertex3f(pos, -radius_diag, radius_diag, 0.0f);
    immVertex3f(pos, radius_diag, -radius_diag, 0.0f);
    immEnd();
  }
  else {
    BLI_assert(0);
  }
 
  immUnbindProgram();
 
  UNUSED_VARS(select);
#endif
}
 
static void move3d_get_translate(const wmGizmo *gz,
                                 const wmEvent *event,
                                 const ARegion *region,
                                 float co_delta[3])
{
  MoveInteraction *inter = static_cast<MoveInteraction *>(gz->interaction_data);
  const float xy_delta[2] = {
      event->mval[0] - inter->init.mval[0],
      event->mval[1] - inter->init.mval[1],
  };
 
  RegionView3D *rv3d = static_cast<RegionView3D *>(region->regiondata);
  float co_ref[3];
  mul_v3_mat3_m4v3(co_ref, gz->matrix_space, inter->init.prop_co);
  const float zfac = ED_view3d_calc_zfac(rv3d, co_ref);
 
  ED_view3d_win_to_delta(region, xy_delta, zfac, co_delta);
 
  float matrix_space_inv[3][3];
  copy_m3_m4(matrix_space_inv, gz->matrix_space);
  invert_m3(matrix_space_inv);
  mul_m3_v3(matrix_space_inv, co_delta);
}
 
static void move3d_draw_intern(const bContext *C,
                               wmGizmo *gz,
                               const bool select,
                               const bool highlight)
{
  MoveInteraction *inter = static_cast<MoveInteraction *>(gz->interaction_data);
  const int draw_options = RNA_enum_get(gz->ptr, "draw_options");
  const bool align_view = (draw_options & ED_GIZMO_MOVE_DRAW_FLAG_ALIGN_VIEW) != 0;
  float color[4];
  float matrix_final[4][4];
  float matrix_align[4][4];
 
  gizmo_color_get(gz, highlight, color);
  WM_gizmo_calc_matrix_final(gz, matrix_final);
 
  GPU_matrix_push();
  GPU_matrix_mul(matrix_final);
 
  if (align_view) {
    float matrix_final_unit[4][4];
    RegionView3D *rv3d = CTX_wm_region_view3d(C);
    normalize_m4_m4(matrix_final_unit, matrix_final);
    mul_m4_m4m4(matrix_align, rv3d->viewmat, matrix_final_unit);
    zero_v3(matrix_align[3]);
    transpose_m4(matrix_align);
    GPU_matrix_mul(matrix_align);
  }
 
  GPU_blend(GPU_BLEND_ALPHA);
  move_geom_draw(gz, color, select, draw_options);
  GPU_blend(GPU_BLEND_NONE);
  GPU_matrix_pop();
 
  if (gz->interaction_data) {
    GPU_matrix_push();
    GPU_matrix_mul(inter->init.matrix_final);
 
    if (align_view) {
      GPU_matrix_mul(matrix_align);
    }
 
    GPU_blend(GPU_BLEND_ALPHA);
    move_geom_draw(gz, blender::float4(0.5f, 0.5f, 0.5f, 0.5f), select, draw_options);
    GPU_blend(GPU_BLEND_NONE);
    GPU_matrix_pop();
  }
}
 
static void gizmo_move_draw_select(const bContext *C, wmGizmo *gz, int select_id)
{
  GPU_select_load_id(select_id);
  move3d_draw_intern(C, gz, true, false);
}
 
static void gizmo_move_draw(const bContext *C, wmGizmo *gz)
{
  const bool is_modal = gz->state & WM_GIZMO_STATE_MODAL;
  const bool is_highlight = (gz->state & WM_GIZMO_STATE_HIGHLIGHT) != 0;
 
  (void)is_modal;
 
  GPU_blend(GPU_BLEND_ALPHA);
  move3d_draw_intern(C, gz, false, is_highlight);
  GPU_blend(GPU_BLEND_NONE);
}
 
static int gizmo_move_modal(bContext *C,
                            wmGizmo *gz,
                            const wmEvent *event,
                            eWM_GizmoFlagTweak tweak_flag)
{
  MoveInteraction *inter = static_cast<MoveInteraction *>(gz->interaction_data);
  if ((event->type != MOUSEMOVE) && (inter->prev.tweak_flag == tweak_flag)) {
    return OPERATOR_RUNNING_MODAL;
  }
  MoveGizmo3D *move = (MoveGizmo3D *)gz;
  ARegion *region = CTX_wm_region(C);
 
  float prop_delta[3];
  if (CTX_wm_area(C)->spacetype == SPACE_VIEW3D) {
    move3d_get_translate(gz, event, region, prop_delta);
  }
  else {
    float mval_proj_init[2], mval_proj_curr[2];
    if ((gizmo_window_project_2d(C, gz, inter->init.mval, 2, false, mval_proj_init) == false) ||
        (gizmo_window_project_2d(
             C, gz, blender::float2(blender::int2(event->mval)), 2, false, mval_proj_curr) ==
         false))
    {
      return OPERATOR_RUNNING_MODAL;
    }
    sub_v2_v2v2(prop_delta, mval_proj_curr, mval_proj_init);
    if ((gz->flag & WM_GIZMO_DRAW_NO_SCALE) == 0) {
      mul_v2_fl(prop_delta, gz->scale_final);
    }
    prop_delta[2] = 0.0f;
  }
 
  if (tweak_flag & WM_GIZMO_TWEAK_PRECISE) {
    mul_v3_fl(prop_delta, 0.1f);
  }
 
  add_v3_v3v3(move->prop_co, inter->init.prop_co, prop_delta);
 
  if (tweak_flag & WM_GIZMO_TWEAK_SNAP) {
    if (inter->snap_context_v3d) {
      float dist_px = MVAL_MAX_PX_DIST * U.pixelsize;
      const float mval_fl[2] = {float(event->mval[0]), float(event->mval[1])};
      float co[3];
      SnapObjectParams params{};
      params.snap_target_select = SCE_SNAP_TARGET_ALL;
      params.edit_mode_type = SNAP_GEOM_EDIT;
      params.occlusion_test = SNAP_OCCLUSION_AS_SEEM;
      if (ED_transform_snap_object_project_view3d(
              inter->snap_context_v3d,
              CTX_data_ensure_evaluated_depsgraph(C),
              region,
              CTX_wm_view3d(C),
              (SCE_SNAP_TO_VERTEX | SCE_SNAP_TO_EDGE | SCE_SNAP_TO_FACE),
              &params,
              nullptr,
              mval_fl,
              nullptr,
              &dist_px,
              co,
              nullptr))
      {
        float matrix_space_inv[4][4];
        invert_m4_m4(matrix_space_inv, gz->matrix_space);
        mul_v3_m4v3(move->prop_co, matrix_space_inv, co);
      }
    }
  }
 
  /* 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)) {
    WM_gizmo_target_property_float_set_array(C, gz, gz_prop, move->prop_co);
  }
  else {
    zero_v3(move->prop_co);
  }
 
  ED_region_tag_redraw_editor_overlays(region);
 
  inter->prev.tweak_flag = tweak_flag;
 
  return OPERATOR_RUNNING_MODAL;
}
 
static void gizmo_move_exit(bContext *C, wmGizmo *gz, const bool cancel)
{
  MoveInteraction *inter = static_cast<MoveInteraction *>(gz->interaction_data);
  bool use_reset_value = false;
  const float *reset_value = nullptr;
  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_co;
    }
  }
 
  if (use_reset_value) {
    wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
    if (WM_gizmo_target_property_is_valid(gz_prop)) {
      WM_gizmo_target_property_float_set_array(C, gz, gz_prop, reset_value);
    }
  }
 
  if (inter->snap_context_v3d) {
    ED_transform_snap_object_context_destroy(inter->snap_context_v3d);
    inter->snap_context_v3d = nullptr;
  }
 
  if (!cancel) {
    wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
    if (WM_gizmo_target_property_is_valid(gz_prop)) {
      WM_gizmo_target_property_anim_autokey(C, gz, gz_prop);
    }
  }
}
 
static int gizmo_move_invoke(bContext *C, wmGizmo *gz, const wmEvent *event)
{
  const bool use_snap = RNA_boolean_get(gz->ptr, "use_snap");
 
  MoveInteraction *inter = static_cast<MoveInteraction *>(
      MEM_callocN(sizeof(MoveInteraction), __func__));
  inter->init.mval[0] = event->mval[0];
  inter->init.mval[1] = event->mval[1];
 
#if 0
  copy_v3_v3(inter->init.prop_co, move->prop_co);
#else
  wmGizmoProperty *gz_prop = WM_gizmo_target_property_find(gz, "offset");
  if (WM_gizmo_target_property_is_valid(gz_prop)) {
    WM_gizmo_target_property_float_get_array(gz, gz_prop, inter->init.prop_co);
  }
#endif
 
  WM_gizmo_calc_matrix_final(gz, inter->init.matrix_final);
 
  if (use_snap) {
    ScrArea *area = CTX_wm_area(C);
    if (area) {
      switch (area->spacetype) {
        case SPACE_VIEW3D: {
          inter->snap_context_v3d = ED_transform_snap_object_context_create(CTX_data_scene(C), 0);
          break;
        }
        default:
          /* Not yet supported. */
          BLI_assert(0);
      }
    }
  }
 
  gz->interaction_data = inter;
 
  return OPERATOR_RUNNING_MODAL;
}
 
static int gizmo_move_test_select(bContext *C, wmGizmo *gz, const int mval[2])
{
  float point_local[2];
 
  if (gizmo_window_project_2d(C, gz, blender::float2(blender::int2(mval)), 2, true, point_local) ==
      false)
  {
    return -1;
  }
 
  /* The 'gz->scale_final' is already applied to the projection
   * when #WM_GIZMO_DRAW_NO_SCALE isn't set. */
  const float radius = (gz->flag & WM_GIZMO_DRAW_NO_SCALE) ? gz->scale_final : 1.0f;
  if (len_squared_v2(point_local) < radius) {
    return 0;
  }
 
  return -1;
}
 
static void gizmo_move_property_update(wmGizmo *gz, wmGizmoProperty *gz_prop)
{
  MoveGizmo3D *move = (MoveGizmo3D *)gz;
  if (WM_gizmo_target_property_is_valid(gz_prop)) {
    WM_gizmo_target_property_float_get_array(gz, gz_prop, move->prop_co);
  }
  else {
    zero_v3(move->prop_co);
  }
}
 
static int gizmo_move_cursor_get(wmGizmo * /*gz*/)
{
  return WM_CURSOR_NSEW_SCROLL;
}
 
/* -------------------------------------------------------------------- */
 
static void GIZMO_GT_move_3d(wmGizmoType *gzt)
{
  /* identifiers */
  gzt->idname = "GIZMO_GT_move_3d";
 
  /* api callbacks */
  gzt->draw = gizmo_move_draw;
  gzt->draw_select = gizmo_move_draw_select;
  gzt->test_select = gizmo_move_test_select;
  gzt->matrix_basis_get = gizmo_move_matrix_basis_get;
  gzt->invoke = gizmo_move_invoke;
  gzt->property_update = gizmo_move_property_update;
  gzt->modal = gizmo_move_modal;
  gzt->exit = gizmo_move_exit;
  gzt->cursor_get = gizmo_move_cursor_get;
 
  gzt->struct_size = sizeof(MoveGizmo3D);
 
  /* rna */
  static const EnumPropertyItem rna_enum_draw_style[] = {
      {ED_GIZMO_MOVE_STYLE_RING_2D, "RING_2D", 0, "Ring", ""},
      {ED_GIZMO_MOVE_STYLE_CROSS_2D, "CROSS_2D", 0, "Ring", ""},
      {0, nullptr, 0, nullptr, nullptr},
  };
  static const EnumPropertyItem rna_enum_draw_options[] = {
      {ED_GIZMO_MOVE_DRAW_FLAG_FILL, "FILL", 0, "Filled", ""},
      {ED_GIZMO_MOVE_DRAW_FLAG_FILL_SELECT, "FILL_SELECT", 0, "Use fill for selection test", ""},
      {ED_GIZMO_MOVE_DRAW_FLAG_ALIGN_VIEW, "ALIGN_VIEW", 0, "Align View", ""},
      {0, nullptr, 0, nullptr, nullptr},
  };
 
  RNA_def_enum(
      gzt->srna, "draw_style", rna_enum_draw_style, ED_GIZMO_MOVE_STYLE_RING_2D, "Draw Style", "");
  RNA_def_enum_flag(gzt->srna, "draw_options", rna_enum_draw_options, 0, "Draw Options", "");
  RNA_def_boolean(gzt->srna, "use_snap", false, "Use Snap", "");
 
  WM_gizmotype_target_property_def(gzt, "offset", PROP_FLOAT, 3);
}
 
void ED_gizmotypes_move_3d()
{
  WM_gizmotype_append(GIZMO_GT_move_3d);
}
 /* Move Gizmo API */