Assets: Snapping with visual feedback while dragging

The drag and drop feature of objects in 3D View has been modified to include:
- Snap the object being dragged.
- Visual feedback through a box and the placement tool grid.

Maniphest Tasks: T90198

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

10 files changed, 168 insertions, 39 deletions

diff --git a/source/blender/editors/asset/ED_asset_mark_clear.h b/source/blender/editors/asset/ED_asset_mark_clear.h
index bab1d1bf8a5..8e6a8e11d69 100644
--- a/source/blender/editors/asset/ED_asset_mark_clear.h
+++ b/source/blender/editors/asset/ED_asset_mark_clear.h
@@ -26,6 +26,7 @@ extern "C" {
 
 struct ID;
 struct bContext;
+struct Main;
 
 /**
  * Mark the datablock as asset.
@@ -52,6 +53,8 @@ void ED_asset_generate_preview(const struct bContext *C, struct ID *id);
  * \return whether the asset metadata was actually removed; false when the ID was not an asset. */
 bool ED_asset_clear_id(struct ID *id);
 
+void ED_assets_pre_save(struct Main *bmain);
+
 bool ED_asset_can_mark_single_from_context(const struct bContext *C);
 
 #ifdef __cplusplus
diff --git a/source/blender/editors/asset/intern/asset_mark_clear.cc b/source/blender/editors/asset/intern/asset_mark_clear.cc
index 4be7376a1c3..eb254dcd28b 100644
--- a/source/blender/editors/asset/intern/asset_mark_clear.cc
+++ b/source/blender/editors/asset/intern/asset_mark_clear.cc
@@ -25,7 +25,9 @@
 
 #include "BKE_asset.h"
 #include "BKE_context.h"
+#include "BKE_idtype.h"
 #include "BKE_lib_id.h"
+#include "BKE_main.h"
 
 #include "BLO_readfile.h"
 
@@ -52,7 +54,9 @@ bool ED_asset_mark_id(ID *id)
 
   id_fake_user_set(id);
 
+  const IDTypeInfo *id_type_info = BKE_idtype_get_info_from_id(id);
   id->asset_data = BKE_asset_metadata_create();
+  id->asset_data->local_type_info = id_type_info->asset_type_info;
 
   /* Important for asset storage to update properly! */
   ED_assetlist_storage_tag_main_data_dirty();
@@ -79,6 +83,21 @@ bool ED_asset_clear_id(ID *id)
   return true;
 }
 
+void ED_assets_pre_save(struct Main *bmain)
+{
+  ID *id;
+  FOREACH_MAIN_ID_BEGIN (bmain, id) {
+    if (!id->asset_data || !id->asset_data->local_type_info) {
+      continue;
+    }
+
+    if (id->asset_data->local_type_info->pre_save_fn) {
+      id->asset_data->local_type_info->pre_save_fn(id, id->asset_data);
+    }
+  }
+  FOREACH_MAIN_ID_END;
+}
+
 bool ED_asset_can_mark_single_from_context(const bContext *C)
 {
   /* Context needs a "id" pointer to be set for #ASSET_OT_mark()/#ASSET_OT_clear() to use. */
diff --git a/source/blender/editors/include/ED_view3d.h b/source/blender/editors/include/ED_view3d.h
index 67c470a005f..a0c733b2ebf 100644
--- a/source/blender/editors/include/ED_view3d.h
+++ b/source/blender/editors/include/ED_view3d.h
@@ -276,12 +276,15 @@ typedef struct V3DSnapCursorState {
   eV3DPlaceOrient plane_orient;
   uchar color_line[4];
   uchar color_point[4];
+  uchar color_box[4];
   float *prevpoint;
+  float box_dimensions[3];
   short snap_elem_force; /* If zero, use scene settings. */
   short plane_axis;
   bool use_plane_axis_auto;
   bool draw_point;
   bool draw_plane;
+  bool draw_box;
 } V3DSnapCursorState;
 
 void ED_view3d_cursor_snap_state_default_set(V3DSnapCursorState *state);
@@ -293,7 +296,6 @@ V3DSnapCursorData *ED_view3d_cursor_snap_data_get(V3DSnapCursorState *state,
                                                   const struct bContext *C,
                                                   const int x,
                                                   const int y);
-
 struct SnapObjectContext *ED_view3d_cursor_snap_context_ensure(struct Scene *scene);
 void ED_view3d_cursor_snap_draw_util(struct RegionView3D *rv3d,
                                      const float loc_prev[3],
diff --git a/source/blender/editors/include/UI_interface.h b/source/blender/editors/include/UI_interface.h
index 4cd921bc61e..1ac20a5d070 100644
--- a/source/blender/editors/include/UI_interface.h
+++ b/source/blender/editors/include/UI_interface.h
@@ -37,6 +37,7 @@ extern "C" {
 struct ARegion;
 struct AssetFilterSettings;
 struct AssetHandle;
+struct AssetMetaData;
 struct AutoComplete;
 struct EnumPropertyItem;
 struct FileDirEntry;
@@ -785,6 +786,7 @@ void UI_but_drag_set_id(uiBut *but, struct ID *id);
 void UI_but_drag_set_asset(uiBut *but,
                            const struct AssetHandle *asset,
                            const char *path,
+                           struct AssetMetaData *metadata,
                            int import_type, /* eFileAssetImportType */
                            int icon,
                            struct ImBuf *imb,
diff --git a/source/blender/editors/interface/interface.c b/source/blender/editors/interface/interface.c
index 5068969946a..62c84ed38ff 100644
--- a/source/blender/editors/interface/interface.c
+++ b/source/blender/editors/interface/interface.c
@@ -6231,12 +6231,13 @@ void UI_but_drag_set_id(uiBut *but, ID *id)
 void UI_but_drag_set_asset(uiBut *but,
                            const AssetHandle *asset,
                            const char *path,
+                           struct AssetMetaData *metadata,
                            int import_type,
                            int icon,
                            struct ImBuf *imb,
                            float scale)
 {
-  wmDragAsset *asset_drag = WM_drag_create_asset_data(asset, path, import_type);
+  wmDragAsset *asset_drag = WM_drag_create_asset_data(asset, metadata, path, import_type);
 
   /* FIXME: This is temporary evil solution to get scene/viewlayer/etc in the copy callback of the
    * #wmDropBox.
diff --git a/source/blender/editors/interface/interface_template_asset_view.cc b/source/blender/editors/interface/interface_template_asset_view.cc
index f27b37a27de..d3ce7ebc3db 100644
--- a/source/blender/editors/interface/interface_template_asset_view.cc
+++ b/source/blender/editors/interface/interface_template_asset_view.cc
@@ -70,6 +70,7 @@ static void asset_view_item_but_drag_set(uiBut *but,
     UI_but_drag_set_asset(but,
                           asset_handle,
                           BLI_strdup(blend_path),
+                          ED_asset_handle_get_metadata(asset_handle),
                           FILE_ASSET_IMPORT_APPEND,
                           ED_asset_handle_get_preview_icon_id(asset_handle),
                           imbuf,
diff --git a/source/blender/editors/object/object_add.c b/source/blender/editors/object/object_add.c
index 114f540b614..629f40e0ae9 100644
--- a/source/blender/editors/object/object_add.c
+++ b/source/blender/editors/object/object_add.c
@@ -3533,12 +3533,6 @@ static int object_add_named_exec(bContext *C, wmOperator *op)
 
   basen->object->visibility_flag &= ~OB_HIDE_VIEWPORT;
 
-  int mval[2];
-  if (object_add_drop_xy_get(C, op, &mval)) {
-    ED_object_location_from_view(C, basen->object->loc);
-    ED_view3d_cursor3d_position(C, mval, false, basen->object->loc);
-  }
-
   /* object_add_duplicate_internal() doesn't deselect other objects, unlike object_add_common() or
    * BKE_view_layer_base_deselect_all(). */
   ED_object_base_deselect_all(view_layer, NULL, SEL_DESELECT);
@@ -3556,13 +3550,29 @@ static int object_add_named_exec(bContext *C, wmOperator *op)
   WM_event_add_notifier(C, NC_SCENE | ND_LAYER_CONTENT, scene);
   ED_outliner_select_sync_from_object_tag(C);
 
+  PropertyRNA *prop_matrix = RNA_struct_find_property(op->ptr, "matrix");
+  if (RNA_property_is_set(op->ptr, prop_matrix)) {
+    Object *ob_add = basen->object;
+    RNA_property_float_get_array(op->ptr, prop_matrix, &ob_add->obmat[0][0]);
+    BKE_object_apply_mat4(ob_add, ob_add->obmat, true, true);
+
+    DEG_id_tag_update(&ob_add->id, ID_RECALC_TRANSFORM);
+  }
+  else {
+    int mval[2];
+    if (object_add_drop_xy_get(C, op, &mval)) {
+      ED_object_location_from_view(C, basen->object->loc);
+      ED_view3d_cursor3d_position(C, mval, false, basen->object->loc);
+    }
+  }
+
   return OPERATOR_FINISHED;
 }
 
 void OBJECT_OT_add_named(wmOperatorType *ot)
 {
   /* identifiers */
-  ot->name = "Add Named Object";
+  ot->name = "Add Object";
   ot->description = "Add named object";
   ot->idname = "OBJECT_OT_add_named";
 
@@ -3594,6 +3604,10 @@ void OBJECT_OT_add_named(wmOperatorType *ot)
 
   RNA_def_string(ot->srna, "name", NULL, MAX_ID_NAME - 2, "Name", "Object name to add");
 
+  prop = RNA_def_float_matrix(
+      ot->srna, "matrix", 4, 4, NULL, 0.0f, 0.0f, "Matrix", "", 0.0f, 0.0f);
+  RNA_def_property_flag(prop, PROP_HIDDEN | PROP_SKIP_SAVE);
+
   object_add_drop_xy_props(ot);
 }
 
diff --git a/source/blender/editors/space_file/file_draw.c b/source/blender/editors/space_file/file_draw.c
index 24b24eb81dd..5c6b753d4a5 100644
--- a/source/blender/editors/space_file/file_draw.c
+++ b/source/blender/editors/space_file/file_draw.c
@@ -190,6 +190,7 @@ static void file_draw_icon(const SpaceFile *sfile,
         UI_but_drag_set_asset(but,
                               &(AssetHandle){.file_data = file},
                               BLI_strdup(blend_path),
+                              file->asset_data,
                               asset_params->import_type,
                               icon,
                               preview_image,
@@ -515,6 +516,7 @@ static void file_draw_preview(const SpaceFile *sfile,
         UI_but_drag_set_asset(but,
                               &(AssetHandle){.file_data = file},
                               BLI_strdup(blend_path),
+                              file->asset_data,
                               asset_params->import_type,
                               icon,
                               imb,
diff --git a/source/blender/editors/space_view3d/space_view3d.c b/source/blender/editors/space_view3d/space_view3d.c
index eb30d0987ab..eaf90aabe8c 100644
--- a/source/blender/editors/space_view3d/space_view3d.c
+++ b/source/blender/editors/space_view3d/space_view3d.c
@@ -40,6 +40,7 @@
 
 #include "BLT_translation.h"
 
+#include "BKE_asset.h"
 #include "BKE_context.h"
 #include "BKE_curve.h"
 #include "BKE_global.h"
@@ -515,6 +516,45 @@ static bool view3d_drop_id_in_main_region_poll(bContext *C,
   return WM_drag_is_ID_type(drag, id_type);
 }
 
+static void view3d_ob_drop_draw_activate(struct wmDropBox *drop, wmDrag *drag)
+{
+  V3DSnapCursorState *state = drop->draw_data;
+  if (state) {
+    return;
+  }
+  state = drop->draw_data = ED_view3d_cursor_snap_active();
+  state->draw_point = true;
+  state->draw_plane = true;
+
+  float dimensions[3] = {0.0f};
+  if (drag->type == WM_DRAG_ID) {
+    Object *ob = (Object *)WM_drag_get_local_ID(drag, ID_OB);
+    BKE_object_dimensions_get(ob, dimensions);
+  }
+  else {
+    struct AssetMetaData *meta_data = WM_drag_get_asset_meta_data(drag, ID_OB);
+    IDProperty *dimensions_prop = BKE_asset_metadata_idprop_find(meta_data, "dimensions");
+    if (dimensions_prop) {
+      copy_v3_v3(dimensions, IDP_Array(dimensions_prop));
+    }
+  }
+
+  if (!is_zero_v3(dimensions)) {
+    mul_v3_v3fl(state->box_dimensions, dimensions, 0.5f);
+    UI_GetThemeColor4ubv(TH_GIZMO_PRIMARY, state->color_box);
+    state->draw_box = true;
+  }
+}
+
+static void view3d_ob_drop_draw_deactivate(struct wmDropBox *drop, wmDrag *UNUSED(drag))
+{
+  V3DSnapCursorState *state = drop->draw_data;
+  if (state) {
+    ED_view3d_cursor_snap_deactive(state);
+    drop->draw_data = NULL;
+  }
+}
+
 static bool view3d_ob_drop_poll(bContext *C, wmDrag *drag, const wmEvent *event)
 {
   return view3d_drop_id_in_main_region_poll(C, drag, event, ID_OB);
@@ -639,6 +679,31 @@ static void view3d_ob_drop_copy(wmDrag *drag, wmDropBox *drop)
   /* Don't duplicate ID's which were just imported. Only do that for existing, local IDs. */
   const bool is_imported_id = drag->type == WM_DRAG_ASSET;
   RNA_boolean_set(drop->ptr, "duplicate", !is_imported_id);
+
+  V3DSnapCursorState *snap_state = drop->draw_data;
+  if (snap_state) {
+    Object *ob = (Object *)id;
+    float obmat_final[4][4];
+
+    V3DSnapCursorData *snap_data;
+    snap_data = ED_view3d_cursor_snap_data_get(snap_state, NULL, 0, 0);
+    copy_m4_m3(obmat_final, snap_data->plane_omat);
+    copy_v3_v3(obmat_final[3], snap_data->loc);
+
+    float scale[3];
+    mat4_to_size(scale, ob->obmat);
+    rescale_m4(obmat_final, scale);
+
+    BoundBox *bb = BKE_object_boundbox_get(ob);
+    if (bb) {
+      float offset[3];
+      BKE_boundbox_calc_center_aabb(bb, offset);
+      offset[2] = bb->vec[0][2];
+      mul_mat3_m4_v3(obmat_final, offset);
+      sub_v3_v3(obmat_final[3], offset);
+    }
+    RNA_float_set_array(drop->ptr, "matrix", &obmat_final[0][0]);
+  }
 }
 
 static void view3d_collection_drop_copy(wmDrag *drag, wmDropBox *drop)
@@ -703,12 +768,19 @@ static void view3d_dropboxes(void)
 {
   ListBase *lb = WM_dropboxmap_find("View3D", SPACE_VIEW3D, RGN_TYPE_WINDOW);
 
-  WM_dropbox_add(lb,
-                 "OBJECT_OT_add_named",
-                 view3d_ob_drop_poll,
-                 view3d_ob_drop_copy,
-                 WM_drag_free_imported_drag_ID,
-                 NULL);
+  struct wmDropBox *drop;
+  drop = WM_dropbox_add(lb,
+                        "OBJECT_OT_add_named",
+                        view3d_ob_drop_poll,
+                        view3d_ob_drop_copy,
+                        WM_drag_free_imported_drag_ID,
+                        NULL);
+
+  drop->draw = WM_drag_draw_item_name_fn;
+  drop->draw_activate = view3d_ob_drop_draw_activate;
+  drop->draw_deactivate = view3d_ob_drop_draw_deactivate;
+  drop->opcontext = WM_OP_EXEC_DEFAULT; /* Not really needed. */
+
   WM_dropbox_add(lb,
                  "OBJECT_OT_drop_named_material",
                  view3d_mat_drop_poll,
diff --git a/source/blender/editors/space_view3d/view3d_cursor_snap.c b/source/blender/editors/space_view3d/view3d_cursor_snap.c
index 1cb650910ce..5eb9ec3625c 100644
--- a/source/blender/editors/space_view3d/view3d_cursor_snap.c
+++ b/source/blender/editors/space_view3d/view3d_cursor_snap.c
@@ -58,7 +58,6 @@
 
 typedef struct SnapStateIntern {
   V3DSnapCursorState snap_state;
-  float prevpoint_stack[3];
   int state_active_prev;
   bool is_active;
 } SnapStateIntern;
@@ -75,6 +74,8 @@ typedef struct SnapCursorDataIntern {
   const Scene *scene;
   short snap_elem_hidden;
 
+  float prevpoint_stack[3];
+
   /* Copy of the parameters of the last event state in order to detect updates. */
   struct {
     int x;
@@ -94,17 +95,6 @@ typedef struct SnapCursorDataIntern {
   bool is_initiated;
 } SnapCursorDataIntern;
 
-static void UNUSED_FUNCTION(v3d_cursor_snap_state_init)(V3DSnapCursorState *state)
-{
-  state->prevpoint = NULL;
-  state->snap_elem_force = (SCE_SNAP_MODE_VERTEX | SCE_SNAP_MODE_EDGE | SCE_SNAP_MODE_FACE |
-                            SCE_SNAP_MODE_EDGE_PERPENDICULAR | SCE_SNAP_MODE_EDGE_MIDPOINT);
-  state->plane_axis = 2;
-  rgba_uchar_args_set(state->color_point, 255, 255, 255, 255);
-  rgba_uchar_args_set(state->color_line, 255, 255, 255, 128);
-  state->draw_point = true;
-  state->draw_plane = false;
-}
 static SnapCursorDataIntern g_data_intern = {
     .state_default = {.prevpoint = NULL,
                       .snap_elem_force = (SCE_SNAP_MODE_VERTEX | SCE_SNAP_MODE_EDGE |
@@ -113,8 +103,9 @@ static SnapCursorDataIntern g_data_intern = {
                       .plane_axis = 2,
                       .color_point = {255, 255, 255, 255},
                       .color_line = {255, 255, 255, 128},
-                      .draw_point = true,
-                      .draw_plane = false}};
+                      .color_box = {255, 255, 255, 128},
+                      .box_dimensions = {1.0f, 1.0f, 1.0f},
+                      .draw_point = true}};
 
 /**
  * Calculate a 3x3 orientation matrix from the surface under the cursor.
@@ -373,6 +364,24 @@ static void v3d_cursor_plane_draw(const RegionView3D *rv3d,
   }
 }
 
+static void cursor_box_draw(const float dimensions[3], uchar color[4])
+{
+  GPUVertFormat *format = immVertexFormat();
+  const uint pos_id = GPU_vertformat_attr_add(format, "pos", GPU_COMP_F32, 3, GPU_FETCH_FLOAT);
+
+  GPU_blend(GPU_BLEND_ALPHA);
+  GPU_line_smooth(true);
+  GPU_line_width(1.0f);
+
+  immBindBuiltinProgram(GPU_SHADER_3D_UNIFORM_COLOR);
+  immUniformColor4ubv(color);
+  imm_draw_cube_corners_3d(pos_id, (float[3]){0.0f, 0.0f, dimensions[2]}, dimensions, 0.15f);
+  immUnbindProgram();
+
+  GPU_line_smooth(false);
+  GPU_blend(GPU_BLEND_NONE);
+}
+
 void ED_view3d_cursor_snap_draw_util(RegionView3D *rv3d,
                                      const float loc_prev[3],
                                      const float loc_curr[3],
@@ -601,7 +610,7 @@ static void v3d_cursor_snap_update(V3DSnapCursorState *state,
 
   ushort snap_elements = v3d_cursor_snap_elements(state, scene);
   data_intern->snap_elem_hidden = 0;
-  const bool draw_plane = state->draw_plane;
+  const bool draw_plane = state->draw_plane || state->draw_box;
   if (draw_plane && !(snap_elements & SCE_SNAP_MODE_FACE)) {
     data_intern->snap_elem_hidden = SCE_SNAP_MODE_FACE;
     snap_elements |= SCE_SNAP_MODE_FACE;
@@ -674,6 +683,7 @@ static void v3d_cursor_snap_update(V3DSnapCursorState *state,
   }
 
   if (draw_plane) {
+    RegionView3D *rv3d = region->regiondata;
     bool orient_surface = snap_elem && (state->plane_orient == V3D_PLACE_ORIENT_SURFACE);
     if (orient_surface) {
       copy_m3_m4(omat, obmat);
@@ -686,7 +696,6 @@ static void v3d_cursor_snap_update(V3DSnapCursorState *state,
       ED_transform_calc_orientation_from_type_ex(
           scene, view_layer, v3d, region->regiondata, ob, ob, orient_index, pivot_point, omat);
 
-      RegionView3D *rv3d = region->regiondata;
       if (state->use_plane_axis_auto) {
         mat3_align_axis_to_v3(omat, state->plane_axis, rv3d->viewinv[2]);
       }
@@ -699,6 +708,9 @@ static void v3d_cursor_snap_update(V3DSnapCursorState *state,
     orthogonalize_m3(omat, state->plane_axis);
 
     if (orient_surface) {
+      if (dot_v3v3(rv3d->viewinv[2], face_nor) < 0.0f) {
+        negate_v3(face_nor);
+      }
       v3d_cursor_poject_surface_normal(face_nor, obmat, omat);
     }
   }
@@ -791,7 +803,7 @@ static void v3d_cursor_snap_draw_fn(bContext *C, int x, int y, void *UNUSED(cust
     v3d_cursor_snap_update(state, C, wm, depsgraph, scene, region, v3d, x, y);
   }
 
-  const bool draw_plane = state->draw_plane;
+  const bool draw_plane = state->draw_plane || state->draw_box;
   if (!snap_data->snap_elem && !draw_plane) {
     return;
   }
@@ -802,8 +814,6 @@ static void v3d_cursor_snap_draw_fn(bContext *C, int x, int y, void *UNUSED(cust
   GPU_matrix_projection_set(rv3d->winmat);
   GPU_matrix_set(rv3d->viewmat);
 
-  GPU_blend(GPU_BLEND_ALPHA);
-
   float matrix[4][4];
   if (draw_plane) {
     copy_m4_m3(matrix, snap_data->plane_omat);
@@ -812,7 +822,7 @@ static void v3d_cursor_snap_draw_fn(bContext *C, int x, int y, void *UNUSED(cust
     v3d_cursor_plane_draw(rv3d, state->plane_axis, matrix);
   }
 
-  if (snap_data->snap_elem && state->draw_point) {
+  if (snap_data->snap_elem && (state->draw_point || state->draw_box)) {
     const float *prev_point = (snap_data->snap_elem & SCE_SNAP_MODE_EDGE_PERPENDICULAR) ?
                                   state->prevpoint :
                                   NULL;
@@ -829,7 +839,10 @@ static void v3d_cursor_snap_draw_fn(bContext *C, int x, int y, void *UNUSED(cust
                                     snap_data->snap_elem);
   }
 
-  GPU_blend(GPU_BLEND_NONE);
+  if (state->draw_box) {
+    GPU_matrix_mul(matrix);
+    cursor_box_draw(state->box_dimensions, state->color_box);
+  }
 
   /* Restore matrix. */
   wmWindowViewport(CTX_wm_window(C));
@@ -942,10 +955,10 @@ void ED_view3d_cursor_snap_deactive(V3DSnapCursorState *state)
 
 void ED_view3d_cursor_snap_prevpoint_set(V3DSnapCursorState *state, const float prev_point[3])
 {
-  SnapStateIntern *state_intern = (SnapStateIntern *)state;
+  SnapCursorDataIntern *data_intern = &g_data_intern;
   if (prev_point) {
-    copy_v3_v3(state_intern->prevpoint_stack, prev_point);
-    state->prevpoint = state_intern->prevpoint_stack;
+    copy_v3_v3(data_intern->prevpoint_stack, prev_point);
+    state->prevpoint = data_intern->prevpoint_stack;
   }
   else {
     state->prevpoint = NULL;