Fix depsgraph to compute more accurate links for collision & force.
[blender.git] / source / blender / modifiers / intern / MOD_dynamicpaint.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  * Contributor(s): Miika Hämäläinen
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  *
22  */
23
24 /** \file blender/modifiers/intern/MOD_dynamicpaint.c
25  *  \ingroup modifiers
26  */
27
28 #include <stddef.h>
29
30 #include "DNA_dynamicpaint_types.h"
31 #include "DNA_object_types.h"
32 #include "DNA_object_force.h"
33 #include "DNA_scene_types.h"
34
35 #include "BLI_utildefines.h"
36
37 #include "BKE_cdderivedmesh.h"
38 #include "BKE_dynamicpaint.h"
39 #include "BKE_library_query.h"
40 #include "BKE_modifier.h"
41
42 #include "depsgraph_private.h"
43 #include "DEG_depsgraph_build.h"
44
45
46 static void initData(ModifierData *md) 
47 {
48         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *) md;
49         
50         pmd->canvas = NULL;
51         pmd->brush = NULL;
52         pmd->type = MOD_DYNAMICPAINT_TYPE_CANVAS;
53 }
54
55 static void copyData(ModifierData *md, ModifierData *target)
56 {
57         DynamicPaintModifierData *pmd  = (DynamicPaintModifierData *)md;
58         DynamicPaintModifierData *tpmd = (DynamicPaintModifierData *)target;
59         
60         dynamicPaint_Modifier_copy(pmd, tpmd);
61 }
62
63 static void freeData(ModifierData *md)
64 {
65         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *) md;
66         dynamicPaint_Modifier_free(pmd);
67 }
68
69 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
70 {
71         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *)md;
72         CustomDataMask dataMask = 0;
73
74         if (pmd->canvas) {
75                 DynamicPaintSurface *surface = pmd->canvas->surfaces.first;
76                 for (; surface; surface = surface->next) {
77                         /* tface */
78                         if (surface->format == MOD_DPAINT_SURFACE_F_IMAGESEQ || 
79                             surface->init_color_type == MOD_DPAINT_INITIAL_TEXTURE)
80                         {
81                                 dataMask |= CD_MASK_MLOOPUV | CD_MASK_MTEXPOLY;
82                         }
83                         /* mcol */
84                         if (surface->type == MOD_DPAINT_SURFACE_T_PAINT ||
85                             surface->init_color_type == MOD_DPAINT_INITIAL_VERTEXCOLOR)
86                         {
87                                 dataMask |= CD_MASK_MLOOPCOL;
88                         }
89                         /* CD_MDEFORMVERT */
90                         if (surface->type == MOD_DPAINT_SURFACE_T_WEIGHT) {
91                                 dataMask |= CD_MASK_MDEFORMVERT;
92                         }
93                 }
94         }
95
96         if (pmd->brush) {
97                 if (pmd->brush->flags & MOD_DPAINT_USE_MATERIAL) {
98                         dataMask |= CD_MASK_MLOOPUV | CD_MASK_MTEXPOLY;
99                 }
100         }
101         return dataMask;
102 }
103
104 static DerivedMesh *applyModifier(ModifierData *md, Object *ob, 
105                                   DerivedMesh *dm,
106                                   ModifierApplyFlag flag)
107 {
108         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *) md;
109
110         /* dont apply dynamic paint on orco dm stack */
111         if (!(flag & MOD_APPLY_ORCO)) {
112                 return dynamicPaint_Modifier_do(pmd, md->scene, ob, dm);
113         }
114         return dm;
115 }
116
117 static bool is_brush_cb(Object *UNUSED(ob), ModifierData *pmd)
118 {
119         return ((DynamicPaintModifierData*)pmd)->brush != NULL;
120 }
121
122 static void updateDepgraph(ModifierData *md, DagForest *forest,
123                            struct Main *UNUSED(bmain),
124                            struct Scene *scene,
125                            Object *ob,
126                            DagNode *obNode)
127 {
128         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *) md;
129
130         /* add relation from canvases to all brush objects */
131         if (pmd && pmd->canvas) {
132                 for (DynamicPaintSurface *surface = pmd->canvas->surfaces.first; surface; surface = surface->next) {
133                         if (surface->effect & MOD_DPAINT_EFFECT_DO_DRIP) {
134                                 dag_add_forcefield_relations(forest, scene, ob, obNode, surface->effector_weights, true, 0, "Dynamic Paint Field");
135                         }
136
137                         /* Actual code uses custom loop over group/scene without layer checks in dynamicPaint_doStep */
138                         dag_add_collision_relations(forest, scene, ob, obNode, surface->brush_group, -1, eModifierType_DynamicPaint, is_brush_cb, false, "Dynamic Paint Brush");
139                 }
140         }
141 }
142
143 static void updateDepsgraph(ModifierData *md,
144                             struct Main *UNUSED(bmain),
145                             struct Scene *scene,
146                             Object *ob,
147                             struct DepsNodeHandle *node)
148 {
149         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *)md;
150         /* Add relation from canvases to all brush objects. */
151         if (pmd->canvas != NULL) {
152                 for (DynamicPaintSurface *surface = pmd->canvas->surfaces.first; surface; surface = surface->next) {
153                         if (surface->effect & MOD_DPAINT_EFFECT_DO_DRIP) {
154                                 DEG_add_forcefield_relations(node, scene, ob, surface->effector_weights, true, 0, "Dynamic Paint Field");
155                         }
156
157                         /* Actual code uses custom loop over group/scene without layer checks in dynamicPaint_doStep */
158                         DEG_add_collision_relations(node, scene, ob, surface->brush_group, -1, eModifierType_DynamicPaint, is_brush_cb, false, "Dynamic Paint Brush");
159                 }
160         }
161 }
162
163 static bool dependsOnTime(ModifierData *UNUSED(md))
164 {
165         return true;
166 }
167
168 static void foreachIDLink(ModifierData *md, Object *ob,
169                           IDWalkFunc walk, void *userData)
170 {
171         DynamicPaintModifierData *pmd = (DynamicPaintModifierData *) md;
172
173         if (pmd->canvas) {
174                 DynamicPaintSurface *surface = pmd->canvas->surfaces.first;
175
176                 for (; surface; surface = surface->next) {
177                         walk(userData, ob, (ID **)&surface->brush_group, IDWALK_NOP);
178                         walk(userData, ob, (ID **)&surface->init_texture, IDWALK_USER);
179                         if (surface->effector_weights) {
180                                 walk(userData, ob, (ID **)&surface->effector_weights->group, IDWALK_NOP);
181                         }
182                 }
183         }
184         if (pmd->brush) {
185                 walk(userData, ob, (ID **)&pmd->brush->mat, IDWALK_USER);
186         }
187 }
188
189 static void foreachTexLink(ModifierData *UNUSED(md), Object *UNUSED(ob),
190                            TexWalkFunc UNUSED(walk), void *UNUSED(userData))
191 {
192         //walk(userData, ob, md, ""); /* re-enable when possible */
193 }
194
195 ModifierTypeInfo modifierType_DynamicPaint = {
196         /* name */              "Dynamic Paint",
197         /* structName */        "DynamicPaintModifierData",
198         /* structSize */        sizeof(DynamicPaintModifierData),
199         /* type */              eModifierTypeType_Constructive,
200         /* flags */             eModifierTypeFlag_AcceptsMesh |
201 /*                              eModifierTypeFlag_SupportsMapping |*/
202                                 eModifierTypeFlag_UsesPointCache |
203                                 eModifierTypeFlag_Single |
204                                 eModifierTypeFlag_UsesPreview,
205
206         /* copyData */          copyData,
207         /* deformVerts */       NULL,
208         /* deformMatrices */    NULL,
209         /* deformVertsEM */     NULL,
210         /* deformMatricesEM */  NULL,
211         /* applyModifier */     applyModifier,
212         /* applyModifierEM */   NULL,
213         /* initData */          initData,
214         /* requiredDataMask */  requiredDataMask,
215         /* freeData */          freeData,
216         /* isDisabled */        NULL,
217         /* updateDepgraph */    updateDepgraph,
218         /* updateDepsgraph */   updateDepsgraph,
219         /* dependsOnTime */     dependsOnTime,
220         /* dependsOnNormals */  NULL,
221         /* foreachObjectLink */ NULL,
222         /* foreachIDLink */     foreachIDLink,
223         /* foreachTexLink */    foreachTexLink,
224 };