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