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