Mesh Modifiers: refactor copying using a generic function
[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_string.h"
41 #include "BLI_utildefines.h"
42
43 #include "BKE_cdderivedmesh.h"
44 #include "BKE_modifier.h"
45 #include "BKE_shrinkwrap.h"
46
47 #include "depsgraph_private.h"
48
49 #include "MOD_util.h"
50
51 static bool dependsOnNormals(ModifierData *md);
52
53
54 static void initData(ModifierData *md)
55 {
56         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *) md;
57         smd->shrinkType = MOD_SHRINKWRAP_NEAREST_SURFACE;
58         smd->shrinkOpts = MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR;
59         smd->keepDist   = 0.0f;
60
61         smd->target     = NULL;
62         smd->auxTarget  = NULL;
63 }
64
65 static void copyData(ModifierData *md, ModifierData *target)
66 {
67 #if 0
68         ShrinkwrapModifierData *smd  = (ShrinkwrapModifierData *)md;
69         ShrinkwrapModifierData *tsmd = (ShrinkwrapModifierData *)target;
70 #endif
71         modifier_copyData_generic(md, target);
72 }
73
74 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
75 {
76         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *)md;
77         CustomDataMask dataMask = 0;
78
79         /* ask for vertexgroups if we need them */
80         if (smd->vgroup_name[0])
81                 dataMask |= CD_MASK_MDEFORMVERT;
82
83         if ((smd->shrinkType == MOD_SHRINKWRAP_PROJECT) &&
84             (smd->projAxis == MOD_SHRINKWRAP_PROJECT_OVER_NORMAL))
85         {
86                 dataMask |= CD_MASK_MVERT;
87         }
88
89         return dataMask;
90 }
91
92 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
93 {
94         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *) md;
95         return !smd->target;
96 }
97
98
99 static void foreachObjectLink(ModifierData *md, Object *ob, ObjectWalkFunc walk, void *userData)
100 {
101         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *) md;
102
103         walk(userData, ob, &smd->target);
104         walk(userData, ob, &smd->auxTarget);
105 }
106
107 static void deformVerts(ModifierData *md, Object *ob,
108                         DerivedMesh *derivedData,
109                         float (*vertexCos)[3],
110                         int numVerts,
111                         ModifierApplyFlag UNUSED(flag))
112 {
113         DerivedMesh *dm = derivedData;
114         CustomDataMask dataMask = requiredDataMask(ob, md);
115
116         /* ensure we get a CDDM with applied vertex coords */
117         if (dataMask) {
118                 dm = get_cddm(ob, NULL, dm, vertexCos, dependsOnNormals(md));
119         }
120
121         shrinkwrapModifier_deform((ShrinkwrapModifierData *)md, ob, dm, vertexCos, numVerts);
122
123         if (dm != derivedData)
124                 dm->release(dm);
125 }
126
127 static void deformVertsEM(ModifierData *md, Object *ob, struct BMEditMesh *editData, DerivedMesh *derivedData,
128                           float (*vertexCos)[3], int numVerts)
129 {
130         DerivedMesh *dm = derivedData;
131         CustomDataMask dataMask = requiredDataMask(ob, md);
132
133         /* ensure we get a CDDM with applied vertex coords */
134         if (dataMask) {
135                 dm = get_cddm(ob, editData, dm, vertexCos, dependsOnNormals(md));
136         }
137
138         shrinkwrapModifier_deform((ShrinkwrapModifierData *)md, ob, dm, vertexCos, numVerts);
139
140         if (dm != derivedData)
141                 dm->release(dm);
142 }
143
144 static void updateDepgraph(ModifierData *md, DagForest *forest,
145                            struct Scene *UNUSED(scene),
146                            Object *UNUSED(ob),
147                            DagNode *obNode)
148 {
149         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *) md;
150
151         if (smd->target)
152                 dag_add_relation(forest, dag_get_node(forest, smd->target), obNode,
153                                  DAG_RL_OB_DATA | DAG_RL_DATA_DATA, "Shrinkwrap Modifier");
154
155         if (smd->auxTarget)
156                 dag_add_relation(forest, dag_get_node(forest, smd->auxTarget), obNode,
157                                  DAG_RL_OB_DATA | DAG_RL_DATA_DATA, "Shrinkwrap Modifier");
158 }
159
160 static bool dependsOnNormals(ModifierData *md)
161 {
162         ShrinkwrapModifierData *smd = (ShrinkwrapModifierData *)md;
163
164         if (smd->target && smd->shrinkType == MOD_SHRINKWRAP_PROJECT)
165                 return (smd->projAxis == MOD_SHRINKWRAP_PROJECT_OVER_NORMAL);
166         
167         return false;
168 }
169
170 ModifierTypeInfo modifierType_Shrinkwrap = {
171         /* name */              "Shrinkwrap",
172         /* structName */        "ShrinkwrapModifierData",
173         /* structSize */        sizeof(ShrinkwrapModifierData),
174         /* type */              eModifierTypeType_OnlyDeform,
175         /* flags */             eModifierTypeFlag_AcceptsMesh |
176                                 eModifierTypeFlag_AcceptsCVs |
177                                 eModifierTypeFlag_SupportsEditmode |
178                                 eModifierTypeFlag_EnableInEditmode,
179
180         /* copyData */          copyData,
181         /* deformVerts */       deformVerts,
182         /* deformMatrices */    NULL,
183         /* deformVertsEM */     deformVertsEM,
184         /* deformMatricesEM */  NULL,
185         /* applyModifier */     NULL,
186         /* applyModifierEM */   NULL,
187         /* initData */          initData,
188         /* requiredDataMask */  requiredDataMask,
189         /* freeData */          NULL,
190         /* isDisabled */        isDisabled,
191         /* updateDepgraph */    updateDepgraph,
192         /* dependsOnTime */     NULL,
193         /* dependsOnNormals */  dependsOnNormals,
194         /* foreachObjectLink */ foreachObjectLink,
195         /* foreachIDLink */     NULL,
196         /* foreachTexLink */    NULL,
197 };