Mesh Modifiers: refactor copying using a generic function
[blender.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 #if 0
73         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
74 #endif
75         DisplaceModifierData *tdmd = (DisplaceModifierData *) target;
76
77         modifier_copyData_generic(md, target);
78
79         if (tdmd->texture) {
80                 id_us_plus(&tdmd->texture->id);
81         }
82 }
83
84 static void freeData(ModifierData *md)
85 {
86         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
87         if (dmd->texture) {
88                 id_us_min(&dmd->texture->id);
89         }
90 }
91
92 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
93 {
94         DisplaceModifierData *dmd = (DisplaceModifierData *)md;
95         CustomDataMask dataMask = 0;
96
97         /* ask for vertexgroups if we need them */
98         if (dmd->defgrp_name[0]) dataMask |= CD_MASK_MDEFORMVERT;
99
100         /* ask for UV coordinates if we need them */
101         if (dmd->texmapping == MOD_DISP_MAP_UV) dataMask |= CD_MASK_MTFACE;
102
103         return dataMask;
104 }
105
106 static bool dependsOnTime(ModifierData *md)
107 {
108         DisplaceModifierData *dmd = (DisplaceModifierData *)md;
109
110         if (dmd->texture) {
111                 return BKE_texture_dependsOnTime(dmd->texture);
112         }
113         else {
114                 return false;
115         }
116 }
117
118 static bool dependsOnNormals(ModifierData *md)
119 {
120         DisplaceModifierData *dmd = (DisplaceModifierData *)md;
121         return (dmd->direction == MOD_DISP_DIR_NOR);
122 }
123
124 static void foreachObjectLink(ModifierData *md, Object *ob,
125                               ObjectWalkFunc walk, void *userData)
126 {
127         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
128
129         walk(userData, ob, &dmd->map_object);
130 }
131
132 static void foreachIDLink(ModifierData *md, Object *ob,
133                           IDWalkFunc walk, void *userData)
134 {
135         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
136
137         walk(userData, ob, (ID **)&dmd->texture);
138
139         foreachObjectLink(md, ob, (ObjectWalkFunc)walk, userData);
140 }
141
142 static void foreachTexLink(ModifierData *md, Object *ob,
143                            TexWalkFunc walk, void *userData)
144 {
145         walk(userData, ob, md, "texture");
146 }
147
148 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
149 {
150         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
151         return ((!dmd->texture && dmd->direction == MOD_DISP_DIR_RGB_XYZ) || dmd->strength == 0.0f);
152 }
153
154 static void updateDepgraph(ModifierData *md, DagForest *forest,
155                            struct Scene *UNUSED(scene),
156                            Object *UNUSED(ob),
157                            DagNode *obNode)
158 {
159         DisplaceModifierData *dmd = (DisplaceModifierData *) md;
160
161         if (dmd->map_object && dmd->texmapping == MOD_DISP_MAP_OBJECT) {
162                 DagNode *curNode = dag_get_node(forest, dmd->map_object);
163
164                 dag_add_relation(forest, curNode, obNode,
165                                  DAG_RL_DATA_DATA | DAG_RL_OB_DATA, "Displace Modifier");
166         }
167         
168
169         if (dmd->texmapping == MOD_DISP_MAP_GLOBAL)
170                 dag_add_relation(forest, obNode, obNode,
171                                  DAG_RL_DATA_DATA | DAG_RL_OB_DATA, "Displace Modifier");
172         
173 }
174
175 /* dm must be a CDDerivedMesh */
176 static void displaceModifier_do(
177         DisplaceModifierData *dmd, Object *ob,
178         DerivedMesh *dm, float (*vertexCos)[3], int numVerts)
179 {
180         int i;
181         MVert *mvert;
182         MDeformVert *dvert;
183         int defgrp_index;
184         float (*tex_co)[3];
185         float weight = 1.0f; /* init value unused but some compilers may complain */
186         const float delta_fixed = 1.0f - dmd->midlevel;  /* when no texture is used, we fallback to white */
187
188         if (!dmd->texture && dmd->direction == MOD_DISP_DIR_RGB_XYZ) return;
189         if (dmd->strength == 0.0f) return;
190
191         mvert = CDDM_get_verts(dm);
192         modifier_get_vgroup(ob, dm, dmd->defgrp_name, &dvert, &defgrp_index);
193
194         if (dmd->texture) {
195                 tex_co = MEM_callocN(sizeof(*tex_co) * numVerts,
196                                      "displaceModifier_do tex_co");
197                 get_texture_coords((MappingInfoModifierData *)dmd, ob, dm, vertexCos, tex_co, numVerts);
198
199                 modifier_init_texture(dmd->modifier.scene, dmd->texture);
200         }
201         else {
202                 tex_co = NULL;
203         }
204
205         for (i = 0; i < numVerts; i++) {
206                 TexResult texres;
207                 float strength = dmd->strength;
208                 float delta;
209
210                 if (dvert) {
211                         weight = defvert_find_weight(dvert + i, defgrp_index);
212                         if (weight == 0.0f) continue;
213                 }
214
215                 if (dmd->texture) {
216                         texres.nor = NULL;
217                         BKE_texture_get_value(dmd->modifier.scene, dmd->texture, tex_co[i], &texres, false);
218                         delta = texres.tin - dmd->midlevel;
219                 }
220                 else {
221                         delta = delta_fixed;  /* (1.0f - dmd->midlevel) */  /* never changes */
222                 }
223
224                 if (dvert) strength *= weight;
225
226                 delta *= strength;
227                 CLAMP(delta, -10000, 10000);
228
229                 switch (dmd->direction) {
230                         case MOD_DISP_DIR_X:
231                                 vertexCos[i][0] += delta;
232                                 break;
233                         case MOD_DISP_DIR_Y:
234                                 vertexCos[i][1] += delta;
235                                 break;
236                         case MOD_DISP_DIR_Z:
237                                 vertexCos[i][2] += delta;
238                                 break;
239                         case MOD_DISP_DIR_RGB_XYZ:
240                                 vertexCos[i][0] += (texres.tr - dmd->midlevel) * strength;
241                                 vertexCos[i][1] += (texres.tg - dmd->midlevel) * strength;
242                                 vertexCos[i][2] += (texres.tb - dmd->midlevel) * strength;
243                                 break;
244                         case MOD_DISP_DIR_NOR:
245                                 vertexCos[i][0] += delta * (mvert[i].no[0] / 32767.0f);
246                                 vertexCos[i][1] += delta * (mvert[i].no[1] / 32767.0f);
247                                 vertexCos[i][2] += delta * (mvert[i].no[2] / 32767.0f);
248                                 break;
249                 }
250         }
251
252         if (tex_co) {
253                 MEM_freeN(tex_co);
254         }
255 }
256
257 static void deformVerts(ModifierData *md, Object *ob,
258                         DerivedMesh *derivedData,
259                         float (*vertexCos)[3],
260                         int numVerts,
261                         ModifierApplyFlag UNUSED(flag))
262 {
263         DerivedMesh *dm = get_cddm(ob, NULL, derivedData, vertexCos, dependsOnNormals(md));
264
265         displaceModifier_do((DisplaceModifierData *)md, ob, dm,
266                             vertexCos, numVerts);
267
268         if (dm != derivedData)
269                 dm->release(dm);
270 }
271
272 static void deformVertsEM(
273         ModifierData *md, Object *ob, struct BMEditMesh *editData,
274         DerivedMesh *derivedData, float (*vertexCos)[3], int numVerts)
275 {
276         DerivedMesh *dm = get_cddm(ob, editData, derivedData, vertexCos, dependsOnNormals(md));
277
278         displaceModifier_do((DisplaceModifierData *)md, ob, dm,
279                             vertexCos, numVerts);
280
281         if (dm != derivedData)
282                 dm->release(dm);
283 }
284
285
286 ModifierTypeInfo modifierType_Displace = {
287         /* name */              "Displace",
288         /* structName */        "DisplaceModifierData",
289         /* structSize */        sizeof(DisplaceModifierData),
290         /* type */              eModifierTypeType_OnlyDeform,
291         /* flags */             eModifierTypeFlag_AcceptsMesh |
292                                 eModifierTypeFlag_SupportsEditmode,
293
294         /* copyData */          copyData,
295         /* deformVerts */       deformVerts,
296         /* deformMatrices */    NULL,
297         /* deformVertsEM */     deformVertsEM,
298         /* deformMatricesEM */  NULL,
299         /* applyModifier */     NULL,
300         /* applyModifierEM */   NULL,
301         /* initData */          initData,
302         /* requiredDataMask */  requiredDataMask,
303         /* freeData */          freeData,
304         /* isDisabled */        isDisabled,
305         /* updateDepgraph */    updateDepgraph,
306         /* dependsOnTime */     dependsOnTime,
307         /* dependsOnNormals */  dependsOnNormals,
308         /* foreachObjectLink */ foreachObjectLink,
309         /* foreachIDLink */     foreachIDLink,
310         /* foreachTexLink */    foreachTexLink,
311 };