Mesh Modifiers: refactor copying using a generic function
[blender.git] / source / blender / modifiers / intern / MOD_cast.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_cast.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 #include "BLI_string.h"
42
43
44 #include "BKE_deform.h"
45 #include "BKE_DerivedMesh.h"
46 #include "BKE_modifier.h"
47
48
49 #include "depsgraph_private.h"
50
51 #include "MOD_util.h"
52
53 static void initData(ModifierData *md)
54 {
55         CastModifierData *cmd = (CastModifierData *) md;
56
57         cmd->fac = 0.5f;
58         cmd->radius = 0.0f;
59         cmd->size = 0.0f;
60         cmd->flag = MOD_CAST_X | MOD_CAST_Y | MOD_CAST_Z | MOD_CAST_SIZE_FROM_RADIUS;
61         cmd->type = MOD_CAST_TYPE_SPHERE;
62         cmd->defgrp_name[0] = '\0';
63         cmd->object = NULL;
64 }
65
66
67 static void copyData(ModifierData *md, ModifierData *target)
68 {
69 #if 0
70         CastModifierData *cmd = (CastModifierData *) md;
71         CastModifierData *tcmd = (CastModifierData *) target;
72 #endif
73         modifier_copyData_generic(md, target);
74 }
75
76 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
77 {
78         CastModifierData *cmd = (CastModifierData *) md;
79         short flag;
80         
81         flag = cmd->flag & (MOD_CAST_X | MOD_CAST_Y | MOD_CAST_Z);
82
83         if ((cmd->fac == 0.0f) || flag == 0) return true;
84
85         return false;
86 }
87
88 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
89 {
90         CastModifierData *cmd = (CastModifierData *)md;
91         CustomDataMask dataMask = 0;
92
93         /* ask for vertexgroups if we need them */
94         if (cmd->defgrp_name[0]) dataMask |= CD_MASK_MDEFORMVERT;
95
96         return dataMask;
97 }
98
99 static void foreachObjectLink(
100         ModifierData *md, Object *ob,
101         void (*walk)(void *userData, Object *ob, Object **obpoin),
102         void *userData)
103 {
104         CastModifierData *cmd = (CastModifierData *) md;
105
106         walk(userData, ob, &cmd->object);
107 }
108
109 static void updateDepgraph(ModifierData *md, DagForest *forest,
110                            struct Scene *UNUSED(scene),
111                            Object *UNUSED(ob),
112                            DagNode *obNode)
113 {
114         CastModifierData *cmd = (CastModifierData *) md;
115
116         if (cmd->object) {
117                 DagNode *curNode = dag_get_node(forest, cmd->object);
118
119                 dag_add_relation(forest, curNode, obNode, DAG_RL_OB_DATA,
120                                  "Cast Modifier");
121         }
122 }
123
124 static void sphere_do(
125         CastModifierData *cmd, Object *ob, DerivedMesh *dm,
126         float (*vertexCos)[3], int numVerts)
127 {
128         MDeformVert *dvert = NULL;
129
130         Object *ctrl_ob = NULL;
131
132         int i, defgrp_index;
133         int has_radius = 0;
134         short flag, type;
135         float len = 0.0f;
136         float fac = cmd->fac;
137         float facm = 1.0f - fac;
138         const float fac_orig = fac;
139         float vec[3], center[3] = {0.0f, 0.0f, 0.0f};
140         float mat[4][4], imat[4][4];
141
142         flag = cmd->flag;
143         type = cmd->type; /* projection type: sphere or cylinder */
144
145         if (type == MOD_CAST_TYPE_CYLINDER) 
146                 flag &= ~MOD_CAST_Z;
147
148         ctrl_ob = cmd->object;
149
150         /* spherify's center is {0, 0, 0} (the ob's own center in its local
151          * space), by default, but if the user defined a control object,
152          * we use its location, transformed to ob's local space */
153         if (ctrl_ob) {
154                 if (flag & MOD_CAST_USE_OB_TRANSFORM) {
155                         invert_m4_m4(ctrl_ob->imat, ctrl_ob->obmat);
156                         mul_m4_m4m4(mat, ctrl_ob->imat, ob->obmat);
157                         invert_m4_m4(imat, mat);
158                 }
159
160                 invert_m4_m4(ob->imat, ob->obmat);
161                 mul_v3_m4v3(center, ob->imat, ctrl_ob->obmat[3]);
162         }
163
164         /* now we check which options the user wants */
165
166         /* 1) (flag was checked in the "if (ctrl_ob)" block above) */
167         /* 2) cmd->radius > 0.0f: only the vertices within this radius from
168          * the center of the effect should be deformed */
169         if (cmd->radius > FLT_EPSILON) has_radius = 1;
170
171         /* 3) if we were given a vertex group name,
172          * only those vertices should be affected */
173         modifier_get_vgroup(ob, dm, cmd->defgrp_name, &dvert, &defgrp_index);
174
175         if (flag & MOD_CAST_SIZE_FROM_RADIUS) {
176                 len = cmd->radius;
177         }
178         else {
179                 len = cmd->size;
180         }
181
182         if (len <= 0) {
183                 for (i = 0; i < numVerts; i++) {
184                         len += len_v3v3(center, vertexCos[i]);
185                 }
186                 len /= numVerts;
187
188                 if (len == 0.0f) len = 10.0f;
189         }
190
191         for (i = 0; i < numVerts; i++) {
192                 float tmp_co[3];
193
194                 copy_v3_v3(tmp_co, vertexCos[i]);
195                 if (ctrl_ob) {
196                         if (flag & MOD_CAST_USE_OB_TRANSFORM) {
197                                 mul_m4_v3(mat, tmp_co);
198                         }
199                         else {
200                                 sub_v3_v3(tmp_co, center);
201                         }
202                 }
203
204                 copy_v3_v3(vec, tmp_co);
205
206                 if (type == MOD_CAST_TYPE_CYLINDER)
207                         vec[2] = 0.0f;
208
209                 if (has_radius) {
210                         if (len_v3(vec) > cmd->radius) continue;
211                 }
212
213                 if (dvert) {
214                         const float weight = defvert_find_weight(&dvert[i], defgrp_index);
215                         if (weight == 0.0f) {
216                                 continue;
217                         }
218
219                         fac = fac_orig * weight;
220                         facm = 1.0f - fac;
221                 }
222
223                 normalize_v3(vec);
224
225                 if (flag & MOD_CAST_X)
226                         tmp_co[0] = fac * vec[0] * len + facm * tmp_co[0];
227                 if (flag & MOD_CAST_Y)
228                         tmp_co[1] = fac * vec[1] * len + facm * tmp_co[1];
229                 if (flag & MOD_CAST_Z)
230                         tmp_co[2] = fac * vec[2] * len + facm * tmp_co[2];
231
232                 if (ctrl_ob) {
233                         if (flag & MOD_CAST_USE_OB_TRANSFORM) {
234                                 mul_m4_v3(imat, tmp_co);
235                         }
236                         else {
237                                 add_v3_v3(tmp_co, center);
238                         }
239                 }
240
241                 copy_v3_v3(vertexCos[i], tmp_co);
242         }
243 }
244
245 static void cuboid_do(
246         CastModifierData *cmd, Object *ob, DerivedMesh *dm,
247         float (*vertexCos)[3], int numVerts)
248 {
249         MDeformVert *dvert = NULL;
250         Object *ctrl_ob = NULL;
251
252         int i, defgrp_index;
253         int has_radius = 0;
254         short flag;
255         float fac = cmd->fac;
256         float facm = 1.0f - fac;
257         const float fac_orig = fac;
258         float min[3], max[3], bb[8][3];
259         float center[3] = {0.0f, 0.0f, 0.0f};
260         float mat[4][4], imat[4][4];
261
262         flag = cmd->flag;
263
264         ctrl_ob = cmd->object;
265
266         /* now we check which options the user wants */
267
268         /* 1) (flag was checked in the "if (ctrl_ob)" block above) */
269         /* 2) cmd->radius > 0.0f: only the vertices within this radius from
270          * the center of the effect should be deformed */
271         if (cmd->radius > FLT_EPSILON) has_radius = 1;
272
273         /* 3) if we were given a vertex group name,
274          * only those vertices should be affected */
275         modifier_get_vgroup(ob, dm, cmd->defgrp_name, &dvert, &defgrp_index);
276
277         if (ctrl_ob) {
278                 if (flag & MOD_CAST_USE_OB_TRANSFORM) {
279                         invert_m4_m4(ctrl_ob->imat, ctrl_ob->obmat);
280                         mul_m4_m4m4(mat, ctrl_ob->imat, ob->obmat);
281                         invert_m4_m4(imat, mat);
282                 }
283
284                 invert_m4_m4(ob->imat, ob->obmat);
285                 mul_v3_m4v3(center, ob->imat, ctrl_ob->obmat[3]);
286         }
287
288         if ((flag & MOD_CAST_SIZE_FROM_RADIUS) && has_radius) {
289                 for (i = 0; i < 3; i++) {
290                         min[i] = -cmd->radius;
291                         max[i] = cmd->radius;
292                 }
293         }
294         else if (!(flag & MOD_CAST_SIZE_FROM_RADIUS) && cmd->size > 0) {
295                 for (i = 0; i < 3; i++) {
296                         min[i] = -cmd->size;
297                         max[i] = cmd->size;
298                 }
299         }
300         else {
301                 /* get bound box */
302                 /* We can't use the object's bound box because other modifiers
303                  * may have changed the vertex data. */
304                 INIT_MINMAX(min, max);
305
306                 /* Cast's center is the ob's own center in its local space,
307                  * by default, but if the user defined a control object, we use
308                  * its location, transformed to ob's local space. */
309                 if (ctrl_ob) {
310                         float vec[3];
311
312                         /* let the center of the ctrl_ob be part of the bound box: */
313                         minmax_v3v3_v3(min, max, center);
314
315                         for (i = 0; i < numVerts; i++) {
316                                 sub_v3_v3v3(vec, vertexCos[i], center);
317                                 minmax_v3v3_v3(min, max, vec);
318                         }
319                 }
320                 else {
321                         for (i = 0; i < numVerts; i++) {
322                                 minmax_v3v3_v3(min, max, vertexCos[i]);
323                         }
324                 }
325
326                 /* we want a symmetric bound box around the origin */
327                 if (fabsf(min[0]) > fabsf(max[0])) max[0] = fabsf(min[0]);
328                 if (fabsf(min[1]) > fabsf(max[1])) max[1] = fabsf(min[1]);
329                 if (fabsf(min[2]) > fabsf(max[2])) max[2] = fabsf(min[2]);
330                 min[0] = -max[0];
331                 min[1] = -max[1];
332                 min[2] = -max[2];
333         }
334
335         /* building our custom bounding box */
336         bb[0][0] = bb[2][0] = bb[4][0] = bb[6][0] = min[0];
337         bb[1][0] = bb[3][0] = bb[5][0] = bb[7][0] = max[0];
338         bb[0][1] = bb[1][1] = bb[4][1] = bb[5][1] = min[1];
339         bb[2][1] = bb[3][1] = bb[6][1] = bb[7][1] = max[1];
340         bb[0][2] = bb[1][2] = bb[2][2] = bb[3][2] = min[2];
341         bb[4][2] = bb[5][2] = bb[6][2] = bb[7][2] = max[2];
342
343         /* ready to apply the effect, one vertex at a time */
344         for (i = 0; i < numVerts; i++) {
345                 int octant, coord;
346                 float d[3], dmax, apex[3], fbb;
347                 float tmp_co[3];
348
349                 copy_v3_v3(tmp_co, vertexCos[i]);
350                 if (ctrl_ob) {
351                         if (flag & MOD_CAST_USE_OB_TRANSFORM) {
352                                 mul_m4_v3(mat, tmp_co);
353                         }
354                         else {
355                                 sub_v3_v3(tmp_co, center);
356                         }
357                 }
358
359                 if (has_radius) {
360                         if (fabsf(tmp_co[0]) > cmd->radius ||
361                             fabsf(tmp_co[1]) > cmd->radius ||
362                             fabsf(tmp_co[2]) > cmd->radius)
363                         {
364                                 continue;
365                         }
366                 }
367
368                 if (dvert) {
369                         const float weight = defvert_find_weight(&dvert[i], defgrp_index);
370                         if (weight == 0.0f) {
371                                 continue;
372                         }
373
374                         fac = fac_orig * weight;
375                         facm = 1.0f - fac;
376                 }
377
378                 /* The algo used to project the vertices to their
379                  * bounding box (bb) is pretty simple:
380                  * for each vertex v:
381                  * 1) find in which octant v is in;
382                  * 2) find which outer "wall" of that octant is closer to v;
383                  * 3) calculate factor (var fbb) to project v to that wall;
384                  * 4) project. */
385
386                 /* find in which octant this vertex is in */
387                 octant = 0;
388                 if (tmp_co[0] > 0.0f) octant += 1;
389                 if (tmp_co[1] > 0.0f) octant += 2;
390                 if (tmp_co[2] > 0.0f) octant += 4;
391
392                 /* apex is the bb's vertex at the chosen octant */
393                 copy_v3_v3(apex, bb[octant]);
394
395                 /* find which bb plane is closest to this vertex ... */
396                 d[0] = tmp_co[0] / apex[0];
397                 d[1] = tmp_co[1] / apex[1];
398                 d[2] = tmp_co[2] / apex[2];
399
400                 /* ... (the closest has the higher (closer to 1) d value) */
401                 dmax = d[0];
402                 coord = 0;
403                 if (d[1] > dmax) {
404                         dmax = d[1];
405                         coord = 1;
406                 }
407                 if (d[2] > dmax) {
408                         /* dmax = d[2]; */ /* commented, we don't need it */
409                         coord = 2;
410                 }
411
412                 /* ok, now we know which coordinate of the vertex to use */
413
414                 if (fabsf(tmp_co[coord]) < FLT_EPSILON) /* avoid division by zero */
415                         continue;
416
417                 /* finally, this is the factor we wanted, to project the vertex
418                  * to its bounding box (bb) */
419                 fbb = apex[coord] / tmp_co[coord];
420
421                 /* calculate the new vertex position */
422                 if (flag & MOD_CAST_X)
423                         tmp_co[0] = facm * tmp_co[0] + fac * tmp_co[0] * fbb;
424                 if (flag & MOD_CAST_Y)
425                         tmp_co[1] = facm * tmp_co[1] + fac * tmp_co[1] * fbb;
426                 if (flag & MOD_CAST_Z)
427                         tmp_co[2] = facm * tmp_co[2] + fac * tmp_co[2] * fbb;
428
429                 if (ctrl_ob) {
430                         if (flag & MOD_CAST_USE_OB_TRANSFORM) {
431                                 mul_m4_v3(imat, tmp_co);
432                         }
433                         else {
434                                 add_v3_v3(tmp_co, center);
435                         }
436                 }
437
438                 copy_v3_v3(vertexCos[i], tmp_co);
439         }
440 }
441
442 static void deformVerts(ModifierData *md, Object *ob,
443                         DerivedMesh *derivedData,
444                         float (*vertexCos)[3],
445                         int numVerts,
446                         ModifierApplyFlag UNUSED(flag))
447 {
448         DerivedMesh *dm = NULL;
449         CastModifierData *cmd = (CastModifierData *)md;
450
451         dm = get_dm(ob, NULL, derivedData, NULL, false, false);
452
453         if (cmd->type == MOD_CAST_TYPE_CUBOID) {
454                 cuboid_do(cmd, ob, dm, vertexCos, numVerts);
455         }
456         else { /* MOD_CAST_TYPE_SPHERE or MOD_CAST_TYPE_CYLINDER */
457                 sphere_do(cmd, ob, dm, vertexCos, numVerts);
458         }
459
460         if (dm != derivedData)
461                 dm->release(dm);
462 }
463
464 static void deformVertsEM(
465         ModifierData *md, Object *ob, struct BMEditMesh *editData,
466         DerivedMesh *derivedData, float (*vertexCos)[3], int numVerts)
467 {
468         DerivedMesh *dm = get_dm(ob, editData, derivedData, NULL, false, false);
469         CastModifierData *cmd = (CastModifierData *)md;
470
471         if (cmd->type == MOD_CAST_TYPE_CUBOID) {
472                 cuboid_do(cmd, ob, dm, vertexCos, numVerts);
473         }
474         else { /* MOD_CAST_TYPE_SPHERE or MOD_CAST_TYPE_CYLINDER */
475                 sphere_do(cmd, ob, dm, vertexCos, numVerts);
476         }
477
478         if (dm != derivedData)
479                 dm->release(dm);
480 }
481
482
483 ModifierTypeInfo modifierType_Cast = {
484         /* name */              "Cast",
485         /* structName */        "CastModifierData",
486         /* structSize */        sizeof(CastModifierData),
487         /* type */              eModifierTypeType_OnlyDeform,
488         /* flags */             eModifierTypeFlag_AcceptsCVs |
489                                 eModifierTypeFlag_SupportsEditmode,
490
491         /* copyData */          copyData,
492         /* deformVerts */       deformVerts,
493         /* deformMatrices */    NULL,
494         /* deformVertsEM */     deformVertsEM,
495         /* deformMatricesEM */  NULL,
496         /* applyModifier */     NULL,
497         /* applyModifierEM */   NULL,
498         /* initData */          initData,
499         /* requiredDataMask */  requiredDataMask,
500         /* freeData */          NULL,
501         /* isDisabled */        isDisabled,
502         /* updateDepgraph */    updateDepgraph,
503         /* dependsOnTime */     NULL,
504         /* dependsOnNormals */  NULL,
505         /* foreachObjectLink */ foreachObjectLink,
506         /* foreachIDLink */     NULL,
507         /* foreachTexLink */    NULL,
508 };