Merge branch 'master' into blender2.8
[blender.git] / source / blender / modifiers / intern / MOD_shrinkwrap.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_shrinkwrap.c
32  *  \ingroup modifiers
33  */
34
35
36 #include <string.h>
37
38 #include "DNA_object_types.h"
39
40 #include "BLI_math.h"
41 #include "BLI_utildefines.h"
42
43 #include "BKE_cdderivedmesh.h"
44 #include "BKE_library_query.h"
45 #include "BKE_modifier.h"
46 #include "BKE_shrinkwrap.h"
47
48 #include "MOD_util.h"
49
50 static bool dependsOnNormals(ModifierData *md);
51
52
53 static void initData(ModifierData *md)
54 {
55         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *) md;
56         smd->shrinkType = MOD_SHRINKWRAP_NEAREST_SURFACE;
57         smd->shrinkOpts = MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR;
58         smd->keepDist   = 0.0f;
59
60         smd->target     = NULL;
61         smd->auxTarget  = NULL;
62 }
63
64 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
65 {
66         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *)md;
67         CustomDataMask dataMask = 0;
68
69         /* ask for vertexgroups if we need them */
70         if (smd->vgroup_name[0])
71                 dataMask |= CD_MASK_MDEFORMVERT;
72
73         if ((smd->shrinkType == MOD_SHRINKWRAP_PROJECT) &&
74             (smd->projAxis == MOD_SHRINKWRAP_PROJECT_OVER_NORMAL))
75         {
76                 dataMask |= CD_MASK_MVERT;
77         }
78
79         return dataMask;
80 }
81
82 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
83 {
84         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *) md;
85         return !smd->target;
86 }
87
88
89 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
90 {
91         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *) md;
92
93         walk(userData, ob, &smd->target, IDWALK_CB_NOP);
94         walk(userData, ob, &smd->auxTarget, IDWALK_CB_NOP);
95 }
96
97 static void deformVerts(ModifierData *md, const ModifierEvalContext *ctx,
98                         DerivedMesh *derivedData,
99                         float (*vertexCos)[3],
100                         int numVerts)
101 {
102         DerivedMesh *dm = derivedData;
103         CustomDataMask dataMask = requiredDataMask(ctx->object, md);
104         bool forRender = (ctx->flag & MOD_APPLY_RENDER) != 0;
105
106         /* ensure we get a CDDM with applied vertex coords */
107         if (dataMask) {
108                 dm = get_cddm(ctx->object, NULL, dm, vertexCos, dependsOnNormals(md));
109         }
110
111         shrinkwrapModifier_deform((ShrinkwrapModifierData *)md, ctx->object, dm, vertexCos, numVerts, forRender);
112
113         if (dm != derivedData)
114                 dm->release(dm);
115 }
116
117 static void deformVertsEM(ModifierData *md, const ModifierEvalContext *ctx,
118                           struct BMEditMesh *editData, DerivedMesh *derivedData,
119                           float (*vertexCos)[3], int numVerts)
120 {
121         DerivedMesh *dm = derivedData;
122         CustomDataMask dataMask = requiredDataMask(ctx->object, md);
123
124         /* ensure we get a CDDM with applied vertex coords */
125         if (dataMask) {
126                 dm = get_cddm(ctx->object, editData, dm, vertexCos, dependsOnNormals(md));
127         }
128
129         shrinkwrapModifier_deform((ShrinkwrapModifierData *)md, ctx->object, dm, vertexCos, numVerts, false);
130
131         if (dm != derivedData)
132                 dm->release(dm);
133 }
134
135 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
136 {
137         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *)md;
138         if (smd->target != NULL) {
139                 DEG_add_object_relation(ctx->node, smd->target, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
140                 DEG_add_object_relation(ctx->node, smd->target, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
141         }
142         if (smd->auxTarget != NULL) {
143                 DEG_add_object_relation(ctx->node, smd->auxTarget, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
144                 DEG_add_object_relation(ctx->node, smd->auxTarget, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
145         }
146 }
147
148 static bool dependsOnNormals(ModifierData *md)
149 {
150         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *)md;
151
152         if (smd->target && smd->shrinkType == MOD_SHRINKWRAP_PROJECT)
153                 return (smd->projAxis == MOD_SHRINKWRAP_PROJECT_OVER_NORMAL);
154         
155         return false;
156 }
157
158 ModifierTypeInfo modifierType_Shrinkwrap = {
159         /* name */              "Shrinkwrap",
160         /* structName */        "ShrinkwrapModifierData",
161         /* structSize */        sizeof(ShrinkwrapModifierData),
162         /* type */              eModifierTypeType_OnlyDeform,
163         /* flags */             eModifierTypeFlag_AcceptsMesh |
164                                 eModifierTypeFlag_AcceptsCVs |
165                                 eModifierTypeFlag_AcceptsLattice |
166                                 eModifierTypeFlag_SupportsEditmode |
167                                 eModifierTypeFlag_EnableInEditmode,
168
169         /* copyData */          modifier_copyData_generic,
170
171         /* deformVerts_DM */    deformVerts,
172         /* deformMatrices_DM */ NULL,
173         /* deformVertsEM_DM */  deformVertsEM,
174         /* deformMatricesEM_DM*/NULL,
175         /* applyModifier_DM */  NULL,
176         /* applyModifierEM_DM */NULL,
177
178         /* deformVerts */       NULL,
179         /* deformMatrices */    NULL,
180         /* deformVertsEM */     NULL,
181         /* deformMatricesEM */  NULL,
182         /* applyModifier */     NULL,
183         /* applyModifierEM */   NULL,
184
185         /* initData */          initData,
186         /* requiredDataMask */  requiredDataMask,
187         /* freeData */          NULL,
188         /* isDisabled */        isDisabled,
189         /* updateDepsgraph */   updateDepsgraph,
190         /* dependsOnTime */     NULL,
191         /* dependsOnNormals */  dependsOnNormals,
192         /* foreachObjectLink */ foreachObjectLink,
193         /* foreachIDLink */     NULL,
194         /* foreachTexLink */    NULL,
195 };