Blender V5.3
MOD_datatransfer.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2014 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cfloat>
10
11#include "BLI_utildefines.hh"
12
13#include "BLT_translation.hh"
14
15#include "DNA_mesh_types.h"
16#include "DNA_modifier_types.h"
17#include "DNA_object_types.h"
18#include "DNA_screen_types.h"
19
20#include "BKE_customdata.hh"
21#include "BKE_data_transfer.h"
22#include "BKE_lib_id.hh"
23#include "BKE_lib_query.hh"
24#include "BKE_mesh.hh"
25#include "BKE_mesh_remap.hh"
26#include "BKE_modifier.hh"
27#include "BKE_report.hh"
28
30#include "UI_resources.hh"
31
32#include "RNA_access.hh"
33#include "RNA_prototypes.hh"
34
35#include "MEM_guardedalloc.h"
36
37#include "MOD_ui_common.hh"
38
39namespace blender {
40
41/**************************************
42 * Modifiers functions. *
43 **************************************/
44static void init_data(ModifierData *md)
45{
46 DataTransferModifierData *dtmd = reinterpret_cast<DataTransferModifierData *>(md);
47 int i;
48
49 dtmd->ob_source = nullptr;
50 dtmd->data_types = 0;
51
56
57 dtmd->map_max_distance = 1.0f;
58 dtmd->map_ray_radius = 0.0f;
59
60 for (i = 0; i < DT_MULTILAYER_INDEX_MAX; i++) {
63 }
64
66 dtmd->mix_factor = 1.0f;
67 dtmd->defgrp_name[0] = '\0';
68
70}
71
72static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
73{
74 DataTransferModifierData *dtmd = reinterpret_cast<DataTransferModifierData *>(md);
75
76 if (dtmd->defgrp_name[0] != '\0') {
77 /* We need vertex groups! */
78 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
79 }
80
82}
83
84static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
85{
86 DataTransferModifierData *dtmd = reinterpret_cast<DataTransferModifierData *>(md);
87 walk(user_data, ob, reinterpret_cast<ID **>(&dtmd->ob_source), IDWALK_CB_NOP);
88}
89
91{
92 DataTransferModifierData *dtmd = reinterpret_cast<DataTransferModifierData *>(md);
93 if (dtmd->ob_source != nullptr) {
94 CustomData_MeshMasks cddata_masks = {0};
96
98 ctx->node, dtmd->ob_source, DEG_OB_COMP_GEOMETRY, "DataTransfer Modifier");
99 DEG_add_customdata_mask(ctx->node, dtmd->ob_source, &cddata_masks);
100
103 ctx->node, dtmd->ob_source, DEG_OB_COMP_TRANSFORM, "DataTransfer Modifier");
104 DEG_add_depends_on_transform_relation(ctx->node, "DataTransfer Modifier");
105 }
106 }
107}
108
109static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
110{
111 /* If no source object, bypass. */
112 DataTransferModifierData *dtmd = reinterpret_cast<DataTransferModifierData *>(md);
113 /* The object type check is only needed here in case we have a placeholder
114 * object assigned (because the library containing the mesh is missing).
115 *
116 * In other cases it should be impossible to have a type mismatch.
117 */
118 return !dtmd->ob_source || dtmd->ob_source->type != OB_MESH;
119}
120
121#define DT_TYPES_AFFECT_MESH \
122 (DT_TYPE_BWEIGHT_VERT | DT_TYPE_BWEIGHT_EDGE | DT_TYPE_CREASE | DT_TYPE_SHARP_EDGE | \
123 DT_TYPE_LNOR | DT_TYPE_SHARP_FACE)
124
125static Mesh *modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *me_mod)
126{
127 DataTransferModifierData *dtmd = reinterpret_cast<DataTransferModifierData *>(md);
128 Mesh *result = me_mod;
129 ReportList reports;
130
131 /* Only used to check whether we are operating on org data or not... */
132 const Mesh *mesh = id_cast<const Mesh *>(ctx->object->data);
133
134 Object *ob_source = dtmd->ob_source;
135
136 const bool invert_vgroup = (dtmd->flags & MOD_DATATRANSFER_INVERT_VGROUP) != 0;
137
138 const float max_dist = (dtmd->flags & MOD_DATATRANSFER_MAP_MAXDIST) ? dtmd->map_max_distance :
139 FLT_MAX;
140
141 SpaceTransform space_transform_data;
142 SpaceTransform *space_transform = (dtmd->flags & MOD_DATATRANSFER_OBSRC_TRANSFORM) ?
143 &space_transform_data :
144 nullptr;
145
146 if (space_transform) {
147 BLI_SPACE_TRANSFORM_SETUP(space_transform, ctx->object, ob_source);
148 }
149
150 const Span<float3> me_positions = mesh->vert_positions();
151 const Span<int2> me_edges = mesh->edges();
152 const Span<float3> result_positions = result->vert_positions();
153
154 const Span<int2> result_edges = result->edges();
155
156 if (((result == mesh) || (me_positions.data() == result_positions.data()) ||
157 (me_edges.data() == result_edges.data())) &&
159 {
160 /* We need to duplicate data here, otherwise setting custom normals, edges' sharpness, etc.,
161 * could modify org mesh, see #43671. */
162 result = id_cast<Mesh *>(BKE_id_copy_ex(nullptr, &me_mod->id, nullptr, LIB_ID_COPY_LOCALIZE));
163 }
164
165 BKE_reports_init(&reports, RPT_STORE);
166
167 /* NOTE: no islands precision for now here. */
169 ob_source,
170 ctx->object,
171 result,
172 dtmd->data_types,
173 false,
174 dtmd->vmap_mode,
175 dtmd->emap_mode,
176 dtmd->lmap_mode,
177 dtmd->pmap_mode,
178 space_transform,
179 false,
180 max_dist,
181 dtmd->map_ray_radius,
182 0.0f,
183 dtmd->layers_select_src,
184 dtmd->layers_select_dst,
185 dtmd->mix_mode,
186 dtmd->mix_factor,
187 dtmd->defgrp_name,
188 invert_vgroup,
189 &reports))
190 {
191 result->runtime->is_original_bmesh = false;
192 }
193
194 if (BKE_reports_contain(&reports, RPT_ERROR)) {
195 const char *report_str = BKE_reports_string(&reports, RPT_ERROR);
196 BKE_modifier_set_error(ctx->object, md, "%s", report_str);
197 MEM_delete(report_str);
198 }
199
200 BKE_reports_free(&reports);
201
202 return result;
203}
204
205static void panel_draw(const bContext * /*C*/, Panel *panel)
206{
207 ui::Layout &layout = *panel->layout;
208
209 PointerRNA ob_ptr;
211
212 layout.use_property_split_set(true);
213
214 ui::Layout *row = &layout.row(true);
215 row->prop(ptr, "object", UI_ITEM_NONE, IFACE_("Source"), ICON_NONE);
216 ui::Layout &sub = row->row(true);
217 sub.use_property_decorate_set(false);
218 sub.prop(ptr, "use_object_transform", UI_ITEM_NONE, "", ICON_ORIENTATION_GLOBAL);
219
220 layout.prop(ptr, "mix_mode", UI_ITEM_NONE, std::nullopt, ICON_NONE);
221
222 row = &layout.row(false);
223 row->active_set(!ELEM(RNA_enum_get(ptr, "mix_mode"),
227 row->prop(ptr, "mix_factor", UI_ITEM_NONE, std::nullopt, ICON_NONE);
228
229 modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
230
231 layout.op("OBJECT_OT_datalayout_transfer", IFACE_("Generate Data Layers"), ICON_NONE);
232
233 modifier_error_message_draw(layout, ptr);
234}
235
236static void vertex_panel_draw_header(const bContext * /*C*/, Panel *panel)
237{
239 ui::Layout &layout = *panel->layout;
240
241 layout.prop(ptr, "use_vert_data", UI_ITEM_NONE, std::nullopt, ICON_NONE);
242}
243
244static void vertex_panel_draw(const bContext * /*C*/, Panel *panel)
245{
246 ui::Layout &layout = *panel->layout;
247
249
250 bool use_vert_data = RNA_boolean_get(ptr, "use_vert_data");
251 layout.active_set(use_vert_data);
252
253 layout.prop(ptr, "data_types_verts", ui::ITEM_R_EXPAND, std::nullopt, ICON_NONE);
254
255 layout.use_property_split_set(true);
256
257 layout.prop(ptr, "vert_mapping", UI_ITEM_NONE, IFACE_("Mapping"), ICON_NONE);
258}
259
260static void vertex_vgroup_panel_draw(const bContext * /*C*/, Panel *panel)
261{
262 ui::Layout &layout = *panel->layout;
263
265
266 layout.active_set(RNA_enum_get(ptr, "data_types_verts") & DT_TYPE_MDEFORMVERT);
267
268 layout.use_property_split_set(true);
269
270 layout.prop(ptr, "layers_vgroup_select_src", UI_ITEM_NONE, IFACE_("Layer Selection"), ICON_NONE);
271 layout.prop(ptr, "layers_vgroup_select_dst", UI_ITEM_NONE, IFACE_("Layer Mapping"), ICON_NONE);
272}
273
274static void edge_panel_draw_header(const bContext * /*C*/, Panel *panel)
275{
276 ui::Layout &layout = *panel->layout;
277
279
280 layout.prop(ptr, "use_edge_data", UI_ITEM_NONE, std::nullopt, ICON_NONE);
281}
282
283static void edge_panel_draw(const bContext * /*C*/, Panel *panel)
284{
285 ui::Layout &layout = *panel->layout;
286
288
289 layout.active_set(RNA_boolean_get(ptr, "use_edge_data"));
290
291 layout.prop(ptr, "data_types_edges", ui::ITEM_R_EXPAND, std::nullopt, ICON_NONE);
292
293 layout.use_property_split_set(true);
294
295 layout.prop(ptr, "edge_mapping", UI_ITEM_NONE, IFACE_("Mapping"), ICON_NONE);
296}
297
298static void face_corner_panel_draw_header(const bContext * /*C*/, Panel *panel)
299{
300 ui::Layout &layout = *panel->layout;
301
303
304 layout.prop(ptr, "use_loop_data", UI_ITEM_NONE, std::nullopt, ICON_NONE);
305}
306
307static void face_corner_panel_draw(const bContext * /*C*/, Panel *panel)
308{
309 ui::Layout &layout = *panel->layout;
310
312
313 layout.active_set(RNA_boolean_get(ptr, "use_loop_data"));
314
315 layout.prop(ptr, "data_types_loops", ui::ITEM_R_EXPAND, std::nullopt, ICON_NONE);
316
317 layout.use_property_split_set(true);
318
319 layout.prop(ptr, "loop_mapping", UI_ITEM_NONE, IFACE_("Mapping"), ICON_NONE);
320}
321
322static void vert_vcol_panel_draw(const bContext * /*C*/, Panel *panel)
323{
324 ui::Layout &layout = *panel->layout;
325
327
328 layout.use_property_split_set(true);
329
330 layout.active_set(RNA_enum_get(ptr, "data_types_verts") &
332
333 layout.prop(
334 ptr, "layers_vcol_vert_select_src", UI_ITEM_NONE, IFACE_("Layer Selection"), ICON_NONE);
335 layout.prop(
336 ptr, "layers_vcol_vert_select_dst", UI_ITEM_NONE, IFACE_("Layer Mapping"), ICON_NONE);
337}
338
339static void face_corner_vcol_panel_draw(const bContext * /*C*/, Panel *panel)
340{
341 ui::Layout &layout = *panel->layout;
342
344
345 layout.use_property_split_set(true);
346
347 layout.active_set(RNA_enum_get(ptr, "data_types_loops") &
349
350 layout.prop(
351 ptr, "layers_vcol_loop_select_src", UI_ITEM_NONE, IFACE_("Layer Selection"), ICON_NONE);
352 layout.prop(
353 ptr, "layers_vcol_loop_select_dst", UI_ITEM_NONE, IFACE_("Layer Mapping"), ICON_NONE);
354}
355
356static void face_corner_uv_panel_draw(const bContext * /*C*/, Panel *panel)
357{
358 ui::Layout &layout = *panel->layout;
359
361
362 layout.use_property_split_set(true);
363
364 layout.active_set(RNA_enum_get(ptr, "data_types_loops") & DT_TYPE_UV);
365
366 layout.prop(ptr, "layers_uv_select_src", UI_ITEM_NONE, IFACE_("Layer Selection"), ICON_NONE);
367 layout.prop(ptr, "layers_uv_select_dst", UI_ITEM_NONE, IFACE_("Layer Mapping"), ICON_NONE);
368 layout.prop(ptr, "islands_precision", UI_ITEM_NONE, std::nullopt, ICON_NONE);
369}
370
371static void face_panel_draw_header(const bContext * /*C*/, Panel *panel)
372{
373 ui::Layout &layout = *panel->layout;
374
376
377 layout.prop(ptr, "use_poly_data", UI_ITEM_NONE, std::nullopt, ICON_NONE);
378}
379
380static void face_panel_draw(const bContext * /*C*/, Panel *panel)
381{
382 ui::Layout &layout = *panel->layout;
383
385
386 layout.active_set(RNA_boolean_get(ptr, "use_poly_data"));
387
388 layout.prop(ptr, "data_types_polys", UI_ITEM_NONE, std::nullopt, ICON_NONE);
389
390 layout.use_property_split_set(true);
391
392 layout.prop(ptr, "poly_mapping", UI_ITEM_NONE, IFACE_("Mapping"), ICON_NONE);
393}
394
395static void advanced_panel_draw(const bContext * /*C*/, Panel *panel)
396{
397 ui::Layout &layout = *panel->layout;
398
400
401 layout.use_property_split_set(true);
402
403 ui::Layout &row = layout.row(true, IFACE_("Max Distance"));
404 row.prop(ptr, "use_max_distance", UI_ITEM_NONE, "", ICON_NONE);
405 ui::Layout &sub = row.row(true);
406 sub.active_set(RNA_boolean_get(ptr, "use_max_distance"));
407 sub.prop(ptr, "max_distance", UI_ITEM_NONE, "", ICON_NONE);
408
409 layout.prop(ptr, "ray_radius", UI_ITEM_NONE, std::nullopt, ICON_NONE);
410}
411
412static void panel_register(ARegionType *region_type)
413{
417 region_type, "vertex", "", vertex_panel_draw_header, vertex_panel_draw, panel_type);
418 modifier_subpanel_register(region_type,
419 "vertex_vgroup",
420 "Vertex Groups",
421 nullptr,
423 vertex_panel);
424
426 region_type, "vert_vcol", "Colors", nullptr, vert_vcol_panel_draw, vertex_panel);
427
429 region_type, "edge", "", edge_panel_draw_header, edge_panel_draw, panel_type);
430
431 PanelType *face_corner_panel = modifier_subpanel_register(region_type,
432 "face_corner",
433 "",
436 panel_type);
437 modifier_subpanel_register(region_type,
438 "face_corner_vcol",
439 "Colors",
440 nullptr,
442 face_corner_panel);
444 region_type, "face_corner_uv", "UVs", nullptr, face_corner_uv_panel_draw, face_corner_panel);
445
447 region_type, "face", "", face_panel_draw_header, face_panel_draw, panel_type);
449 region_type, "advanced", "Topology Mapping", nullptr, advanced_panel_draw, panel_type);
450}
451
452#undef DT_TYPES_AFFECT_MESH
453
455 /*idname*/ "DataTransfer",
456 /*name*/ N_("DataTransfer"),
457 /*struct_name*/ "DataTransferModifierData",
458 /*struct_size*/ sizeof(DataTransferModifierData),
459 /*srna*/ &RNA_DataTransferModifier,
463 /*icon*/ ICON_MOD_DATA_TRANSFER,
464
465 /*copy_data*/ BKE_modifier_copydata_generic,
466
467 /*deform_verts*/ nullptr,
468 /*deform_matrices*/ nullptr,
469 /*deform_verts_EM*/ nullptr,
470 /*deform_matrices_EM*/ nullptr,
471 /*modify_mesh*/ modify_mesh,
472 /*modify_geometry_set*/ nullptr,
473
474 /*init_data*/ init_data,
475 /*required_data_mask*/ required_data_mask,
476 /*free_data*/ nullptr,
477 /*is_disabled*/ is_disabled,
478 /*update_depsgraph*/ update_depsgraph,
479 /*depends_on_time*/ nullptr,
480 /*depends_on_normals*/ nullptr,
481 /*foreach_ID_link*/ foreach_ID_link,
482 /*foreach_tex_link*/ nullptr,
483 /*free_runtime_data*/ nullptr,
484 /*panel_register*/ panel_register,
485 /*blend_write*/ nullptr,
486 /*blend_read*/ nullptr,
487 /*foreach_cache*/ nullptr,
488 /*foreach_working_space_color*/ nullptr,
489};
490
491} // namespace blender
CustomData interface, see also DNA_customdata_types.h.
#define BLI_SPACE_TRANSFORM_SETUP(data, local, target)
#define IFACE_(msgid)
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define DT_TYPES_AFFECT_MESH
#define UI_ITEM_NONE
#define ELEM(...)
#define CD_MASK_MDEFORMVERT
constexpr const T * data() const
Definition BLI_span.hh:219
#define FLT_MAX
BMesh Iterators.
@ CDT_MIX_REPLACE_ABOVE_THRESHOLD
@ CDT_MIX_REPLACE_BELOW_THRESHOLD
int RNA_enum_get(PointerRNA *ptr, const char *name)
void BKE_modifier_set_error(const Object *ob, ModifierData *md, const char *format,...) ATTR_PRINTF_FORMAT(3
static void face_corner_vcol_panel_draw(const bContext *, Panel *panel)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
static void vertex_vgroup_panel_draw(const bContext *, Panel *panel)
@ MREMAP_MODE_LOOP_NEAREST_POLYNOR
static void face_panel_draw(const bContext *, Panel *panel)
static void edge_panel_draw(const bContext *, Panel *panel)
void BKE_reports_free(ReportList *reports)
Definition report.cc:106
static void edge_panel_draw_header(const bContext *, Panel *panel)
void BKE_reports_init(ReportList *reports, int flag)
Definition report.cc:91
static void face_panel_draw_header(const bContext *, Panel *panel)
@ eModifierType_DataTransfer
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
static void update_depsgraph(tGraphSliderOp *gso)
static void face_corner_panel_draw_header(const bContext *, Panel *panel)
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
static void vertex_panel_draw(const bContext *, Panel *panel)
void DEG_add_object_relation(DepsNodeHandle *node_handle, Object *object, eDepsObjectComponentType component, const char *description)
ModifierTypeInfo modifierType_DataTransfer
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
@ LIB_ID_COPY_LOCALIZE
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
@ MOD_DATATRANSFER_INVERT_VGROUP
@ MOD_DATATRANSFER_OBSRC_TRANSFORM
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
bool BKE_object_data_transfer_ex(struct Depsgraph *depsgraph, struct Object *ob_src, struct Object *ob_dst, struct Mesh *me_dst, int data_types, bool use_create, int map_vert_mode, int map_edge_mode, int map_loop_mode, int map_face_mode, struct SpaceTransform *space_transform, bool auto_transform, float max_distance, float ray_radius, float islands_handling_precision, const int fromlayers_select[DT_MULTILAYER_INDEX_MAX], const int tolayers_select[DT_MULTILAYER_INDEX_MAX], int mix_mode, float mix_factor, const char *vgroup_name, bool invert_vgroup, struct ReportList *reports)
void modifier_vgroup_ui(ui::Layout &layout, PointerRNA *ptr, PointerRNA *ob_ptr, const StringRefNull vgroup_prop, const std::optional< StringRefNull > invert_vgroup_prop, const std::optional< StringRefNull > text)
static void vertex_panel_draw_header(const bContext *, Panel *panel)
static void panel_register(ARegionType *region_type)
bool BKE_reports_contain(ReportList *reports, eReportType level)
Definition report.cc:394
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsMesh
static void advanced_panel_draw(const bContext *, Panel *panel)
static void face_corner_panel_draw(const bContext *, Panel *panel)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static void vert_vcol_panel_draw(const bContext *, Panel *panel)
static void panel_draw(const bContext *, Panel *panel)
PanelType * modifier_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
void BKE_object_data_transfer_dttypes_to_cdmask(int dtdata_types, struct CustomData_MeshMasks *r_data_masks)
ID * BKE_id_copy_ex(Main *bmain, const ID *id, ID **new_id_p, int flag)
Definition lib_id.cc:851
static bool is_disabled(const Scene *, ModifierData *md, bool)
static void face_corner_uv_panel_draw(const bContext *, Panel *panel)
char * BKE_reports_string(ReportList *reports, eReportType level)
Definition report.cc:307
void DEG_add_customdata_mask(DepsNodeHandle *handle, Object *object, const CustomData_MeshMasks *masks)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
ui::Layout * layout
void use_property_decorate_set(bool is_decorate)
void use_property_split_set(bool is_sep)
PointerRNA op(wmOperatorType *ot, std::optional< StringRef > name, int icon, wm::OpCallContext context, eUI_Item_Flag flag)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
void active_set(bool active)
Layout & row(bool align)
#define N_(msgid)