Made armatures evaluation safe(r) for threading
[blender-staging.git] / source / blender / modifiers / intern / MOD_displace.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) 2005 by the Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Daniel Dunbar
22  *                 Ton Roosendaal,
23  *                 Ben Batt,
24  *                 Brecht Van Lommel,
25  *                 Campbell Barton
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  *
29  */
30
31 /** \file blender/modifiers/intern/MOD_displace.c
32  *  \ingroup modifiers
33  */
34
35
36 #include "DNA_meshdata_types.h"
37 #include "DNA_object_types.h"
38
39 #include "BLI_math.h"
40 #include "BLI_utildefines.h"
41 #include "BLI_string.h"
42
43
44 #include "BKE_cdderivedmesh.h"
45 #include "BKE_library.h"
46 #include "BKE_modifier.h"
47 #include "BKE_texture.h"
48 #include "BKE_deform.h"
49
50 #include "depsgraph_private.h"
51 #include "MEM_guardedalloc.h"
52
53 #include "MOD_util.h"
54
55 #include "RE_shader_ext.h"
56
57
58 /* Displace */
59
60 static void initData(ModifierData *md)
61 {
62         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
63
64         dmd->texture = NULL;
65         dmd->strength = 1;
66         dmd->direction = MOD_DISP_DIR_NOR;
67         dmd->midlevel = 0.5;
68 }
69
70 static void copyData(ModifierData *md, ModifierData *target)
71 {
72         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
73         DisplaceModifierData *tdmd = (DisplaceModifierData *) target;
74
75         tdmd->texture = dmd->texture;
76         tdmd->strength = dmd->strength;
77         tdmd->direction = dmd->direction;
78         BLI_strncpy(tdmd->defgrp_name, dmd->defgrp_name, sizeof(tdmd->defgrp_name));
79         tdmd->midlevel = dmd->midlevel;
80         tdmd->texmapping = dmd->texmapping;
81         tdmd->map_object = dmd->map_object;
82         BLI_strncpy(tdmd->uvlayer_name, dmd->uvlayer_name, sizeof(tdmd->uvlayer_name));
83
84         if (tdmd->texture) {
85                 id_us_plus(&tdmd->texture->id);
86         }
87 }
88
89 static void freeData(ModifierData *md)
90 {
91         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
92         if (dmd->texture) {
93                 id_us_min(&dmd->texture->id);
94         }
95 }
96
97 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
98 {
99         DisplaceModifierData *dmd = (DisplaceModifierData *)md;
100         CustomDataMask dataMask = 0;
101
102         /* ask for vertexgroups if we need them */
103         if (dmd->defgrp_name[0]) dataMask |= CD_MASK_MDEFORMVERT;
104
105         /* ask for UV coordinates if we need them */
106         if (dmd->texmapping == MOD_DISP_MAP_UV) dataMask |= CD_MASK_MTFACE;
107
108         return dataMask;
109 }
110
111 static bool dependsOnTime(ModifierData *md)
112 {
113         DisplaceModifierData *dmd = (DisplaceModifierData *)md;
114
115         if (dmd->texture) {
116                 return BKE_texture_dependsOnTime(dmd->texture);
117         }
118         else {
119                 return false;
120         }
121 }
122
123 static bool dependsOnNormals(ModifierData *md)
124 {
125         DisplaceModifierData *dmd = (DisplaceModifierData *)md;
126         return (dmd->direction == MOD_DISP_DIR_NOR);
127 }
128
129 static void foreachObjectLink(ModifierData *md, Object *ob,
130                               ObjectWalkFunc walk, void *userData)
131 {
132         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
133
134         walk(userData, ob, &dmd->map_object);
135 }
136
137 static void foreachIDLink(ModifierData *md, Object *ob,
138                           IDWalkFunc walk, void *userData)
139 {
140         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
141
142         walk(userData, ob, (ID **)&dmd->texture);
143
144         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
145 }
146
147 static void foreachTexLink(ModifierData *md, Object *ob,
148                            TexWalkFunc walk, void *userData)
149 {
150         walk(userData, ob, md, "texture");
151 }
152
153 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
154 {
155         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
156         return ((!dmd->texture && dmd->direction == MOD_DISP_DIR_RGB_XYZ) || dmd->strength == 0.0f);
157 }
158
159 static void updateDepgraph(ModifierData *md, DagForest *forest,
160                            struct Scene *UNUSED(scene),
161                            Object *UNUSED(ob),
162                            DagNode *obNode)
163 {
164         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
165
166         if (dmd->map_object && dmd->texmapping == MOD_DISP_MAP_OBJECT) {
167                 DagNode *curNode = dag_get_node(forest, dmd->map_object);
168
169                 dag_add_relation(forest, curNode, obNode,
170                                  DAG_RL_DATA_DATA | DAG_RL_OB_DATA, "Displace Modifier");
171         }
172         
173
174         if (dmd->texmapping == MOD_DISP_MAP_GLOBAL)
175                 dag_add_relation(forest, obNode, obNode,
176                                  DAG_RL_DATA_DATA | DAG_RL_OB_DATA, "Displace Modifier");
177         
178 }
179
180 /* dm must be a CDDerivedMesh */
181 static void displaceModifier_do(
182         DisplaceModifierData *dmd, Object *ob,
183         DerivedMesh *dm, float (*vertexCos)[3], int numVerts)
184 {
185         int i;
186         MVert *mvert;
187         MDeformVert *dvert;
188         int defgrp_index;
189         float (*tex_co)[3];
190         float weight = 1.0f; /* init value unused but some compilers may complain */
191         const float delta_fixed = 1.0f - dmd->midlevel;  /* when no texture is used, we fallback to white */
192
193         if (!dmd->texture && dmd->direction == MOD_DISP_DIR_RGB_XYZ) return;
194         if (dmd->strength == 0.0f) return;
195
196         mvert = CDDM_get_verts(dm);
197         modifier_get_vgroup(ob, dm, dmd->defgrp_name, &dvert, &defgrp_index);
198
199         if (dmd->texture) {
200                 tex_co = MEM_callocN(sizeof(*tex_co) * numVerts,
201                                      "displaceModifier_do tex_co");
202                 get_texture_coords((MappingInfoModifierData *)dmd, ob, dm, vertexCos, tex_co, numVerts);
203
204                 modifier_init_texture(dmd->modifier.scene, dmd->texture);
205         }
206         else {
207                 tex_co = NULL;
208         }
209
210         for (i = 0; i < numVerts; i++) {
211                 TexResult texres;
212                 float strength = dmd->strength;
213                 float delta;
214
215                 if (dvert) {
216                         weight = defvert_find_weight(dvert + i, defgrp_index);
217                         if (weight == 0.0f) continue;
218                 }
219
220                 if (dmd->texture) {
221                         texres.nor = NULL;
222                         get_texture_value(dmd->texture, tex_co[i], &texres);
223                         delta = texres.tin - dmd->midlevel;
224                 }
225                 else {
226                         delta = delta_fixed;  /* (1.0f - dmd->midlevel) */  /* never changes */
227                 }
228
229                 if (dvert) strength *= weight;
230
231                 delta *= strength;
232                 CLAMP(delta, -10000, 10000);
233
234                 switch (dmd->direction) {
235                         case MOD_DISP_DIR_X:
236                                 vertexCos[i][0] += delta;
237                                 break;
238                         case MOD_DISP_DIR_Y:
239                                 vertexCos[i][1] += delta;
240                                 break;
241                         case MOD_DISP_DIR_Z:
242                                 vertexCos[i][2] += delta;
243                                 break;
244                         case MOD_DISP_DIR_RGB_XYZ:
245                                 vertexCos[i][0] += (texres.tr - dmd->midlevel) * strength;
246                                 vertexCos[i][1] += (texres.tg - dmd->midlevel) * strength;
247                                 vertexCos[i][2] += (texres.tb - dmd->midlevel) * strength;
248                                 break;
249                         case MOD_DISP_DIR_NOR:
250                                 vertexCos[i][0] += delta * (mvert[i].no[0] / 32767.0f);
251                                 vertexCos[i][1] += delta * (mvert[i].no[1] / 32767.0f);
252                                 vertexCos[i][2] += delta * (mvert[i].no[2] / 32767.0f);
253                                 break;
254                 }
255         }
256
257         if (tex_co) {
258                 MEM_freeN(tex_co);
259         }
260 }
261
262 static void deformVerts(ModifierData *md, Object *ob,
263                         DerivedMesh *derivedData,
264                         float (*vertexCos)[3],
265                         int numVerts,
266                         ModifierApplyFlag UNUSED(flag))
267 {
268         DerivedMesh *dm = get_cddm(ob, NULL, derivedData, vertexCos);
269
270         displaceModifier_do((DisplaceModifierData *)md, ob, dm,
271                             vertexCos, numVerts);
272
273         if (dm != derivedData)
274                 dm->release(dm);
275 }
276
277 static void deformVertsEM(
278         ModifierData *md, Object *ob, struct BMEditMesh *editData,
279         DerivedMesh *derivedData, float (*vertexCos)[3], int numVerts)
280 {
281         DerivedMesh *dm = get_cddm(ob, editData, derivedData, vertexCos);
282
283         displaceModifier_do((DisplaceModifierData *)md, ob, dm,
284                             vertexCos, numVerts);
285
286         if (dm != derivedData)
287                 dm->release(dm);
288 }
289
290
291 ModifierTypeInfo modifierType_Displace = {
292         /* name */              "Displace",
293         /* structName */        "DisplaceModifierData",
294         /* structSize */        sizeof(DisplaceModifierData),
295         /* type */              eModifierTypeType_OnlyDeform,
296         /* flags */             eModifierTypeFlag_AcceptsMesh |
297                                 eModifierTypeFlag_SupportsEditmode,
298
299         /* copyData */          copyData,
300         /* deformVerts */       deformVerts,
301         /* deformMatrices */    NULL,
302         /* deformVertsEM */     deformVertsEM,
303         /* deformMatricesEM */  NULL,
304         /* applyModifier */     NULL,
305         /* applyModifierEM */   NULL,
306         /* initData */          initData,
307         /* requiredDataMask */  requiredDataMask,
308         /* freeData */          freeData,
309         /* isDisabled */        isDisabled,
310         /* updateDepgraph */    updateDepgraph,
311         /* dependsOnTime */     dependsOnTime,
312         /* dependsOnNormals */  dependsOnNormals,
313         /* foreachObjectLink */ foreachObjectLink,
314         /* foreachIDLink */     foreachIDLink,
315         /* foreachTexLink */    foreachTexLink,
316 };