code cleanup: make bmesh operator names more consistant since python has access to...
[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 /* Clamps/Limits the given coordinate to:  limits[0] <= co[axis] <= limits[1]
55  * The amount of clamp is saved on dcut */
56 static void axis_limit(int axis, const float limits[2], float co[3], float dcut[3])
57 {
58         float val = co[axis];
59         if (limits[0] > val) val = limits[0];
60         if (limits[1] < val) val = limits[1];
61
62         dcut[axis] = co[axis] - val;
63         co[axis] = val;
64 }
65
66 static void simpleDeform_taper(const float factor, const float dcut[3], float r_co[3])
67 {
68         float x = r_co[0], y = r_co[1], z = r_co[2];
69         float scale = z * factor;
70
71         r_co[0] = x + x * scale;
72         r_co[1] = y + y * scale;
73         r_co[2] = z;
74
75         {
76                 r_co[0] += dcut[0];
77                 r_co[1] += dcut[1];
78                 r_co[2] += dcut[2];
79         }
80 }
81
82 static void simpleDeform_stretch(const float factor, const float dcut[3], float r_co[3])
83 {
84         float x = r_co[0], y = r_co[1], z = r_co[2];
85         float scale;
86
87         scale = (z * z * factor - factor + 1.0f);
88
89         r_co[0] = x * scale;
90         r_co[1] = y * scale;
91         r_co[2] = z * (1.0f + factor);
92
93         {
94                 r_co[0] += dcut[0];
95                 r_co[1] += dcut[1];
96                 r_co[2] += dcut[2];
97         }
98 }
99
100 static void simpleDeform_twist(const float factor, const float *dcut, float r_co[3])
101 {
102         float x = r_co[0], y = r_co[1], z = r_co[2];
103         float theta, sint, cost;
104
105         theta = z * factor;
106         sint  = sinf(theta);
107         cost  = cosf(theta);
108
109         r_co[0] = x * cost - y * sint;
110         r_co[1] = x * sint + y * cost;
111         r_co[2] = z;
112
113         {
114                 r_co[0] += dcut[0];
115                 r_co[1] += dcut[1];
116                 r_co[2] += dcut[2];
117         }
118 }
119
120 static void simpleDeform_bend(const float factor, const float dcut[3], float r_co[3])
121 {
122         float x = r_co[0], y = r_co[1], z = r_co[2];
123         float theta, sint, cost;
124
125         theta = x * factor;
126         sint = sinf(theta);
127         cost = cosf(theta);
128
129         if (fabsf(factor) > 1e-7f) {
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         {
136                 r_co[0] += cost * dcut[0];
137                 r_co[1] += sint * dcut[0];
138                 r_co[2] += dcut[2];
139         }
140
141 }
142
143
144 /* simple deform modifier */
145 static void SimpleDeformModifier_do(SimpleDeformModifierData *smd, struct Object *ob, struct DerivedMesh *dm,
146                                     float (*vertexCos)[3], int numVerts)
147 {
148         static const float lock_axis[2] = {0.0f, 0.0f};
149
150         int i;
151         int limit_axis = 0;
152         float smd_limit[2], smd_factor;
153         SpaceTransform *transf = NULL, tmp_transf;
154         void (*simpleDeform_callback)(const float factor, const float dcut[3], float co[3]) = NULL;  /* Mode callback */
155         int vgroup;
156         MDeformVert *dvert;
157
158         /* Safe-check */
159         if (smd->origin == ob) smd->origin = NULL;  /* No self references */
160
161         if (smd->limit[0] < 0.0f) smd->limit[0] = 0.0f;
162         if (smd->limit[0] > 1.0f) smd->limit[0] = 1.0f;
163
164         smd->limit[0] = min_ff(smd->limit[0], smd->limit[1]);  /* Upper limit >= than lower limit */
165
166         /* Calculate matrixs do convert between coordinate spaces */
167         if (smd->origin) {
168                 transf = &tmp_transf;
169
170                 if (smd->originOpts & MOD_SIMPLEDEFORM_ORIGIN_LOCAL) {
171                         space_transform_from_matrixs(transf, ob->obmat, smd->origin->obmat);
172                 }
173                 else {
174                         copy_m4_m4(transf->local2target, smd->origin->obmat);
175                         invert_m4_m4(transf->target2local, transf->local2target);
176                 }
177         }
178
179         /* Setup vars,
180          * Bend limits on X.. all other modes limit on Z */
181         limit_axis  = (smd->mode == MOD_SIMPLEDEFORM_MODE_BEND) ? 0 : 2;
182
183         /* Update limits if needed */
184         {
185                 float lower =  FLT_MAX;
186                 float upper = -FLT_MAX;
187
188                 for (i = 0; i < numVerts; i++) {
189                         float tmp[3];
190                         copy_v3_v3(tmp, vertexCos[i]);
191
192                         if (transf) space_transform_apply(transf, tmp);
193
194                         lower = min_ff(lower, tmp[limit_axis]);
195                         upper = max_ff(upper, tmp[limit_axis]);
196                 }
197
198
199                 /* SMD values are normalized to the BV, calculate the absolut values */
200                 smd_limit[1] = lower + (upper - lower) * smd->limit[1];
201                 smd_limit[0] = lower + (upper - lower) * smd->limit[0];
202
203                 smd_factor   = smd->factor / max_ff(FLT_EPSILON, smd_limit[1] - smd_limit[0]);
204         }
205
206         modifier_get_vgroup(ob, dm, smd->vgroup_name, &dvert, &vgroup);
207
208         switch (smd->mode) {
209                 case MOD_SIMPLEDEFORM_MODE_TWIST:   simpleDeform_callback = simpleDeform_twist;     break;
210                 case MOD_SIMPLEDEFORM_MODE_BEND:    simpleDeform_callback = simpleDeform_bend;      break;
211                 case MOD_SIMPLEDEFORM_MODE_TAPER:   simpleDeform_callback = simpleDeform_taper;     break;
212                 case MOD_SIMPLEDEFORM_MODE_STRETCH: simpleDeform_callback = simpleDeform_stretch;   break;
213                 default:
214                         return; /* No simpledeform mode? */
215         }
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                                 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                                 space_transform_invert(transf, vertexCos[i]);
241                         }
242                 }
243         }
244 }
245
246
247
248
249 /* SimpleDeform */
250 static void initData(ModifierData *md)
251 {
252         SimpleDeformModifierData *smd = (SimpleDeformModifierData *) md;
253
254         smd->mode = MOD_SIMPLEDEFORM_MODE_TWIST;
255         smd->originOpts = MOD_SIMPLEDEFORM_ORIGIN_LOCAL;
256         smd->axis = 0;
257
258         smd->origin   =  NULL;
259         smd->factor   =  0.35f;
260         smd->limit[0] =  0.0f;
261         smd->limit[1] =  1.0f;
262 }
263
264 static void copyData(ModifierData *md, ModifierData *target)
265 {
266         SimpleDeformModifierData *smd  = (SimpleDeformModifierData *)md;
267         SimpleDeformModifierData *tsmd = (SimpleDeformModifierData *)target;
268
269         tsmd->mode  = smd->mode;
270         tsmd->axis  = smd->axis;
271         tsmd->origin = smd->origin;
272         tsmd->originOpts = smd->originOpts;
273         tsmd->factor = smd->factor;
274         memcpy(tsmd->limit, smd->limit, sizeof(tsmd->limit));
275         BLI_strncpy(tsmd->vgroup_name, smd->vgroup_name, sizeof(tsmd->vgroup_name));
276 }
277
278 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
279 {
280         SimpleDeformModifierData *smd = (SimpleDeformModifierData *)md;
281         CustomDataMask dataMask = 0;
282
283         /* ask for vertexgroups if we need them */
284         if (smd->vgroup_name[0])
285                 dataMask |= CD_MASK_MDEFORMVERT;
286
287         return dataMask;
288 }
289
290 static void foreachObjectLink(ModifierData *md, Object *ob,
291                               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                         ModifierApplyFlag UNUSED(flag))
313 {
314         DerivedMesh *dm = derivedData;
315         CustomDataMask dataMask = requiredDataMask(ob, md);
316
317         /* we implement requiredDataMask but thats not really useful since
318          * mesh_calc_modifiers pass a NULL derivedData */
319         if (dataMask)
320                 dm = get_dm(ob, NULL, dm, NULL, 0);
321
322         SimpleDeformModifier_do((SimpleDeformModifierData *)md, ob, dm, vertexCos, numVerts);
323
324         if (dm != derivedData)
325                 dm->release(dm);
326 }
327
328 static void deformVertsEM(ModifierData *md, Object *ob,
329                           struct BMEditMesh *editData,
330                           DerivedMesh *derivedData,
331                           float (*vertexCos)[3],
332                           int numVerts)
333 {
334         DerivedMesh *dm = derivedData;
335         CustomDataMask dataMask = requiredDataMask(ob, md);
336
337         /* we implement requiredDataMask but thats not really useful since
338          * mesh_calc_modifiers pass a NULL derivedData */
339         if (dataMask)
340                 dm = get_dm(ob, editData, dm, NULL, 0);
341
342         SimpleDeformModifier_do((SimpleDeformModifierData *)md, ob, dm, vertexCos, numVerts);
343
344         if (dm != derivedData)
345                 dm->release(dm);
346 }
347
348
349 ModifierTypeInfo modifierType_SimpleDeform = {
350         /* name */              "SimpleDeform",
351         /* structName */        "SimpleDeformModifierData",
352         /* structSize */        sizeof(SimpleDeformModifierData),
353         /* type */              eModifierTypeType_OnlyDeform,
354
355         /* flags */             eModifierTypeFlag_AcceptsMesh |
356                                 eModifierTypeFlag_AcceptsCVs |
357                                 eModifierTypeFlag_SupportsEditmode |
358                                 eModifierTypeFlag_EnableInEditmode,
359
360         /* copyData */          copyData,
361         /* deformVerts */       deformVerts,
362         /* deformMatrices */    NULL,
363         /* deformVertsEM */     deformVertsEM,
364         /* deformMatricesEM */  NULL,
365         /* applyModifier */     NULL,
366         /* applyModifierEM */   NULL,
367         /* initData */          initData,
368         /* requiredDataMask */  requiredDataMask,
369         /* freeData */          NULL,
370         /* isDisabled */        NULL,
371         /* updateDepgraph */    updateDepgraph,
372         /* dependsOnTime */     NULL,
373         /* dependsOnNormals */  NULL,
374         /* foreachObjectLink */ foreachObjectLink,
375         /* foreachIDLink */     NULL,
376         /* foreachTexLink */    NULL,
377 };