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