Cleanup: style, use braces for gpencil modifiers
[blender.git] / source / blender / gpencil_modifiers / intern / MOD_gpencilhook.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software  Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2017, Blender Foundation
17  * This is a new part of Blender
18  */
19
20 /** \file
21  * \ingroup modifiers
22  */
23
24 #include <stdio.h>
25
26 #include "BLI_utildefines.h"
27
28 #include "BLI_math.h"
29
30 #include "DNA_meshdata_types.h"
31 #include "DNA_scene_types.h"
32 #include "DNA_object_types.h"
33 #include "DNA_gpencil_types.h"
34 #include "DNA_gpencil_modifier_types.h"
35 #include "DNA_modifier_types.h"
36
37 #include "BKE_action.h"
38 #include "BKE_colortools.h"
39 #include "BKE_deform.h"
40 #include "BKE_gpencil.h"
41 #include "BKE_gpencil_modifier.h"
42 #include "BKE_modifier.h"
43 #include "BKE_library_query.h"
44 #include "BKE_scene.h"
45 #include "BKE_main.h"
46 #include "BKE_layer.h"
47
48 #include "MEM_guardedalloc.h"
49
50 #include "MOD_gpencil_util.h"
51 #include "MOD_gpencil_modifiertypes.h"
52
53 #include "DEG_depsgraph.h"
54 #include "DEG_depsgraph_build.h"
55 #include "DEG_depsgraph_query.h"
56
57 /* temp struct to hold data */
58 struct GPHookData_cb {
59   struct CurveMapping *curfalloff;
60
61   char falloff_type;
62   float falloff;
63   float falloff_sq;
64   float fac_orig;
65
66   unsigned int use_falloff : 1;
67   unsigned int use_uniform : 1;
68
69   float cent[3];
70
71   float mat_uniform[3][3];
72   float mat[4][4];
73 };
74
75 static void initData(GpencilModifierData *md)
76 {
77   HookGpencilModifierData *gpmd = (HookGpencilModifierData *)md;
78   gpmd->pass_index = 0;
79   gpmd->layername[0] = '\0';
80   gpmd->vgname[0] = '\0';
81   gpmd->object = NULL;
82   gpmd->force = 0.5f;
83   gpmd->falloff_type = eGPHook_Falloff_Smooth;
84   gpmd->curfalloff = curvemapping_add(1, 0.0f, 0.0f, 1.0f, 1.0f);
85   if (gpmd->curfalloff) {
86     curvemapping_initialize(gpmd->curfalloff);
87   }
88 }
89
90 static void copyData(const GpencilModifierData *md, GpencilModifierData *target)
91 {
92   HookGpencilModifierData *gmd = (HookGpencilModifierData *)md;
93   HookGpencilModifierData *tgmd = (HookGpencilModifierData *)target;
94
95   if (tgmd->curfalloff != NULL) {
96     curvemapping_free(tgmd->curfalloff);
97     tgmd->curfalloff = NULL;
98   }
99
100   BKE_gpencil_modifier_copyData_generic(md, target);
101
102   tgmd->curfalloff = curvemapping_copy(gmd->curfalloff);
103 }
104
105 /* calculate factor of fallof */
106 static float gp_hook_falloff(const struct GPHookData_cb *tData, const float len_sq)
107 {
108   BLI_assert(tData->falloff_sq);
109   if (len_sq > tData->falloff_sq) {
110     return 0.0f;
111   }
112   else if (len_sq > 0.0f) {
113     float fac;
114
115     if (tData->falloff_type == eGPHook_Falloff_Const) {
116       fac = 1.0f;
117       goto finally;
118     }
119     else if (tData->falloff_type == eGPHook_Falloff_InvSquare) {
120       /* avoid sqrt below */
121       fac = 1.0f - (len_sq / tData->falloff_sq);
122       goto finally;
123     }
124
125     fac = 1.0f - (sqrtf(len_sq) / tData->falloff);
126
127     switch (tData->falloff_type) {
128       case eGPHook_Falloff_Curve:
129         fac = curvemapping_evaluateF(tData->curfalloff, 0, fac);
130         break;
131       case eGPHook_Falloff_Sharp:
132         fac = fac * fac;
133         break;
134       case eGPHook_Falloff_Smooth:
135         fac = 3.0f * fac * fac - 2.0f * fac * fac * fac;
136         break;
137       case eGPHook_Falloff_Root:
138         fac = sqrtf(fac);
139         break;
140       case eGPHook_Falloff_Linear:
141         /* pass */
142         break;
143       case eGPHook_Falloff_Sphere:
144         fac = sqrtf(2 * fac - fac * fac);
145         break;
146       default:
147         break;
148     }
149
150   finally:
151     return fac * tData->fac_orig;
152   }
153   else {
154     return tData->fac_orig;
155   }
156 }
157
158 /* apply point deformation */
159 static void gp_hook_co_apply(struct GPHookData_cb *tData, float weight, bGPDspoint *pt)
160 {
161   float fac;
162
163   if (tData->use_falloff) {
164     float len_sq;
165
166     if (tData->use_uniform) {
167       float co_uniform[3];
168       mul_v3_m3v3(co_uniform, tData->mat_uniform, &pt->x);
169       len_sq = len_squared_v3v3(tData->cent, co_uniform);
170     }
171     else {
172       len_sq = len_squared_v3v3(tData->cent, &pt->x);
173     }
174
175     fac = gp_hook_falloff(tData, len_sq);
176   }
177   else {
178     fac = tData->fac_orig;
179   }
180
181   if (fac) {
182     float co_tmp[3];
183     mul_v3_m4v3(co_tmp, tData->mat, &pt->x);
184     interp_v3_v3v3(&pt->x, &pt->x, co_tmp, fac * weight);
185   }
186 }
187
188 /* deform stroke */
189 static void deformStroke(GpencilModifierData *md,
190                          Depsgraph *UNUSED(depsgraph),
191                          Object *ob,
192                          bGPDlayer *gpl,
193                          bGPDstroke *gps)
194 {
195   HookGpencilModifierData *mmd = (HookGpencilModifierData *)md;
196   if (!mmd->object) {
197     return;
198   }
199
200   const int def_nr = defgroup_name_index(ob, mmd->vgname);
201
202   bPoseChannel *pchan = BKE_pose_channel_find_name(mmd->object->pose, mmd->subtarget);
203   float dmat[4][4];
204   struct GPHookData_cb tData;
205
206   if (!is_stroke_affected_by_modifier(ob,
207                                       mmd->layername,
208                                       mmd->pass_index,
209                                       mmd->layer_pass,
210                                       1,
211                                       gpl,
212                                       gps,
213                                       mmd->flag & GP_HOOK_INVERT_LAYER,
214                                       mmd->flag & GP_HOOK_INVERT_PASS,
215                                       mmd->flag & GP_HOOK_INVERT_LAYERPASS)) {
216     return;
217   }
218
219   /* init struct */
220   tData.curfalloff = mmd->curfalloff;
221   tData.falloff_type = mmd->falloff_type;
222   tData.falloff = (mmd->falloff_type == eHook_Falloff_None) ? 0.0f : mmd->falloff;
223   tData.falloff_sq = SQUARE(tData.falloff);
224   tData.fac_orig = mmd->force;
225   tData.use_falloff = (tData.falloff_sq != 0.0f);
226   tData.use_uniform = (mmd->flag & GP_HOOK_UNIFORM_SPACE) != 0;
227
228   if (tData.use_uniform) {
229     copy_m3_m4(tData.mat_uniform, mmd->parentinv);
230     mul_v3_m3v3(tData.cent, tData.mat_uniform, mmd->cent);
231   }
232   else {
233     unit_m3(tData.mat_uniform);
234     copy_v3_v3(tData.cent, mmd->cent);
235   }
236
237   /* get world-space matrix of target, corrected for the space the verts are in */
238   if (mmd->subtarget[0] && pchan) {
239     /* bone target if there's a matching pose-channel */
240     mul_m4_m4m4(dmat, mmd->object->obmat, pchan->pose_mat);
241   }
242   else {
243     /* just object target */
244     copy_m4_m4(dmat, mmd->object->obmat);
245   }
246   invert_m4_m4(ob->imat, ob->obmat);
247   mul_m4_series(tData.mat, ob->imat, dmat, mmd->parentinv);
248
249   /* loop points and apply deform */
250   for (int i = 0; i < gps->totpoints; i++) {
251     bGPDspoint *pt = &gps->points[i];
252     MDeformVert *dvert = gps->dvert != NULL ? &gps->dvert[i] : NULL;
253
254     /* verify vertex group */
255     const float weight = get_modifier_point_weight(
256         dvert, (mmd->flag & GP_HOOK_INVERT_VGROUP) != 0, def_nr);
257     if (weight < 0.0f) {
258       continue;
259     }
260     gp_hook_co_apply(&tData, weight, pt);
261   }
262 }
263
264 /* FIXME: Ideally we be doing this on a copy of the main depsgraph
265  * (i.e. one where we don't have to worry about restoring state)
266  */
267 static void bakeModifier(Main *bmain, Depsgraph *depsgraph, GpencilModifierData *md, Object *ob)
268 {
269   HookGpencilModifierData *mmd = (HookGpencilModifierData *)md;
270   Scene *scene = DEG_get_evaluated_scene(depsgraph);
271   bGPdata *gpd = ob->data;
272   int oldframe = (int)DEG_get_ctime(depsgraph);
273
274   if (mmd->object == NULL) {
275     return;
276   }
277
278   for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
279     for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
280       /* apply hook effects on this frame
281        * NOTE: this assumes that we don't want hook animation on non-keyframed frames
282        */
283       CFRA = gpf->framenum;
284       BKE_scene_graph_update_for_newframe(depsgraph, bmain);
285
286       /* compute hook effects on this frame */
287       for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
288         deformStroke(md, depsgraph, ob, gpl, gps);
289       }
290     }
291   }
292
293   /* return frame state and DB to original state */
294   CFRA = oldframe;
295   BKE_scene_graph_update_for_newframe(depsgraph, bmain);
296 }
297
298 static void freeData(GpencilModifierData *md)
299 {
300   HookGpencilModifierData *mmd = (HookGpencilModifierData *)md;
301
302   if (mmd->curfalloff) {
303     curvemapping_free(mmd->curfalloff);
304   }
305 }
306
307 static bool isDisabled(GpencilModifierData *md, int UNUSED(userRenderParams))
308 {
309   HookGpencilModifierData *mmd = (HookGpencilModifierData *)md;
310
311   return !mmd->object;
312 }
313
314 static void updateDepsgraph(GpencilModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
315 {
316   HookGpencilModifierData *lmd = (HookGpencilModifierData *)md;
317   if (lmd->object != NULL) {
318     DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_GEOMETRY, "Hook Modifier");
319     DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_TRANSFORM, "Hook Modifier");
320   }
321   DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "Hook Modifier");
322 }
323
324 static void foreachObjectLink(GpencilModifierData *md,
325                               Object *ob,
326                               ObjectWalkFunc walk,
327                               void *userData)
328 {
329   HookGpencilModifierData *mmd = (HookGpencilModifierData *)md;
330
331   walk(userData, ob, &mmd->object, IDWALK_CB_NOP);
332 }
333
334 GpencilModifierTypeInfo modifierType_Gpencil_Hook = {
335     /* name */ "Hook",
336     /* structName */ "HookGpencilModifierData",
337     /* structSize */ sizeof(HookGpencilModifierData),
338     /* type */ eGpencilModifierTypeType_Gpencil,
339     /* flags */ eGpencilModifierTypeFlag_SupportsEditmode,
340
341     /* copyData */ copyData,
342
343     /* deformStroke */ deformStroke,
344     /* generateStrokes */ NULL,
345     /* bakeModifier */ bakeModifier,
346     /* remapTime */ NULL,
347
348     /* initData */ initData,
349     /* freeData */ freeData,
350     /* isDisabled */ isDisabled,
351     /* updateDepsgraph */ updateDepsgraph,
352     /* dependsOnTime */ NULL,
353     /* foreachObjectLink */ foreachObjectLink,
354     /* foreachIDLink */ NULL,
355     /* foreachTexLink */ NULL,
356     /* getDuplicationFactor */ NULL,
357 };