Blender  V3.3
MOD_gpencilshrinkwrap.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later
2  * Copyright 2017 Blender Foundation. */
3 
8 #include <stdio.h>
9 #include <string.h> /* For #MEMCPY_STRUCT_AFTER. */
10 
11 #include "BLI_listbase.h"
12 #include "BLI_math_vector.h"
13 #include "BLI_utildefines.h"
14 
15 #include "BLT_translation.h"
16 
17 #include "DNA_defaults.h"
19 #include "DNA_gpencil_types.h"
20 #include "DNA_mesh_types.h"
21 #include "DNA_object_types.h"
22 #include "DNA_scene_types.h"
23 #include "DNA_screen_types.h"
24 
25 #include "BKE_context.h"
26 #include "BKE_deform.h"
27 #include "BKE_gpencil_geom.h"
28 #include "BKE_gpencil_modifier.h"
29 #include "BKE_lib_query.h"
30 #include "BKE_main.h"
31 #include "BKE_modifier.h"
32 #include "BKE_scene.h"
33 #include "BKE_screen.h"
34 #include "BKE_shrinkwrap.h"
35 
36 #include "MEM_guardedalloc.h"
37 
38 #include "UI_interface.h"
39 #include "UI_resources.h"
40 
41 #include "RNA_access.h"
42 
44 #include "MOD_gpencil_ui_common.h"
45 #include "MOD_gpencil_util.h"
46 
47 #include "DEG_depsgraph.h"
48 #include "DEG_depsgraph_build.h"
49 #include "DEG_depsgraph_query.h"
50 
51 static void initData(GpencilModifierData *md)
52 {
54 
55  BLI_assert(MEMCMP_STRUCT_AFTER_IS_ZERO(gpmd, modifier));
56 
58 }
59 
60 static void copyData(const GpencilModifierData *md, GpencilModifierData *target)
61 {
63 }
64 
67  Object *ob,
68  bGPDlayer *gpl,
69  bGPDframe *UNUSED(gpf),
70  bGPDstroke *gps)
71 {
72  bGPdata *gpd = ob->data;
74  const int def_nr = BKE_object_defgroup_name_index(ob, mmd->vgname);
75 
77  mmd->layername,
78  mmd->material,
79  mmd->pass_index,
80  mmd->layer_pass,
81  1,
82  gpl,
83  gps,
88  return;
89  }
90 
91  if ((mmd->cache_data == NULL) || (mmd->target == ob) || (mmd->aux_target == ob)) {
92  return;
93  }
94 
95  bGPDspoint *pt = gps->points;
96  float(*vert_coords)[3] = MEM_mallocN(sizeof(float[3]) * gps->totpoints, __func__);
97  int i;
98  /* Prepare array of points. */
99  for (i = 0; i < gps->totpoints; i++, pt++) {
100  copy_v3_v3(vert_coords[i], &pt->x);
101  }
102 
103  shrinkwrapGpencilModifier_deform(mmd, ob, gps->dvert, def_nr, vert_coords, gps->totpoints);
104 
105  /* Apply deformed coordinates. */
106  pt = gps->points;
107  for (i = 0; i < gps->totpoints; i++, pt++) {
108  copy_v3_v3(&pt->x, vert_coords[i]);
109  }
110 
111  MEM_freeN(vert_coords);
112 
113  /* Smooth stroke. */
115  gps, mmd->smooth_factor, mmd->smooth_step, true, false, false, false, true, NULL);
116 
117  /* Calc geometry data. */
119 }
120 
121 static void bakeModifier(Main *UNUSED(bmain),
124  Object *ob)
125 {
128  bGPdata *gpd = ob->data;
129  int oldframe = (int)DEG_get_ctime(depsgraph);
130 
131  if ((mmd->target == ob) || (mmd->aux_target == ob)) {
132  return;
133  }
134 
135  LISTBASE_FOREACH (bGPDlayer *, gpl, &gpd->layers) {
136  LISTBASE_FOREACH (bGPDframe *, gpf, &gpl->frames) {
137  /* Apply shrinkwrap effects on this frame. */
138  scene->r.cfra = gpf->framenum;
140 
141  /* Recalculate shrinkwrap data. */
142  if (mmd->cache_data) {
145  }
146  Object *ob_target = DEG_get_evaluated_object(depsgraph, mmd->target);
148  mmd->cache_data = MEM_callocN(sizeof(ShrinkwrapTreeData), __func__);
150  mmd->cache_data, target, mmd->shrink_type, mmd->shrink_mode, false)) {
151 
152  /* Compute shrinkwrap effects on this frame. */
153  LISTBASE_FOREACH (bGPDstroke *, gps, &gpf->strokes) {
154  deformStroke(md, depsgraph, ob, gpl, gpf, gps);
155  }
156  }
157  /* Free data. */
158  if (mmd->cache_data) {
161  }
162  }
163  }
164 
165  /* Return frame state and DB to original state. */
166  scene->r.cfra = oldframe;
168 }
169 
171 {
173  if (mmd->cache_data) {
176  }
177 }
178 
179 static bool isDisabled(GpencilModifierData *md, int UNUSED(userRenderParams))
180 {
182 
183  /* The object type check is only needed here in case we have a placeholder
184  * object assigned (because the library containing the mesh is missing).
185  *
186  * In other cases it should be impossible to have a type mismatch.
187  */
188  if (!mmd->target || mmd->target->type != OB_MESH) {
189  return true;
190  }
191  if (mmd->aux_target && mmd->aux_target->type != OB_MESH) {
192  return true;
193  }
194  return false;
195 }
196 
199  const int UNUSED(mode))
200 {
203 
205  mask.vmask |= CD_MASK_NORMAL;
207  }
208 
209  if (mmd->target != NULL) {
210  DEG_add_object_relation(ctx->node, mmd->target, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
211  DEG_add_object_relation(ctx->node, mmd->target, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
212  DEG_add_customdata_mask(ctx->node, mmd->target, &mask);
215  }
216  }
217  if (mmd->aux_target != NULL) {
219  ctx->node, mmd->aux_target, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
221  ctx->node, mmd->aux_target, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
226  }
227  }
228  DEG_add_modifier_to_transform_relation(ctx->node, "Shrinkwrap Modifier");
229 }
230 
231 static void foreachIDLink(GpencilModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
232 {
234 
235  walk(userData, ob, (ID **)&mmd->target, IDWALK_CB_NOP);
236  walk(userData, ob, (ID **)&mmd->aux_target, IDWALK_CB_NOP);
237  walk(userData, ob, (ID **)&mmd->material, IDWALK_CB_USER);
238 }
239 
240 static void panel_draw(const bContext *UNUSED(C), Panel *panel)
241 {
242  uiLayout *row, *col;
243  uiLayout *layout = panel->layout;
245 
247 
248  uiLayoutSetPropSep(layout, true);
249 
250  int wrap_method = RNA_enum_get(ptr, "wrap_method");
251 
252  uiItemR(layout, ptr, "wrap_method", 0, NULL, ICON_NONE);
253 
254  if (ELEM(wrap_method,
258  uiItemR(layout, ptr, "wrap_mode", 0, NULL, ICON_NONE);
259  }
260 
261  if (wrap_method == MOD_SHRINKWRAP_PROJECT) {
262  uiItemR(layout, ptr, "project_limit", 0, IFACE_("Limit"), ICON_NONE);
263  uiItemR(layout, ptr, "subsurf_levels", 0, NULL, ICON_NONE);
264 
265  col = uiLayoutColumn(layout, false);
266  row = uiLayoutRowWithHeading(col, true, IFACE_("Axis"));
267  uiItemR(row, ptr, "use_project_x", toggles_flag, NULL, ICON_NONE);
268  uiItemR(row, ptr, "use_project_y", toggles_flag, NULL, ICON_NONE);
269  uiItemR(row, ptr, "use_project_z", toggles_flag, NULL, ICON_NONE);
270 
271  uiItemR(col, ptr, "use_negative_direction", 0, NULL, ICON_NONE);
272  uiItemR(col, ptr, "use_positive_direction", 0, NULL, ICON_NONE);
273 
274  uiItemR(layout, ptr, "cull_face", UI_ITEM_R_EXPAND, NULL, ICON_NONE);
275  col = uiLayoutColumn(layout, false);
277  RNA_boolean_get(ptr, "use_negative_direction") &&
278  RNA_enum_get(ptr, "cull_face") != 0);
279  uiItemR(col, ptr, "use_invert_cull", 0, NULL, ICON_NONE);
280  }
281 
282  uiItemR(layout, ptr, "target", 0, NULL, ICON_NONE);
283  if (wrap_method == MOD_SHRINKWRAP_PROJECT) {
284  uiItemR(layout, ptr, "auxiliary_target", 0, NULL, ICON_NONE);
285  }
286  uiItemR(layout, ptr, "offset", 0, NULL, ICON_NONE);
287 
288  uiLayoutSetPropSep(layout, true);
289 
290  uiItemR(layout, ptr, "smooth_factor", 0, NULL, ICON_NONE);
291  uiItemR(layout, ptr, "smooth_step", 0, IFACE_("Repeat"), ICON_NONE);
292 
294 }
295 
296 static void mask_panel_draw(const bContext *UNUSED(C), Panel *panel)
297 {
298  gpencil_modifier_masking_panel_draw(panel, true, true);
299 }
300 
301 static void panelRegister(ARegionType *region_type)
302 {
306  region_type, "mask", "Influence", NULL, mask_panel_draw, panel_type);
307 }
308 
310  /* name */ N_("Shrinkwrap"),
311  /* structName */ "ShrinkwrapGpencilModifierData",
312  /* structSize */ sizeof(ShrinkwrapGpencilModifierData),
315 
316  /* copyData */ copyData,
317 
318  /* deformStroke */ deformStroke,
319  /* generateStrokes */ NULL,
320  /* bakeModifier */ bakeModifier,
321  /* remapTime */ NULL,
322 
323  /* initData */ initData,
324  /* freeData */ freeData,
325  /* isDisabled */ isDisabled,
326  /* updateDepsgraph */ updateDepsgraph,
327  /* dependsOnTime */ NULL,
328  /* foreachIDLink */ foreachIDLink,
329  /* foreachTexLink */ NULL,
330  /* panelRegister */ panelRegister,
331 };
typedef float(TangentPoint)[2]
support for deformation groups and hooks.
int BKE_object_defgroup_name_index(const struct Object *ob, const char *name)
void BKE_gpencil_stroke_geometry_update(struct bGPdata *gpd, struct bGPDstroke *gps)
void BKE_gpencil_stroke_smooth(struct bGPDstroke *gps, const float influence, const int iterations, const bool smooth_position, const bool smooth_strength, const bool smooth_thickness, const bool smooth_uv, const bool keep_shape, const float *weights)
void BKE_gpencil_modifier_copydata_generic(const struct GpencilModifierData *md_src, struct GpencilModifierData *md_dst)
@ eGpencilModifierTypeFlag_SupportsEditmode
@ eGpencilModifierTypeType_Gpencil
@ IDWALK_CB_USER
Definition: BKE_lib_query.h:73
@ IDWALK_CB_NOP
Definition: BKE_lib_query.h:33
void(* IDWalkFunc)(void *userData, struct Object *ob, struct ID **idpoin, int cb_flag)
Definition: BKE_modifier.h:107
struct Mesh * BKE_modifier_get_evaluated_mesh_from_evaluated_object(struct Object *ob_eval)
void BKE_scene_graph_update_for_newframe(struct Depsgraph *depsgraph)
Definition: scene.cc:2728
bool BKE_shrinkwrap_needs_normals(int shrinkType, int shrinkMode)
Definition: shrinkwrap.c:90
bool BKE_shrinkwrap_init_tree(struct ShrinkwrapTreeData *data, Mesh *mesh, int shrinkType, int shrinkMode, bool force_normals)
Definition: shrinkwrap.c:97
void BKE_shrinkwrap_free_tree(struct ShrinkwrapTreeData *data)
Definition: shrinkwrap.c:147
void shrinkwrapGpencilModifier_deform(struct ShrinkwrapGpencilModifierData *mmd, struct Object *ob, struct MDeformVert *dvert, int defgrp_index, float(*vertexCos)[3], int numVerts)
Definition: shrinkwrap.c:1476
#define BLI_assert(a)
Definition: BLI_assert.h:46
#define LISTBASE_FOREACH(type, var, list)
Definition: BLI_listbase.h:336
MINLINE void copy_v3_v3(float r[3], const float a[3])
#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)
struct Depsgraph Depsgraph
Definition: DEG_depsgraph.h:35
@ 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)
float DEG_get_ctime(const Depsgraph *graph)
struct Object * DEG_get_evaluated_object(const struct Depsgraph *depsgraph, struct Object *object)
struct Scene * DEG_get_evaluated_scene(const struct Depsgraph *graph)
#define CD_MASK_NORMAL
#define CD_MASK_CUSTOMLOOPNORMAL
#define DNA_struct_default_get(struct_name)
Definition: DNA_defaults.h:29
struct ShrinkwrapGpencilModifierData ShrinkwrapGpencilModifierData
@ GP_SHRINKWRAP_INVERT_LAYER
@ GP_SHRINKWRAP_INVERT_LAYERPASS
@ GP_SHRINKWRAP_INVERT_PASS
@ GP_SHRINKWRAP_INVERT_MATERIAL
@ eGpencilModifierType_Shrinkwrap
@ MOD_SHRINKWRAP_TARGET_PROJECT
@ MOD_SHRINKWRAP_PROJECT
@ MOD_SHRINKWRAP_NEAREST_SURFACE
Object is a sort of wrapper for general info.
@ OB_MESH
Read Guarded memory(de)allocation.
#define MEM_SAFE_FREE(v)
PointerRNA * gpencil_modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void gpencil_modifier_masking_panel_draw(Panel *panel, bool use_material, bool use_vertex)
void gpencil_modifier_panel_end(uiLayout *layout, PointerRNA *ptr)
PanelType * gpencil_modifier_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
PanelType * gpencil_modifier_panel_register(ARegionType *region_type, GpencilModifierType type, PanelDrawFn draw)
bool is_stroke_affected_by_modifier(Object *ob, char *mlayername, Material *material, const int mpassindex, const int gpl_passindex, const int minpoints, bGPDlayer *gpl, bGPDstroke *gps, const bool inv1, const bool inv2, const bool inv3, const bool inv4)
static void deformStroke(GpencilModifierData *md, Depsgraph *UNUSED(depsgraph), Object *ob, bGPDlayer *gpl, bGPDframe *UNUSED(gpf), bGPDstroke *gps)
static bool isDisabled(GpencilModifierData *md, int UNUSED(userRenderParams))
static void freeData(GpencilModifierData *md)
GpencilModifierTypeInfo modifierType_Gpencil_Shrinkwrap
static void updateDepsgraph(GpencilModifierData *md, const ModifierUpdateDepsgraphContext *ctx, const int UNUSED(mode))
static void mask_panel_draw(const bContext *UNUSED(C), Panel *panel)
static void foreachIDLink(GpencilModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
static void bakeModifier(Main *UNUSED(bmain), Depsgraph *depsgraph, GpencilModifierData *md, Object *ob)
static void copyData(const GpencilModifierData *md, GpencilModifierData *target)
static void panel_draw(const bContext *UNUSED(C), Panel *panel)
static void panelRegister(ARegionType *region_type)
static void initData(GpencilModifierData *md)
#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
const Depsgraph * depsgraph
uint col
void(* MEM_freeN)(void *vmemh)
Definition: mallocn.c:27
void *(* MEM_callocN)(size_t len, const char *str)
Definition: mallocn.c:31
void *(* MEM_mallocN)(size_t len, const char *str)
Definition: mallocn.c:33
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
Definition: BKE_main.h:121
struct DepsNodeHandle * node
Definition: BKE_modifier.h:134
void * data
struct uiLayout * layout
struct RenderData r
struct ShrinkwrapTreeData * cache_data
ListBase frames
bGPDspoint * points
struct MDeformVert * dvert
ListBase layers
#define N_(msgid)
PointerRNA * ptr
Definition: wm_files.c:3480