svn merge -r41575:41602 ^/trunk/blender
[blender.git] / source / blender / modifiers / intern / MOD_simpledeform.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_simpledeform.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_string.h"
41 #include "BLI_utildefines.h"
42
43 #include "BKE_cdderivedmesh.h"
44 #include "BKE_lattice.h"
45 #include "BKE_modifier.h"
46 #include "BKE_deform.h"
47 #include "BKE_shrinkwrap.h"
48
49
50 #include "depsgraph_private.h"
51
52 #include "MOD_util.h"
53
54
55
56 /* Clamps/Limits the given coordinate to:  limits[0] <= co[axis] <= limits[1]
57  * The amount of clamp is saved on dcut */
58 static void axis_limit(int axis, const float limits[2], float co[3], float dcut[3])
59 {
60         float val = co[axis];
61         if(limits[0] > val) val = limits[0];
62         if(limits[1] < val) val = limits[1];
63
64         dcut[axis] = co[axis] - val;
65         co[axis] = val;
66 }
67
68 static void simpleDeform_taper(const float factor, const float dcut[3], float *co)
69 {
70         float x = co[0], y = co[1], z = co[2];
71         float scale = z*factor;
72
73         co[0] = x + x*scale;
74         co[1] = y + y*scale;
75         co[2] = z;
76
77         if(dcut)
78         {
79                 co[0] += dcut[0];
80                 co[1] += dcut[1];
81                 co[2] += dcut[2];
82         }
83 }
84
85 static void simpleDeform_stretch(const float factor, const float dcut[3], float *co)
86 {
87         float x = co[0], y = co[1], z = co[2];
88         float scale;
89
90         scale = (z*z*factor-factor + 1.0f);
91
92         co[0] = x*scale;
93         co[1] = y*scale;
94         co[2] = z*(1.0f+factor);
95
96
97         if(dcut)
98         {
99                 co[0] += dcut[0];
100                 co[1] += dcut[1];
101                 co[2] += dcut[2];
102         }
103 }
104
105 static void simpleDeform_twist(const float factor, const float *dcut, float *co)
106 {
107         float x = co[0], y = co[1], z = co[2];
108         float theta, sint, cost;
109
110         theta = z*factor;
111         sint  = sin(theta);
112         cost  = cos(theta);
113
114         co[0] = x*cost - y*sint;
115         co[1] = x*sint + y*cost;
116         co[2] = z;
117
118         if(dcut)
119         {
120                 co[0] += dcut[0];
121                 co[1] += dcut[1];
122                 co[2] += dcut[2];
123         }
124 }
125
126 static void simpleDeform_bend(const float factor, const float dcut[3], float *co)
127 {
128         float x = co[0], y = co[1], z = co[2];
129         float theta, sint, cost;
130
131         theta = x*factor;
132         sint = sin(theta);
133         cost = cos(theta);
134
135         if(fabsf(factor) > 1e-7f)
136         {
137                 co[0] = -(y-1.0f/factor)*sint;
138                 co[1] =  (y-1.0f/factor)*cost + 1.0f/factor;
139                 co[2] = z;
140         }
141
142
143         if(dcut)
144         {
145                 co[0] += cost*dcut[0];
146                 co[1] += sint*dcut[0];
147                 co[2] += dcut[2];
148         }
149
150 }
151
152
153 /* simple deform modifier */
154 static void SimpleDeformModifier_do(SimpleDeformModifierData *smd, struct Object *ob, struct DerivedMesh *dm, float (*vertexCos)[3], int numVerts)
155 {
156         static const float lock_axis[2] = {0.0f, 0.0f};
157
158         int i;
159         int limit_axis = 0;
160         float smd_limit[2], smd_factor;
161         SpaceTransform *transf = NULL, tmp_transf;
162         void (*simpleDeform_callback)(const float factor, const float dcut[3], float *co) = NULL;       //Mode callback
163         int vgroup;
164         MDeformVert *dvert;
165
166         //Safe-check
167         if(smd->origin == ob) smd->origin = NULL;                                       //No self references
168
169         if(smd->limit[0] < 0.0f) smd->limit[0] = 0.0f;
170         if(smd->limit[0] > 1.0f) smd->limit[0] = 1.0f;
171
172         smd->limit[0] = MIN2(smd->limit[0], smd->limit[1]);                     //Upper limit >= than lower limit
173
174         //Calculate matrixs do convert between coordinate spaces
175         if(smd->origin)
176         {
177                 transf = &tmp_transf;
178
179                 if(smd->originOpts & MOD_SIMPLEDEFORM_ORIGIN_LOCAL)
180                 {
181                         space_transform_from_matrixs(transf, ob->obmat, smd->origin->obmat);
182                 }
183                 else
184                 {
185                         copy_m4_m4(transf->local2target, smd->origin->obmat);
186                         invert_m4_m4(transf->target2local, transf->local2target);
187                 }
188         }
189
190         //Setup vars
191         limit_axis  = (smd->mode == MOD_SIMPLEDEFORM_MODE_BEND) ? 0 : 2; //Bend limits on X.. all other modes limit on Z
192
193         //Update limits if needed
194         {
195                 float lower =  FLT_MAX;
196                 float upper = -FLT_MAX;
197
198                 for(i=0; i<numVerts; i++)
199                 {
200                         float tmp[3];
201                         copy_v3_v3(tmp, vertexCos[i]);
202
203                         if(transf) space_transform_apply(transf, tmp);
204
205                         lower = MIN2(lower, tmp[limit_axis]);
206                         upper = MAX2(upper, tmp[limit_axis]);
207                 }
208
209
210                 //SMD values are normalized to the BV, calculate the absolut values
211                 smd_limit[1] = lower + (upper-lower)*smd->limit[1];
212                 smd_limit[0] = lower + (upper-lower)*smd->limit[0];
213
214                 smd_factor   = smd->factor / MAX2(FLT_EPSILON, smd_limit[1]-smd_limit[0]);
215         }
216
217         modifier_get_vgroup(ob, dm, smd->vgroup_name, &dvert, &vgroup);
218
219         switch(smd->mode)
220         {
221                 case MOD_SIMPLEDEFORM_MODE_TWIST:       simpleDeform_callback = simpleDeform_twist;             break;
222                 case MOD_SIMPLEDEFORM_MODE_BEND:        simpleDeform_callback = simpleDeform_bend;              break;
223                 case MOD_SIMPLEDEFORM_MODE_TAPER:       simpleDeform_callback = simpleDeform_taper;             break;
224                 case MOD_SIMPLEDEFORM_MODE_STRETCH:     simpleDeform_callback = simpleDeform_stretch;   break;
225                 default:
226                         return; //No simpledeform mode?
227         }
228
229         for(i=0; i<numVerts; i++)
230         {
231                 float weight = defvert_array_find_weight_safe(dvert, i, vgroup);
232
233                 if(weight != 0.0f)
234                 {
235                         float co[3], dcut[3] = {0.0f, 0.0f, 0.0f};
236
237                         if(transf) space_transform_apply(transf, vertexCos[i]);
238
239                         copy_v3_v3(co, vertexCos[i]);
240
241                         //Apply axis limits
242                         if(smd->mode != MOD_SIMPLEDEFORM_MODE_BEND) //Bend mode shoulnt have any lock axis
243                         {
244                                 if(smd->axis & MOD_SIMPLEDEFORM_LOCK_AXIS_X) axis_limit(0, lock_axis, co, dcut);
245                                 if(smd->axis & MOD_SIMPLEDEFORM_LOCK_AXIS_Y) axis_limit(1, lock_axis, co, dcut);
246                         }
247                         axis_limit(limit_axis, smd_limit, co, dcut);
248
249                         simpleDeform_callback(smd_factor, dcut, co);            //Apply deform
250                         interp_v3_v3v3(vertexCos[i], vertexCos[i], co, weight); //Use vertex weight has coef of linear interpolation
251
252                         if(transf) space_transform_invert(transf, vertexCos[i]);
253                 }
254         }
255 }
256
257
258
259
260 /* SimpleDeform */
261 static void initData(ModifierData *md)
262 {
263         SimpleDeformModifierData *smd = (SimpleDeformModifierData*) md;
264
265         smd->mode = MOD_SIMPLEDEFORM_MODE_TWIST;
266         smd->axis = 0;
267
268         smd->origin   =  NULL;
269         smd->factor   =  0.35f;
270         smd->limit[0] =  0.0f;
271         smd->limit[1] =  1.0f;
272 }
273
274 static void copyData(ModifierData *md, ModifierData *target)
275 {
276         SimpleDeformModifierData *smd  = (SimpleDeformModifierData*)md;
277         SimpleDeformModifierData *tsmd = (SimpleDeformModifierData*)target;
278
279         tsmd->mode      = smd->mode;
280         tsmd->axis  = smd->axis;
281         tsmd->origin= smd->origin;
282         tsmd->originOpts= smd->originOpts;
283         tsmd->factor= smd->factor;
284         memcpy(tsmd->limit, smd->limit, sizeof(tsmd->limit));
285         BLI_strncpy(tsmd->vgroup_name, smd->vgroup_name, sizeof(tsmd->vgroup_name));
286 }
287
288 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
289 {
290         SimpleDeformModifierData *smd = (SimpleDeformModifierData *)md;
291         CustomDataMask dataMask = 0;
292
293         /* ask for vertexgroups if we need them */
294         if(smd->vgroup_name[0])
295                 dataMask |= CD_MASK_MDEFORMVERT;
296
297         return dataMask;
298 }
299
300 static void foreachObjectLink(ModifierData *md, Object *ob, void (*walk)(void *userData, Object *ob, Object **obpoin), void *userData)
301 {
302         SimpleDeformModifierData *smd  = (SimpleDeformModifierData*)md;
303         walk(userData, ob, &smd->origin);
304 }
305
306 static void updateDepgraph(ModifierData *md, DagForest *forest,
307                                                 struct Scene *UNUSED(scene),
308                                                 Object *UNUSED(ob),
309                                                 DagNode *obNode)
310 {
311         SimpleDeformModifierData *smd  = (SimpleDeformModifierData*)md;
312
313         if (smd->origin)
314                 dag_add_relation(forest, dag_get_node(forest, smd->origin), obNode, DAG_RL_OB_DATA, "SimpleDeform Modifier");
315 }
316
317 static void deformVerts(ModifierData *md, Object *ob,
318                                                 DerivedMesh *derivedData,
319                                                 float (*vertexCos)[3],
320                                                 int numVerts,
321                                                 int UNUSED(useRenderParams),
322                                                 int UNUSED(isFinalCalc))
323 {
324         DerivedMesh *dm = derivedData;
325         CustomDataMask dataMask = requiredDataMask(ob, md);
326
327         /* we implement requiredDataMask but thats not really useful since
328            mesh_calc_modifiers pass a NULL derivedData */
329         if(dataMask)
330                 dm= get_dm(ob, NULL, dm, NULL, 0);
331
332         SimpleDeformModifier_do((SimpleDeformModifierData*)md, ob, dm, vertexCos, numVerts);
333
334         if(dm != derivedData)
335                 dm->release(dm);
336 }
337
338 static void deformVertsEM(ModifierData *md, Object *ob,
339                                                 struct BMEditMesh *editData,
340                                                 DerivedMesh *derivedData,
341                                                 float (*vertexCos)[3],
342                                                 int numVerts)
343 {
344         DerivedMesh *dm = derivedData;
345         CustomDataMask dataMask = requiredDataMask(ob, md);
346
347         /* we implement requiredDataMask but thats not really useful since
348            mesh_calc_modifiers pass a NULL derivedData */
349         if(dataMask)
350                 dm= get_dm(ob, editData, dm, NULL, 0);
351
352         SimpleDeformModifier_do((SimpleDeformModifierData*)md, ob, dm, vertexCos, numVerts);
353
354         if(dm != derivedData)
355                 dm->release(dm);
356 }
357
358
359 ModifierTypeInfo modifierType_SimpleDeform = {
360         /* name */              "SimpleDeform",
361         /* structName */        "SimpleDeformModifierData",
362         /* structSize */        sizeof(SimpleDeformModifierData),
363         /* type */              eModifierTypeType_OnlyDeform,
364
365         /* flags */             eModifierTypeFlag_AcceptsMesh
366                                                         | eModifierTypeFlag_AcceptsCVs
367                                                         | eModifierTypeFlag_SupportsEditmode
368                                                         | eModifierTypeFlag_EnableInEditmode,
369
370         /* copyData */          copyData,
371         /* deformVerts */       deformVerts,
372         /* deformMatrices */    NULL,
373         /* deformVertsEM */     deformVertsEM,
374         /* deformMatricesEM */  NULL,
375         /* applyModifier */     NULL,
376         /* applyModifierEM */   NULL,
377         /* initData */          initData,
378         /* requiredDataMask */  requiredDataMask,
379         /* freeData */          NULL,
380         /* isDisabled */        NULL,
381         /* updateDepgraph */    updateDepgraph,
382         /* dependsOnTime */     NULL,
383         /* dependsOnNormals */  NULL,
384         /* foreachObjectLink */ foreachObjectLink,
385         /* foreachIDLink */     NULL,
386         /* foreachTexLink */    NULL,
387 };