Merge branch 'master' into blender2.8
[blender.git] / source / blender / modifiers / intern / MOD_lattice.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_lattice.c
32  *  \ingroup modifiers
33  */
34
35
36 #include <string.h>
37
38 #include "DNA_object_types.h"
39
40 #include "BLI_utildefines.h"
41
42 #include "BKE_editmesh.h"
43 #include "BKE_lattice.h"
44 #include "BKE_library.h"
45 #include "BKE_library_query.h"
46 #include "BKE_mesh.h"
47 #include "BKE_modifier.h"
48
49 #include "MEM_guardedalloc.h"
50
51 #include "MOD_util.h"
52
53 static void initData(ModifierData *md)
54 {
55         LatticeModifierData *lmd = (LatticeModifierData *) md;
56         lmd->strength = 1.0f;
57 }
58
59 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *md)
60 {
61         LatticeModifierData *lmd = (LatticeModifierData *)md;
62         CustomDataMask dataMask = 0;
63
64         /* ask for vertexgroups if we need them */
65         if (lmd->name[0]) dataMask |= CD_MASK_MDEFORMVERT;
66
67         return dataMask;
68 }
69
70 static bool isDisabled(ModifierData *md, int UNUSED(userRenderParams))
71 {
72         LatticeModifierData *lmd = (LatticeModifierData *) md;
73
74         return !lmd->object;
75 }
76
77 static void foreachObjectLink(
78         ModifierData *md, Object *ob,
79         ObjectWalkFunc walk, void *userData)
80 {
81         LatticeModifierData *lmd = (LatticeModifierData *) md;
82
83         walk(userData, ob, &lmd->object, IDWALK_CB_NOP);
84 }
85
86 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
87 {
88         LatticeModifierData *lmd = (LatticeModifierData *)md;
89         if (lmd->object != NULL) {
90                 DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_GEOMETRY, "Lattice Modifier");
91                 DEG_add_object_relation(ctx->node, lmd->object, DEG_OB_COMP_TRANSFORM, "Lattice Modifier");
92         }
93         DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "Lattice Modifier");
94 }
95
96 static void deformVerts(ModifierData *md, const ModifierEvalContext *ctx,
97                         struct Mesh *mesh,
98                         float (*vertexCos)[3],
99                         int numVerts)
100 {
101         LatticeModifierData *lmd = (LatticeModifierData *) md;
102         struct Mesh *mesh_src = mesh ? mesh : ctx->object->data;
103
104         modifier_vgroup_cache(md, vertexCos); /* if next modifier needs original vertices */
105
106         lattice_deform_verts(lmd->object, ctx->object, mesh_src,
107                              vertexCos, numVerts, lmd->name, lmd->strength);
108 }
109
110 static void deformVertsEM(
111         ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *em,
112         struct Mesh *mesh, float (*vertexCos)[3], int numVerts)
113 {
114         struct Mesh *mesh_src = mesh;
115
116         if (!mesh) {
117                 mesh_src = BKE_bmesh_to_mesh_nomain(em->bm, &(struct BMeshToMeshParams){0});
118         }
119
120         deformVerts(md, ctx, mesh_src, vertexCos, numVerts);
121
122         if (!mesh) {
123                 BKE_id_free(NULL, mesh_src);
124         }
125 }
126
127
128 ModifierTypeInfo modifierType_Lattice = {
129         /* name */              "Lattice",
130         /* structName */        "LatticeModifierData",
131         /* structSize */        sizeof(LatticeModifierData),
132         /* type */              eModifierTypeType_OnlyDeform,
133         /* flags */             eModifierTypeFlag_AcceptsCVs |
134                                 eModifierTypeFlag_AcceptsLattice |
135                                 eModifierTypeFlag_SupportsEditmode,
136
137         /* copyData */          modifier_copyData_generic,
138
139         /* deformVerts_DM */    NULL,
140         /* deformMatrices_DM */ NULL,
141         /* deformVertsEM_DM */  NULL,
142         /* deformMatricesEM_DM*/NULL,
143         /* applyModifier_DM */  NULL,
144         /* applyModifierEM_DM */NULL,
145
146         /* deformVerts */       deformVerts,
147         /* deformMatrices */    NULL,
148         /* deformVertsEM */     deformVertsEM,
149         /* deformMatricesEM */  NULL,
150         /* applyModifier */     NULL,
151         /* applyModifierEM */   NULL,
152
153         /* initData */          initData,
154         /* requiredDataMask */  requiredDataMask,
155         /* freeData */          NULL,
156         /* isDisabled */        isDisabled,
157         /* updateDepsgraph */   updateDepsgraph,
158         /* dependsOnTime */     NULL,
159         /* dependsOnNormals */  NULL,
160         /* foreachObjectLink */ foreachObjectLink,
161         /* foreachIDLink */     NULL,
162         /* foreachTexLink */    NULL,
163 };