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