Blender  V3.3
MOD_shrinkwrap.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later
2  * Copyright 2005 Blender Foundation. All rights reserved. */
3 
8 #include <string.h>
9 
10 #include "BLI_utildefines.h"
11 
12 #include "BLT_translation.h"
13 
14 #include "DNA_defaults.h"
15 #include "DNA_mesh_types.h"
16 #include "DNA_object_types.h"
17 #include "DNA_screen_types.h"
18 
19 #include "BKE_context.h"
20 #include "BKE_editmesh.h"
21 #include "BKE_lib_id.h"
22 #include "BKE_lib_query.h"
23 #include "BKE_mesh.h"
24 #include "BKE_mesh_wrapper.h"
25 #include "BKE_modifier.h"
26 #include "BKE_screen.h"
27 #include "BKE_shrinkwrap.h"
28 
29 #include "UI_interface.h"
30 #include "UI_resources.h"
31 
32 #include "RNA_access.h"
33 #include "RNA_prototypes.h"
34 
35 #include "DEG_depsgraph_query.h"
36 
37 #include "MOD_ui_common.h"
38 #include "MOD_util.h"
39 
40 static bool dependsOnNormals(ModifierData *md);
41 
42 static void initData(ModifierData *md)
43 {
45 
47 
49 }
50 
51 static void requiredDataMask(Object *UNUSED(ob),
52  ModifierData *md,
53  CustomData_MeshMasks *r_cddata_masks)
54 {
56 
57  /* ask for vertexgroups if we need them */
58  if (smd->vgroup_name[0] != '\0') {
59  r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
60  }
61 
62  if ((smd->shrinkType == MOD_SHRINKWRAP_PROJECT) &&
64  /* XXX Really? These should always be present, always... */
65  r_cddata_masks->vmask |= CD_MASK_MVERT;
66  }
67 }
68 
69 static bool isDisabled(const struct Scene *UNUSED(scene),
70  ModifierData *md,
71  bool UNUSED(useRenderParams))
72 {
74 
75  /* The object type check is only needed here in case we have a placeholder
76  * object assigned (because the library containing the mesh is missing).
77  *
78  * In other cases it should be impossible to have a type mismatch.
79  */
80  if (!smd->target || smd->target->type != OB_MESH) {
81  return true;
82  }
83  if (smd->auxTarget && smd->auxTarget->type != OB_MESH) {
84  return true;
85  }
86  return false;
87 }
88 
89 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
90 {
92 
93  walk(userData, ob, (ID **)&smd->target, IDWALK_CB_NOP);
94  walk(userData, ob, (ID **)&smd->auxTarget, IDWALK_CB_NOP);
95 }
96 
97 static void deformVerts(ModifierData *md,
98  const ModifierEvalContext *ctx,
99  Mesh *mesh,
100  float (*vertexCos)[3],
101  int verts_num)
102 {
105  Mesh *mesh_src = NULL;
106 
107  if (ELEM(ctx->object->type, OB_MESH, OB_LATTICE) ||
108  (swmd->shrinkType == MOD_SHRINKWRAP_PROJECT)) {
109  /* mesh_src is needed for vgroups, but also used as ShrinkwrapCalcData.vert when projecting.
110  * Avoid time-consuming mesh conversion for curves when not projecting. */
111  mesh_src = MOD_deform_mesh_eval_get(ctx->object, NULL, mesh, NULL, verts_num, false, false);
112  }
113 
114  struct MDeformVert *dvert = NULL;
115  int defgrp_index = -1;
116  MOD_get_vgroup(ctx->object, mesh_src, swmd->vgroup_name, &dvert, &defgrp_index);
117 
119  swmd, ctx, scene, ctx->object, mesh_src, dvert, defgrp_index, vertexCos, verts_num);
120 
121  if (!ELEM(mesh_src, NULL, mesh)) {
122  BKE_id_free(NULL, mesh_src);
123  }
124 }
125 
126 static void deformVertsEM(ModifierData *md,
127  const ModifierEvalContext *ctx,
128  struct BMEditMesh *editData,
129  Mesh *mesh,
130  float (*vertexCos)[3],
131  int verts_num)
132 {
135  Mesh *mesh_src = NULL;
136 
137  if ((swmd->vgroup_name[0] != '\0') || (swmd->shrinkType == MOD_SHRINKWRAP_PROJECT)) {
138  mesh_src = MOD_deform_mesh_eval_get(
139  ctx->object, editData, mesh, NULL, verts_num, false, false);
140  }
141 
142  /* TODO(Campbell): use edit-mode data only (remove this line). */
143  if (mesh_src != NULL) {
145  }
146 
147  struct MDeformVert *dvert = NULL;
148  int defgrp_index = -1;
149  if (swmd->vgroup_name[0] != '\0') {
150  MOD_get_vgroup(ctx->object, mesh_src, swmd->vgroup_name, &dvert, &defgrp_index);
151  }
152 
154  swmd, ctx, scene, ctx->object, mesh_src, dvert, defgrp_index, vertexCos, verts_num);
155 
156  if (!ELEM(mesh_src, NULL, mesh)) {
157  BKE_id_free(NULL, mesh_src);
158  }
159 }
160 
162 {
165 
167  mask.vmask |= CD_MASK_NORMAL;
169  }
170 
171  if (smd->target != NULL) {
172  DEG_add_object_relation(ctx->node, smd->target, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
173  DEG_add_object_relation(ctx->node, smd->target, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
174  DEG_add_customdata_mask(ctx->node, smd->target, &mask);
177  }
178  }
179  if (smd->auxTarget != NULL) {
181  ctx->node, smd->auxTarget, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
183  ctx->node, smd->auxTarget, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
187  }
188  }
189  DEG_add_modifier_to_transform_relation(ctx->node, "Shrinkwrap Modifier");
190 }
191 
193 {
195 
196  if (smd->target && smd->shrinkType == MOD_SHRINKWRAP_PROJECT) {
198  }
199 
200  return false;
201 }
202 
203 static void panel_draw(const bContext *UNUSED(C), Panel *panel)
204 {
205  uiLayout *row, *col;
206  uiLayout *layout = panel->layout;
208 
209  PointerRNA ob_ptr;
211 
212  uiLayoutSetPropSep(layout, true);
213 
214  int wrap_method = RNA_enum_get(ptr, "wrap_method");
215 
216  uiItemR(layout, ptr, "wrap_method", 0, NULL, ICON_NONE);
217 
218  if (ELEM(wrap_method,
222  uiItemR(layout, ptr, "wrap_mode", 0, NULL, ICON_NONE);
223  }
224 
225  if (wrap_method == MOD_SHRINKWRAP_PROJECT) {
226  uiItemR(layout, ptr, "project_limit", 0, IFACE_("Limit"), ICON_NONE);
227  uiItemR(layout, ptr, "subsurf_levels", 0, NULL, ICON_NONE);
228 
229  col = uiLayoutColumn(layout, false);
230  row = uiLayoutRowWithHeading(col, true, IFACE_("Axis"));
231  uiItemR(row, ptr, "use_project_x", toggles_flag, NULL, ICON_NONE);
232  uiItemR(row, ptr, "use_project_y", toggles_flag, NULL, ICON_NONE);
233  uiItemR(row, ptr, "use_project_z", toggles_flag, NULL, ICON_NONE);
234 
235  uiItemR(col, ptr, "use_negative_direction", 0, NULL, ICON_NONE);
236  uiItemR(col, ptr, "use_positive_direction", 0, NULL, ICON_NONE);
237 
238  uiItemR(layout, ptr, "cull_face", UI_ITEM_R_EXPAND, NULL, ICON_NONE);
239  col = uiLayoutColumn(layout, false);
241  RNA_boolean_get(ptr, "use_negative_direction") &&
242  RNA_enum_get(ptr, "cull_face") != 0);
243  uiItemR(col, ptr, "use_invert_cull", 0, NULL, ICON_NONE);
244  }
245 
246  uiItemR(layout, ptr, "target", 0, NULL, ICON_NONE);
247  if (wrap_method == MOD_SHRINKWRAP_PROJECT) {
248  uiItemR(layout, ptr, "auxiliary_target", 0, NULL, ICON_NONE);
249  }
250  uiItemR(layout, ptr, "offset", 0, NULL, ICON_NONE);
251 
252  modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", NULL);
253 
254  modifier_panel_end(layout, ptr);
255 }
256 
257 static void panelRegister(ARegionType *region_type)
258 {
260 }
261 
263  /* name */ N_("Shrinkwrap"),
264  /* structName */ "ShrinkwrapModifierData",
265  /* structSize */ sizeof(ShrinkwrapModifierData),
266  /* srna */ &RNA_ShrinkwrapModifier,
267  /* type */ eModifierTypeType_OnlyDeform,
271  /* icon */ ICON_MOD_SHRINKWRAP,
272 
273  /* copyData */ BKE_modifier_copydata_generic,
274 
275  /* deformVerts */ deformVerts,
276  /* deformMatrices */ NULL,
277  /* deformVertsEM */ deformVertsEM,
278  /* deformMatricesEM */ NULL,
279  /* modifyMesh */ NULL,
280  /* modifyGeometrySet */ NULL,
281 
282  /* initData */ initData,
283  /* requiredDataMask */ requiredDataMask,
284  /* freeData */ NULL,
285  /* isDisabled */ isDisabled,
286  /* updateDepsgraph */ updateDepsgraph,
287  /* dependsOnTime */ NULL,
288  /* dependsOnNormals */ dependsOnNormals,
289  /* foreachIDLink */ foreachIDLink,
290  /* foreachTexLink */ NULL,
291  /* freeRuntimeData */ NULL,
292  /* panelRegister */ panelRegister,
293  /* blendWrite */ NULL,
294  /* blendRead */ NULL,
295 };
void BKE_id_free(struct Main *bmain, void *idv)
@ IDWALK_CB_NOP
Definition: BKE_lib_query.h:33
void BKE_mesh_wrapper_ensure_mdata(struct Mesh *me)
Definition: mesh_wrapper.cc:94
void(* IDWalkFunc)(void *userData, struct Object *ob, struct ID **idpoin, int cb_flag)
Definition: BKE_modifier.h:107
@ eModifierTypeFlag_AcceptsCVs
Definition: BKE_modifier.h:67
@ eModifierTypeFlag_EnableInEditmode
Definition: BKE_modifier.h:78
@ eModifierTypeFlag_SupportsEditmode
Definition: BKE_modifier.h:69
@ eModifierTypeFlag_AcceptsVertexCosOnly
Definition: BKE_modifier.h:100
@ eModifierTypeFlag_AcceptsMesh
Definition: BKE_modifier.h:66
void BKE_modifier_copydata_generic(const struct ModifierData *md, struct ModifierData *md_dst, int flag)
@ eModifierTypeType_OnlyDeform
Definition: BKE_modifier.h:44
bool BKE_shrinkwrap_needs_normals(int shrinkType, int shrinkMode)
Definition: shrinkwrap.c:90
void shrinkwrapModifier_deform(struct ShrinkwrapModifierData *smd, const struct ModifierEvalContext *ctx, struct Scene *scene, struct Object *ob, struct Mesh *mesh, struct MDeformVert *dvert, int defgrp_index, float(*vertexCos)[3], int numVerts)
#define BLI_assert(a)
Definition: BLI_assert.h:46
#define UNUSED(x)
#define ELEM(...)
#define MEMCMP_STRUCT_AFTER_IS_ZERO(struct_var, member)
#define MEMCPY_STRUCT_AFTER(struct_dst, struct_src, member)
#define IFACE_(msgid)
@ DAG_EVAL_NEED_SHRINKWRAP_BOUNDARY
Definition: DEG_depsgraph.h:57
void DEG_add_object_relation(struct DepsNodeHandle *node_handle, struct Object *object, eDepsObjectComponentType component, const char *description)
void DEG_add_modifier_to_transform_relation(struct DepsNodeHandle *node_handle, const char *description)
void DEG_add_customdata_mask(struct DepsNodeHandle *handle, struct Object *object, const struct CustomData_MeshMasks *masks)
@ DEG_OB_COMP_GEOMETRY
@ DEG_OB_COMP_TRANSFORM
void DEG_add_special_eval_flag(struct DepsNodeHandle *handle, struct ID *id, uint32_t flag)
struct Scene * DEG_get_evaluated_scene(const struct Depsgraph *graph)
#define CD_MASK_NORMAL
#define CD_MASK_MDEFORMVERT
#define CD_MASK_CUSTOMLOOPNORMAL
#define CD_MASK_MVERT
#define DNA_struct_default_get(struct_name)
Definition: DNA_defaults.h:29
struct ShrinkwrapModifierData ShrinkwrapModifierData
@ MOD_SHRINKWRAP_TARGET_PROJECT
@ MOD_SHRINKWRAP_PROJECT
@ MOD_SHRINKWRAP_NEAREST_SURFACE
@ eModifierType_Shrinkwrap
@ MOD_SHRINKWRAP_PROJECT_OVER_NORMAL
Object is a sort of wrapper for general info.
@ OB_LATTICE
@ OB_MESH
static void deformVerts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, float(*vertexCos)[3], int verts_num)
static void deformVertsEM(ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *editData, Mesh *mesh, float(*vertexCos)[3], int verts_num)
static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
static bool isDisabled(const struct Scene *UNUSED(scene), ModifierData *md, bool UNUSED(useRenderParams))
static bool dependsOnNormals(ModifierData *md)
ModifierTypeInfo modifierType_Shrinkwrap
static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
static void panel_draw(const bContext *UNUSED(C), Panel *panel)
static void initData(ModifierData *md)
static void panelRegister(ARegionType *region_type)
static void requiredDataMask(Object *UNUSED(ob), ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void modifier_panel_end(uiLayout *layout, PointerRNA *ptr)
Definition: MOD_ui_common.c:91
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
void modifier_vgroup_ui(uiLayout *layout, PointerRNA *ptr, PointerRNA *ob_ptr, const char *vgroup_prop, const char *invert_vgroup_prop, const char *text)
Mesh * MOD_deform_mesh_eval_get(Object *ob, struct BMEditMesh *em, Mesh *mesh, const float(*vertexCos)[3], const int verts_num, const bool use_normals, const bool use_orco)
Definition: MOD_util.c:167
void MOD_get_vgroup(Object *ob, struct Mesh *mesh, const char *name, MDeformVert **dvert, int *defgrp_index)
Definition: MOD_util.c:235
#define C
Definition: RandGen.cpp:25
uiLayout * uiLayoutRowWithHeading(uiLayout *layout, bool align, const char *heading)
void uiLayoutSetActive(uiLayout *layout, bool active)
uiLayout * uiLayoutColumn(uiLayout *layout, bool align)
void uiLayoutSetPropSep(uiLayout *layout, bool is_sep)
@ UI_ITEM_R_TOGGLE
@ UI_ITEM_R_FORCE_BLANK_DECORATE
@ UI_ITEM_R_EXPAND
void uiItemR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int flag, const char *name, int icon)
Scene scene
uint col
ccl_device_inline float4 mask(const int4 &mask, const float4 &a)
Definition: math_float4.h:513
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
Definition: rna_access.c:4863
int RNA_enum_get(PointerRNA *ptr, const char *name)
Definition: rna_access.c:5004
Definition: DNA_ID.h:368
struct Depsgraph * depsgraph
Definition: BKE_modifier.h:140
struct Object * object
Definition: BKE_modifier.h:141
struct DepsNodeHandle * node
Definition: BKE_modifier.h:134
struct uiLayout * layout
#define N_(msgid)
PointerRNA * ptr
Definition: wm_files.c:3480