Extract common modifier parameters into ModifierEvalContext struct
[blender.git] / source / blender / modifiers / intern / MOD_curve.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_curve.c
32  *  \ingroup modifiers
33  */
34
35 #include <string.h>
36
37 #include "DNA_scene_types.h"
38 #include "DNA_object_types.h"
39
40 #include "BLI_utildefines.h"
41
42
43 #include "BKE_cdderivedmesh.h"
44 #include "BKE_lattice.h"
45 #include "BKE_library_query.h"
46 #include "BKE_modifier.h"
47
48 #include "DEG_depsgraph.h"
49 #include "DEG_depsgraph_build.h"
50
51 #include "MOD_modifiertypes.h"
52
53 static void initData(ModifierData *md)
54 {
55         CurveModifierData *cmd = (CurveModifierData *) md;
56
57         cmd->defaxis = MOD_CURVE_POSX;
58 }
59
60 static void copyData(ModifierData *md, ModifierData *target)
61 {
62 #if 0
63         CurveModifierData *cmd = (CurveModifierData *) md;
64         CurveModifierData *tcmd = (CurveModifierData *) target;
65 #endif
66         modifier_copyData_generic(md, target);
67 }
68
69 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
70 {
71         CurveModifierData *cmd = (CurveModifierData *)md;
72         CustomDataMask dataMask = 0;
73
74         /* ask for vertexgroups if we need them */
75         if (cmd->name[0]) dataMask |= CD_MASK_MDEFORMVERT;
76
77         return dataMask;
78 }
79
80 static bool isDisabled(ModifierData *md, int UNUSED(userRenderParams))
81 {
82         CurveModifierData *cmd = (CurveModifierData *) md;
83
84         return !cmd->object;
85 }
86
87 static void foreachObjectLink(
88         ModifierData *md, Object *ob,
89         ObjectWalkFunc walk, void *userData)
90 {
91         CurveModifierData *cmd = (CurveModifierData *) md;
92
93         walk(userData, ob, &cmd->object, IDWALK_CB_NOP);
94 }
95
96 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
97 {
98         CurveModifierData *cmd = (CurveModifierData *)md;
99         if (cmd->object != NULL) {
100                 /* TODO(sergey): Need to do the same eval_flags trick for path
101                  * as happening in legacy depsgraph callback.
102                  */
103                 /* TODO(sergey): Currently path is evaluated as a part of modifier stack,
104                  * might be changed in the future.
105                  */
106                 struct Depsgraph *depsgraph = DEG_get_graph_from_handle(ctx->node);
107                 DEG_add_object_relation(ctx->node, cmd->object, DEG_OB_COMP_GEOMETRY, "Curve Modifier");
108                 DEG_add_special_eval_flag(depsgraph, &cmd->object->id, DAG_EVAL_NEED_CURVE_PATH);
109         }
110
111         DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "Curve Modifier");
112 }
113
114 static void deformVerts(ModifierData *md, const ModifierEvalContext *ctx,
115                         DerivedMesh *derivedData,
116                         float (*vertexCos)[3],
117                         int numVerts)
118 {
119         CurveModifierData *cmd = (CurveModifierData *) md;
120
121         /* silly that defaxis and curve_deform_verts are off by 1
122          * but leave for now to save having to call do_versions */
123         curve_deform_verts(cmd->object, ctx->object, derivedData, vertexCos, numVerts,
124                            cmd->name, cmd->defaxis - 1);
125 }
126
127 static void deformVertsEM(
128         ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *em,
129         DerivedMesh *derivedData, float (*vertexCos)[3], int numVerts)
130 {
131         DerivedMesh *dm = derivedData;
132
133         if (!derivedData) dm = CDDM_from_editbmesh(em, false, false);
134
135         deformVerts(md, ctx, dm, vertexCos, numVerts);
136
137         if (!derivedData) dm->release(dm);
138 }
139
140
141 ModifierTypeInfo modifierType_Curve = {
142         /* name */              "Curve",
143         /* structName */        "CurveModifierData",
144         /* structSize */        sizeof(CurveModifierData),
145         /* type */              eModifierTypeType_OnlyDeform,
146         /* flags */             eModifierTypeFlag_AcceptsCVs |
147                                 eModifierTypeFlag_AcceptsLattice |
148                                 eModifierTypeFlag_SupportsEditmode,
149
150         /* copyData */          copyData,
151
152         /* deformVerts_DM */    deformVerts,
153         /* deformMatrices_DM */ NULL,
154         /* deformVertsEM_DM */  deformVertsEM,
155         /* deformMatricesEM_DM*/NULL,
156         /* applyModifier_DM */  NULL,
157         /* applyModifierEM_DM */NULL,
158
159         /* deformVerts */       NULL,
160         /* deformMatrices */    NULL,
161         /* deformVertsEM */     NULL,
162         /* deformMatricesEM */  NULL,
163         /* applyModifier */     NULL,
164         /* applyModifierEM */   NULL,
165
166         /* initData */          initData,
167         /* requiredDataMask */  requiredDataMask,
168         /* freeData */          NULL,
169         /* isDisabled */        isDisabled,
170         /* updateDepsgraph */   updateDepsgraph,
171         /* dependsOnTime */     NULL,
172         /* dependsOnNormals */  NULL,
173         /* foreachObjectLink */ foreachObjectLink,
174         /* foreachIDLink */     NULL,
175         /* foreachTexLink */    NULL,
176 };