SVN maintenance.
[blender.git] / source / blender / modifiers / intern / MOD_simpledeform.c
1 /*
2 * $Id$
3 *
4 * ***** BEGIN GPL LICENSE BLOCK *****
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software  Foundation,
18 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19 *
20 * The Original Code is Copyright (C) 2005 by the Blender Foundation.
21 * All rights reserved.
22 *
23 * Contributor(s): Daniel Dunbar
24 *                 Ton Roosendaal,
25 *                 Ben Batt,
26 *                 Brecht Van Lommel,
27 *                 Campbell Barton
28 *
29 * ***** END GPL LICENSE BLOCK *****
30 *
31 */
32
33 #include "stddef.h"
34 #include "string.h"
35 #include "stdarg.h"
36 #include "math.h"
37 #include "float.h"
38
39 #include "BLI_kdtree.h"
40 #include "BLI_rand.h"
41 #include "BLI_uvproject.h"
42
43 #include "MEM_guardedalloc.h"
44
45 #include "DNA_armature_types.h"
46 #include "DNA_camera_types.h"
47 #include "DNA_curve_types.h"
48 #include "DNA_key_types.h"
49 #include "DNA_material_types.h"
50 #include "DNA_object_fluidsim.h"
51
52
53 #include "BKE_action.h"
54 #include "BKE_bmesh.h"
55 #include "BKE_cloth.h"
56 #include "BKE_cdderivedmesh.h"
57 #include "BKE_displist.h"
58 #include "BKE_fluidsim.h"
59 #include "BKE_global.h"
60 #include "BKE_multires.h"
61 #include "BKE_key.h"
62 #include "BKE_lattice.h"
63 #include "BKE_material.h"
64 #include "BKE_mesh.h"
65 #include "BKE_modifier.h"
66 #include "BKE_object.h"
67 #include "BKE_paint.h"
68 #include "BKE_particle.h"
69 #include "BKE_pointcache.h"
70 #include "BKE_scene.h"
71 #include "BKE_smoke.h"
72 #include "BKE_softbody.h"
73 #include "BKE_subsurf.h"
74 #include "BKE_texture.h"
75
76 #include "depsgraph_private.h"
77 #include "BKE_deform.h"
78 #include "BKE_shrinkwrap.h"
79
80 #include "MOD_modifiertypes.h"
81 #include "MOD_util.h"
82
83
84 #include "DNA_object_types.h"
85 #include "DNA_modifier_types.h"
86 #include "DNA_meshdata_types.h"
87
88 #include "BKE_DerivedMesh.h"
89 #include "BKE_lattice.h"
90 #include "BKE_deform.h"
91 #include "BKE_utildefines.h"
92 #include "BLI_math.h"
93 #include "BKE_shrinkwrap.h"
94
95 #include <string.h>
96 #include <math.h>
97
98
99 /* Clamps/Limits the given coordinate to:  limits[0] <= co[axis] <= limits[1]
100  * The ammount of clamp is saved on dcut */
101 static void axis_limit(int axis, const float limits[2], float co[3], float dcut[3])
102 {
103         float val = co[axis];
104         if(limits[0] > val) val = limits[0];
105         if(limits[1] < val) val = limits[1];
106
107         dcut[axis] = co[axis] - val;
108         co[axis] = val;
109 }
110
111 static void simpleDeform_taper(const float factor, const float dcut[3], float *co)
112 {
113         float x = co[0], y = co[1], z = co[2];
114         float scale = z*factor;
115
116         co[0] = x + x*scale;
117         co[1] = y + y*scale;
118         co[2] = z;
119
120         if(dcut)
121         {
122                 co[0] += dcut[0];
123                 co[1] += dcut[1];
124                 co[2] += dcut[2];
125         }
126 }
127
128 static void simpleDeform_stretch(const float factor, const float dcut[3], float *co)
129 {
130         float x = co[0], y = co[1], z = co[2];
131         float scale;
132
133         scale = (z*z*factor-factor + 1.0);
134
135         co[0] = x*scale;
136         co[1] = y*scale;
137         co[2] = z*(1.0+factor);
138
139
140         if(dcut)
141         {
142                 co[0] += dcut[0];
143                 co[1] += dcut[1];
144                 co[2] += dcut[2];
145         }
146 }
147
148 static void simpleDeform_twist(const float factor, const float *dcut, float *co)
149 {
150         float x = co[0], y = co[1], z = co[2];
151         float theta, sint, cost;
152
153         theta = z*factor;
154         sint  = sin(theta);
155         cost  = cos(theta);
156
157         co[0] = x*cost - y*sint;
158         co[1] = x*sint + y*cost;
159         co[2] = z;
160
161         if(dcut)
162         {
163                 co[0] += dcut[0];
164                 co[1] += dcut[1];
165                 co[2] += dcut[2];
166         }
167 }
168
169 static void simpleDeform_bend(const float factor, const float dcut[3], float *co)
170 {
171         float x = co[0], y = co[1], z = co[2];
172         float theta, sint, cost;
173
174         theta = x*factor;
175         sint = sin(theta);
176         cost = cos(theta);
177
178         if(fabs(factor) > 1e-7f)
179         {
180                 co[0] = -(y-1.0f/factor)*sint;
181                 co[1] =  (y-1.0f/factor)*cost + 1.0f/factor;
182                 co[2] = z;
183         }
184
185
186         if(dcut)
187         {
188                 co[0] += cost*dcut[0];
189                 co[1] += sint*dcut[0];
190                 co[2] += dcut[2];
191         }
192
193 }
194
195
196 /* simple deform modifier */
197 void SimpleDeformModifier_do(SimpleDeformModifierData *smd, struct Object *ob, struct DerivedMesh *dm, float (*vertexCos)[3], int numVerts)
198 {
199         static const float lock_axis[2] = {0.0f, 0.0f};
200
201         int i;
202         int limit_axis = 0;
203         float smd_limit[2], smd_factor;
204         SpaceTransform *transf = NULL, tmp_transf;
205         void (*simpleDeform_callback)(const float factor, const float dcut[3], float *co) = NULL;       //Mode callback
206         int vgroup = defgroup_name_index(ob, smd->vgroup_name);
207         MDeformVert *dvert = NULL;
208
209         //Safe-check
210         if(smd->origin == ob) smd->origin = NULL;                                       //No self references
211
212         if(smd->limit[0] < 0.0) smd->limit[0] = 0.0f;
213         if(smd->limit[0] > 1.0) smd->limit[0] = 1.0f;
214
215         smd->limit[0] = MIN2(smd->limit[0], smd->limit[1]);                     //Upper limit >= than lower limit
216
217         //Calculate matrixs do convert between coordinate spaces
218         if(smd->origin)
219         {
220                 transf = &tmp_transf;
221
222                 if(smd->originOpts & MOD_SIMPLEDEFORM_ORIGIN_LOCAL)
223                 {
224                         space_transform_from_matrixs(transf, ob->obmat, smd->origin->obmat);
225                 }
226                 else
227                 {
228                         copy_m4_m4(transf->local2target, smd->origin->obmat);
229                         invert_m4_m4(transf->target2local, transf->local2target);
230                 }
231         }
232
233         //Setup vars
234         limit_axis  = (smd->mode == MOD_SIMPLEDEFORM_MODE_BEND) ? 0 : 2; //Bend limits on X.. all other modes limit on Z
235
236         //Update limits if needed
237         {
238                 float lower =  FLT_MAX;
239                 float upper = -FLT_MAX;
240
241                 for(i=0; i<numVerts; i++)
242                 {
243                         float tmp[3];
244                         VECCOPY(tmp, vertexCos[i]);
245
246                         if(transf) space_transform_apply(transf, tmp);
247
248                         lower = MIN2(lower, tmp[limit_axis]);
249                         upper = MAX2(upper, tmp[limit_axis]);
250                 }
251
252
253                 //SMD values are normalized to the BV, calculate the absolut values
254                 smd_limit[1] = lower + (upper-lower)*smd->limit[1];
255                 smd_limit[0] = lower + (upper-lower)*smd->limit[0];
256
257                 smd_factor   = smd->factor / MAX2(FLT_EPSILON, smd_limit[1]-smd_limit[0]);
258         }
259
260
261         if(dm)
262         {
263                 dvert = dm->getVertDataArray(dm, CD_MDEFORMVERT);
264         }
265         else if(ob->type == OB_LATTICE)
266         {
267                 dvert = lattice_get_deform_verts(ob);
268         }
269
270
271
272         switch(smd->mode)
273         {
274                 case MOD_SIMPLEDEFORM_MODE_TWIST:       simpleDeform_callback = simpleDeform_twist;             break;
275                 case MOD_SIMPLEDEFORM_MODE_BEND:        simpleDeform_callback = simpleDeform_bend;              break;
276                 case MOD_SIMPLEDEFORM_MODE_TAPER:       simpleDeform_callback = simpleDeform_taper;             break;
277                 case MOD_SIMPLEDEFORM_MODE_STRETCH:     simpleDeform_callback = simpleDeform_stretch;   break;
278                 default:
279                         return; //No simpledeform mode?
280         }
281
282         for(i=0; i<numVerts; i++)
283         {
284                 float weight = defvert_array_find_weight_safe(dvert, i, vgroup);
285
286                 if(weight != 0.0f)
287                 {
288                         float co[3], dcut[3] = {0.0f, 0.0f, 0.0f};
289
290                         if(transf) space_transform_apply(transf, vertexCos[i]);
291
292                         VECCOPY(co, vertexCos[i]);
293
294                         //Apply axis limits
295                         if(smd->mode != MOD_SIMPLEDEFORM_MODE_BEND) //Bend mode shoulnt have any lock axis
296                         {
297                                 if(smd->axis & MOD_SIMPLEDEFORM_LOCK_AXIS_X) axis_limit(0, lock_axis, co, dcut);
298                                 if(smd->axis & MOD_SIMPLEDEFORM_LOCK_AXIS_Y) axis_limit(1, lock_axis, co, dcut);
299                         }
300                         axis_limit(limit_axis, smd_limit, co, dcut);
301
302                         simpleDeform_callback(smd_factor, dcut, co);            //Apply deform
303                         interp_v3_v3v3(vertexCos[i], vertexCos[i], co, weight); //Use vertex weight has coef of linear interpolation
304
305                         if(transf) space_transform_invert(transf, vertexCos[i]);
306                 }
307         }
308 }
309
310
311
312
313 /* SimpleDeform */
314 static void initData(ModifierData *md)
315 {
316         SimpleDeformModifierData *smd = (SimpleDeformModifierData*) md;
317
318         smd->mode = MOD_SIMPLEDEFORM_MODE_TWIST;
319         smd->axis = 0;
320
321         smd->origin   =  NULL;
322         smd->factor   =  0.35f;
323         smd->limit[0] =  0.0f;
324         smd->limit[1] =  1.0f;
325 }
326
327 static void copyData(ModifierData *md, ModifierData *target)
328 {
329         SimpleDeformModifierData *smd  = (SimpleDeformModifierData*)md;
330         SimpleDeformModifierData *tsmd = (SimpleDeformModifierData*)target;
331
332         tsmd->mode      = smd->mode;
333         tsmd->axis  = smd->axis;
334         tsmd->origin= smd->origin;
335         tsmd->factor= smd->factor;
336         memcpy(tsmd->limit, smd->limit, sizeof(tsmd->limit));
337 }
338
339 static CustomDataMask requiredDataMask(Object *ob, ModifierData *md)
340 {
341         SimpleDeformModifierData *smd = (SimpleDeformModifierData *)md;
342         CustomDataMask dataMask = 0;
343
344         /* ask for vertexgroups if we need them */
345         if(smd->vgroup_name[0])
346                 dataMask |= (1 << CD_MDEFORMVERT);
347
348         return dataMask;
349 }
350
351 static void foreachObjectLink(ModifierData *md, Object *ob, void (*walk)(void *userData, Object *ob, Object **obpoin), void *userData)
352 {
353         SimpleDeformModifierData *smd  = (SimpleDeformModifierData*)md;
354         walk(userData, ob, &smd->origin);
355 }
356
357 static void updateDepgraph(ModifierData *md, DagForest *forest, Scene *scene, Object *ob, DagNode *obNode)
358 {
359         SimpleDeformModifierData *smd  = (SimpleDeformModifierData*)md;
360
361         if (smd->origin)
362                 dag_add_relation(forest, dag_get_node(forest, smd->origin), obNode, DAG_RL_OB_DATA, "SimpleDeform Modifier");
363 }
364
365 static void deformVerts(ModifierData *md, Object *ob, DerivedMesh *derivedData, float (*vertexCos)[3], int numVerts, int useRenderParams, int isFinalCalc)
366 {
367         DerivedMesh *dm = derivedData;
368         CustomDataMask dataMask = requiredDataMask(ob, md);
369
370         /* we implement requiredDataMask but thats not really usefull since
371            mesh_calc_modifiers pass a NULL derivedData */
372         if(dataMask)
373                 dm= get_dm(md->scene, ob, NULL, dm, NULL, 0);
374
375         SimpleDeformModifier_do((SimpleDeformModifierData*)md, ob, dm, vertexCos, numVerts);
376
377         if(dm != derivedData)
378                 dm->release(dm);
379 }
380
381 static void deformVertsEM(ModifierData *md, Object *ob, EditMesh *editData, DerivedMesh *derivedData, float (*vertexCos)[3], int numVerts)
382 {
383         DerivedMesh *dm = derivedData;
384         CustomDataMask dataMask = requiredDataMask(ob, md);
385
386         /* we implement requiredDataMask but thats not really usefull since
387            mesh_calc_modifiers pass a NULL derivedData */
388         if(dataMask)
389                 dm= get_dm(md->scene, ob, editData, dm, NULL, 0);
390
391         SimpleDeformModifier_do((SimpleDeformModifierData*)md, ob, dm, vertexCos, numVerts);
392
393         if(dm != derivedData)
394                 dm->release(dm);
395 }
396
397
398 ModifierTypeInfo modifierType_SimpleDeform = {
399         /* name */              "SimpleDeform",
400         /* structName */        "SimpleDeformModifierData",
401         /* structSize */        sizeof(SimpleDeformModifierData),
402         /* type */              eModifierTypeType_OnlyDeform,
403
404         /* flags */             eModifierTypeFlag_AcceptsMesh
405                                                         | eModifierTypeFlag_AcceptsCVs
406                                                         | eModifierTypeFlag_SupportsEditmode
407                                                         | eModifierTypeFlag_EnableInEditmode,
408
409         /* copyData */          copyData,
410         /* deformVerts */       deformVerts,
411         /* deformVertsEM */     deformVertsEM,
412         /* deformMatricesEM */  0,
413         /* applyModifier */     0,
414         /* applyModifierEM */   0,
415         /* initData */          initData,
416         /* requiredDataMask */  requiredDataMask,
417         /* freeData */          0,
418         /* isDisabled */        0,
419         /* updateDepgraph */    updateDepgraph,
420         /* dependsOnTime */     0,
421         /* foreachObjectLink */ foreachObjectLink,
422         /* foreachIDLink */     0,
423 };