d9ec81b70b9b2a2c62802c743a8470463809ebad
[blender.git] / source / blender / gpencil_modifiers / intern / MOD_gpencillattice.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2017, Blender Foundation
19  * This is a new part of Blender
20  *
21  * Contributor(s): Antonio Vazquez
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  */
26
27 /** \file blender/gpencil_modifiers/intern/MOD_gpencillattice.c
28  *  \ingroup modifiers
29  */
30
31 #include <stdio.h>
32
33 #include "DNA_meshdata_types.h"
34 #include "DNA_scene_types.h"
35 #include "DNA_object_types.h"
36 #include "DNA_gpencil_types.h"
37 #include "DNA_gpencil_modifier_types.h"
38
39 #include "BLI_utildefines.h"
40
41 #include "BKE_context.h"
42 #include "BKE_deform.h"
43 #include "BKE_gpencil.h"
44 #include "BKE_gpencil_modifier.h"
45 #include "BKE_modifier.h"
46 #include "BKE_lattice.h"
47 #include "BKE_library_query.h"
48 #include "BKE_scene.h"
49 #include "BKE_main.h"
50 #include "BKE_layer.h"
51
52 #include "MEM_guardedalloc.h"
53
54 #include "MOD_gpencil_util.h"
55 #include "MOD_gpencil_modifiertypes.h"
56
57 #include "DEG_depsgraph.h"
58 #include "DEG_depsgraph_build.h"
59 #include "DEG_depsgraph_query.h"
60
61 static void initData(GpencilModifierData *md)
62 {
63         LatticeGpencilModifierData *gpmd = (LatticeGpencilModifierData *)md;
64         gpmd->pass_index = 0;
65         gpmd->layername[0] = '\0';
66         gpmd->vgname[0] = '\0';
67         gpmd->object = NULL;
68         gpmd->cache_data = NULL;
69         gpmd->strength = 1.0f;
70 }
71
72 static void copyData(const GpencilModifierData *md, GpencilModifierData *target)
73 {
74         BKE_gpencil_modifier_copyData_generic(md, target);
75 }
76
77 static void deformStroke(
78         GpencilModifierData *md, Depsgraph *UNUSED(depsgraph),
79         Object *ob, bGPDlayer *gpl, bGPDstroke *gps)
80 {
81         LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
82         const int def_nr = defgroup_name_index(ob, mmd->vgname);
83
84         if (!is_stroke_affected_by_modifier(
85                     ob,
86                     mmd->layername, mmd->pass_index, mmd->layer_pass, 3, gpl, gps,
87                     mmd->flag & GP_LATTICE_INVERT_LAYER, mmd->flag & GP_LATTICE_INVERT_PASS,
88                     mmd->flag & GP_LATTICE_INVERT_LAYERPASS))
89         {
90                 return;
91         }
92
93         if (mmd->cache_data == NULL) {
94                 return;
95         }
96
97         for (int i = 0; i < gps->totpoints; i++) {
98                 bGPDspoint *pt = &gps->points[i];
99                 MDeformVert *dvert = gps->dvert != NULL ? &gps->dvert[i] : NULL;
100
101                 /* verify vertex group */
102                 const float weight = get_modifier_point_weight(dvert, (mmd->flag & GP_LATTICE_INVERT_VGROUP) != 0, def_nr);
103                 if (weight < 0.0f) {
104                         continue;
105                 }
106                 calc_latt_deform((struct LatticeDeformData *)mmd->cache_data, &pt->x, mmd->strength * weight);
107         }
108 }
109
110 /* FIXME: Ideally we be doing this on a copy of the main depsgraph
111  * (i.e. one where we don't have to worry about restoring state)
112  */
113 static void bakeModifier(
114         Main *bmain, Depsgraph *depsgraph,
115         GpencilModifierData *md, Object *ob)
116 {
117         LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
118         Scene *scene = DEG_get_evaluated_scene(depsgraph);
119         struct LatticeDeformData *ldata = NULL;
120         bGPdata *gpd = ob->data;
121         int oldframe = (int)DEG_get_ctime(depsgraph);
122
123         if (mmd->object == NULL)
124                 return;
125
126         for (bGPDlayer *gpl = gpd->layers.first; gpl; gpl = gpl->next) {
127                 for (bGPDframe *gpf = gpl->frames.first; gpf; gpf = gpf->next) {
128                         /* apply lattice effects on this frame
129                          * NOTE: this assumes that we don't want lattice animation on non-keyframed frames
130                          */
131                         CFRA = gpf->framenum;
132                         BKE_scene_graph_update_for_newframe(depsgraph, bmain);
133
134                         /* recalculate lattice data */
135                         BKE_gpencil_lattice_init(ob);
136
137                         /* compute lattice effects on this frame */
138                         for (bGPDstroke *gps = gpf->strokes.first; gps; gps = gps->next) {
139                                 deformStroke(md, depsgraph, ob, gpl, gps);
140                         }
141                 }
142         }
143
144         /* free lingering data */
145         ldata = (struct LatticeDeformData *)mmd->cache_data;
146         if (ldata) {
147                 end_latt_deform(ldata);
148                 mmd->cache_data = NULL;
149         }
150
151         /* return frame state and DB to original state */
152         CFRA = oldframe;
153         BKE_scene_graph_update_for_newframe(depsgraph, bmain);
154 }
155
156 static void freeData(GpencilModifierData *md)
157 {
158         LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
159         struct LatticeDeformData *ldata = (struct LatticeDeformData *)mmd->cache_data;
160         /* free deform data */
161         if (ldata) {
162                 end_latt_deform(ldata);
163         }
164 }
165
166 static bool isDisabled(GpencilModifierData *md, int UNUSED(userRenderParams))
167 {
168         LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
169
170         return !mmd->object;
171 }
172
173 static void updateDepsgraph(GpencilModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
174 {
175         LatticeGpencilModifierData *lmd = (LatticeGpencilModifierData *)md;
176         if (lmd->object != NULL) {
177                 DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_GEOMETRY, "Lattice Modifier");
178                 DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_TRANSFORM, "Lattice Modifier");
179         }
180         DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "Lattice Modifier");
181 }
182
183 static void foreachObjectLink(
184         GpencilModifierData *md, Object *ob,
185         ObjectWalkFunc walk, void *userData)
186 {
187         LatticeGpencilModifierData *mmd = (LatticeGpencilModifierData *)md;
188
189         walk(userData, ob, &mmd->object, IDWALK_CB_NOP);
190 }
191
192 GpencilModifierTypeInfo modifierType_Gpencil_Lattice = {
193         /* name */              "Lattice",
194         /* structName */        "LatticeGpencilModifierData",
195         /* structSize */        sizeof(LatticeGpencilModifierData),
196         /* type */              eGpencilModifierTypeType_Gpencil,
197         /* flags */             eGpencilModifierTypeFlag_Single | eGpencilModifierTypeFlag_SupportsEditmode,
198
199         /* copyData */          copyData,
200
201         /* deformStroke */      deformStroke,
202         /* generateStrokes */   NULL,
203         /* bakeModifier */      bakeModifier,
204         /* remapTime */         NULL,
205
206         /* initData */          initData,
207         /* freeData */          freeData,
208         /* isDisabled */        isDisabled,
209         /* updateDepsgraph */   updateDepsgraph,
210         /* dependsOnTime */     NULL,
211         /* foreachObjectLink */ foreachObjectLink,
212         /* foreachIDLink */     NULL,
213         /* foreachTexLink */    NULL,
214 };