Cleanup: style, use braces for gpencil modifiers
[blender.git] / source / blender / gpencil_modifiers / intern / MOD_gpencillattice.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 "DNA_meshdata_types.h"
29 #include "DNA_scene_types.h"
30 #include "DNA_object_types.h"
31 #include "DNA_gpencil_types.h"
32 #include "DNA_gpencil_modifier_types.h"
33
34 #include "BKE_deform.h"
35 #include "BKE_gpencil.h"
36 #include "BKE_gpencil_modifier.h"
37 #include "BKE_modifier.h"
38 #include "BKE_lattice.h"
39 #include "BKE_library_query.h"
40 #include "BKE_scene.h"
41 #include "BKE_main.h"
42 #include "BKE_layer.h"
43
44 #include "MEM_guardedalloc.h"
45
46 #include "MOD_gpencil_util.h"
47 #include "MOD_gpencil_modifiertypes.h"
48
49 #include "DEG_depsgraph.h"
50 #include "DEG_depsgraph_build.h"
51 #include "DEG_depsgraph_query.h"
52
53 static void initData(GpencilModifierData *md)
54 {
55   LatticeGpencilModifierData *gpmd = (LatticeGpencilModifierData *)md;
56   gpmd->pass_index = 0;
57   gpmd->layername[0] = '\0';
58   gpmd->vgname[0] = '\0';
59   gpmd->object = NULL;
60   gpmd->cache_data = NULL;
61   gpmd->strength = 1.0f;
62 }
63
64 static void copyData(const GpencilModifierData *md, GpencilModifierData *target)
65 {
66   BKE_gpencil_modifier_copyData_generic(md, target);
67 }
68
69 static void deformStroke(GpencilModifierData *md,
70                          Depsgraph *UNUSED(depsgraph),
71                          Object *ob,
72                          bGPDlayer *gpl,
73                          bGPDstroke *gps)
74 {
75   LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
76   const int def_nr = defgroup_name_index(ob, mmd->vgname);
77
78   if (!is_stroke_affected_by_modifier(ob,
79                                       mmd->layername,
80                                       mmd->pass_index,
81                                       mmd->layer_pass,
82                                       1,
83                                       gpl,
84                                       gps,
85                                       mmd->flag & GP_LATTICE_INVERT_LAYER,
86                                       mmd->flag & GP_LATTICE_INVERT_PASS,
87                                       mmd->flag & GP_LATTICE_INVERT_LAYERPASS)) {
88     return;
89   }
90
91   if (mmd->cache_data == NULL) {
92     return;
93   }
94
95   for (int i = 0; i < gps->totpoints; i++) {
96     bGPDspoint *pt = &gps->points[i];
97     MDeformVert *dvert = gps->dvert != NULL ? &gps->dvert[i] : NULL;
98
99     /* verify vertex group */
100     const float weight = get_modifier_point_weight(
101         dvert, (mmd->flag & GP_LATTICE_INVERT_VGROUP) != 0, def_nr);
102     if (weight < 0.0f) {
103       continue;
104     }
105     calc_latt_deform((struct LatticeDeformData *)mmd->cache_data, &pt->x, mmd->strength * weight);
106   }
107 }
108
109 /* FIXME: Ideally we be doing this on a copy of the main depsgraph
110  * (i.e. one where we don't have to worry about restoring state)
111  */
112 static void bakeModifier(Main *bmain, Depsgraph *depsgraph, GpencilModifierData *md, Object *ob)
113 {
114   LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
115   Scene *scene = DEG_get_evaluated_scene(depsgraph);
116   struct LatticeDeformData *ldata = NULL;
117   bGPdata *gpd = ob->data;
118   int oldframe = (int)DEG_get_ctime(depsgraph);
119
120   if (mmd->object == NULL) {
121     return;
122   }
123
124   for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
125     for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
126       /* apply lattice effects on this frame
127        * NOTE: this assumes that we don't want lattice animation on non-keyframed frames
128        */
129       CFRA = gpf->framenum;
130       BKE_scene_graph_update_for_newframe(depsgraph, bmain);
131
132       /* recalculate lattice data */
133       BKE_gpencil_lattice_init(ob);
134
135       /* compute lattice effects on this frame */
136       for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
137         deformStroke(md, depsgraph, ob, gpl, gps);
138       }
139     }
140   }
141
142   /* free lingering data */
143   ldata = (struct LatticeDeformData *)mmd->cache_data;
144   if (ldata) {
145     end_latt_deform(ldata);
146     mmd->cache_data = NULL;
147   }
148
149   /* return frame state and DB to original state */
150   CFRA = oldframe;
151   BKE_scene_graph_update_for_newframe(depsgraph, bmain);
152 }
153
154 static void freeData(GpencilModifierData *md)
155 {
156   LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
157   struct LatticeDeformData *ldata = (struct LatticeDeformData *)mmd->cache_data;
158   /* free deform data */
159   if (ldata) {
160     end_latt_deform(ldata);
161   }
162 }
163
164 static bool isDisabled(GpencilModifierData *md, int UNUSED(userRenderParams))
165 {
166   LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
167
168   return !mmd->object;
169 }
170
171 static void updateDepsgraph(GpencilModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
172 {
173   LatticeGpencilModifierData *lmd = (LatticeGpencilModifierData *)md;
174   if (lmd->object != NULL) {
175     DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_GEOMETRY, "Lattice Modifier");
176     DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_TRANSFORM, "Lattice Modifier");
177   }
178   DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "Lattice Modifier");
179 }
180
181 static void foreachObjectLink(GpencilModifierData *md,
182                               Object *ob,
183                               ObjectWalkFunc walk,
184                               void *userData)
185 {
186   LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
187
188   walk(userData, ob, &mmd->object, IDWALK_CB_NOP);
189 }
190
191 GpencilModifierTypeInfo modifierType_Gpencil_Lattice = {
192     /* name */ "Lattice",
193     /* structName */ "LatticeGpencilModifierData",
194     /* structSize */ sizeof(LatticeGpencilModifierData),
195     /* type */ eGpencilModifierTypeType_Gpencil,
196     /* flags */ eGpencilModifierTypeFlag_Single | eGpencilModifierTypeFlag_SupportsEditmode,
197
198     /* copyData */ copyData,
199
200     /* deformStroke */ deformStroke,
201     /* generateStrokes */ NULL,
202     /* bakeModifier */ bakeModifier,
203     /* remapTime */ NULL,
204
205     /* initData */ initData,
206     /* freeData */ freeData,
207     /* isDisabled */ isDisabled,
208     /* updateDepsgraph */ updateDepsgraph,
209     /* dependsOnTime */ NULL,
210     /* foreachObjectLink */ foreachObjectLink,
211     /* foreachIDLink */ NULL,
212     /* foreachTexLink */ NULL,
213     /* getDuplicationFactor */ NULL,
214 };