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