Merge branch 'master' into blender2.8
[blender.git] / source / blender / modifiers / intern / MOD_armature.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_armature.c
32  *  \ingroup modifiers
33  */
34
35
36 #include <string.h>
37
38 #include "DNA_armature_types.h"
39 #include "DNA_object_types.h"
40 #include "DNA_mesh_types.h"
41
42 #include "BLI_utildefines.h"
43 #include "BLI_string.h"
44
45 #include "BKE_editmesh.h"
46 #include "BKE_lattice.h"
47 #include "BKE_library.h"
48 #include "BKE_library_query.h"
49 #include "BKE_mesh.h"
50 #include "BKE_modifier.h"
51
52 #include "bmesh.h"
53 #include "bmesh_tools.h"
54
55 #include "MEM_guardedalloc.h"
56
57 #include "MOD_util.h"
58
59
60 static void initData(ModifierData *md)
61 {
62         ArmatureModifierData *amd = (ArmatureModifierData *) md;
63         
64         amd->deformflag = ARM_DEF_VGROUP;
65 }
66
67 static void copyData(ModifierData *md, ModifierData *target)
68 {
69 #if 0
70         ArmatureModifierData *amd = (ArmatureModifierData *) md;
71 #endif
72         ArmatureModifierData *tamd = (ArmatureModifierData *) target;
73
74         modifier_copyData_generic(md, target);
75         tamd->prevCos = NULL;
76 }
77
78 static CustomDataMask requiredDataMask(Object *UNUSED(ob), ModifierData *UNUSED(md))
79 {
80         CustomDataMask dataMask = 0;
81
82         /* ask for vertexgroups */
83         dataMask |= CD_MASK_MDEFORMVERT;
84
85         return dataMask;
86 }
87
88 static bool isDisabled(ModifierData *md, int UNUSED(useRenderParams))
89 {
90         ArmatureModifierData *amd = (ArmatureModifierData *) md;
91
92         return !amd->object;
93 }
94
95 static void foreachObjectLink(
96         ModifierData *md, Object *ob,
97         ObjectWalkFunc walk, void *userData)
98 {
99         ArmatureModifierData *amd = (ArmatureModifierData *) md;
100
101         walk(userData, ob, &amd->object, IDWALK_CB_NOP);
102 }
103
104 static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
105 {
106         ArmatureModifierData *amd = (ArmatureModifierData *)md;
107         if (amd->object != NULL) {
108                 DEG_add_object_relation(ctx->node, amd->object, DEG_OB_COMP_EVAL_POSE, "Armature Modifier");
109                 DEG_add_object_relation(ctx->node, amd->object, DEG_OB_COMP_TRANSFORM, "Armature Modifier");
110         }
111         DEG_add_object_relation(ctx->node, ctx->object, DEG_OB_COMP_TRANSFORM, "Armature Modifier");
112 }
113
114 static void deformVerts(ModifierData *md, const ModifierEvalContext *ctx,
115                         Mesh *mesh,
116                         float (*vertexCos)[3],
117                         int numVerts)
118 {
119         ArmatureModifierData *amd = (ArmatureModifierData *) md;
120
121         modifier_vgroup_cache(md, vertexCos); /* if next modifier needs original vertices */
122         
123         armature_deform_verts(amd->object, ctx->object, mesh, vertexCos, NULL,
124                               numVerts, amd->deformflag, (float(*)[3])amd->prevCos, amd->defgrp_name);
125
126         /* free cache */
127         if (amd->prevCos) {
128                 MEM_freeN(amd->prevCos);
129                 amd->prevCos = NULL;
130         }
131 }
132
133 static void deformVertsEM(
134         ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *em,
135         Mesh *mesh, float (*vertexCos)[3], int numVerts)
136 {
137         ArmatureModifierData *amd = (ArmatureModifierData *) md;
138         Mesh *mesh_src = mesh;
139
140         if (!mesh) {
141                 mesh_src = BKE_bmesh_to_mesh(em->bm, &(struct BMeshToMeshParams){0});
142         }
143
144         modifier_vgroup_cache(md, vertexCos); /* if next modifier needs original vertices */
145
146         armature_deform_verts(amd->object, ctx->object, mesh_src, vertexCos, NULL,
147                               numVerts, amd->deformflag, (float(*)[3])amd->prevCos, amd->defgrp_name);
148
149         /* free cache */
150         if (amd->prevCos) {
151                 MEM_freeN(amd->prevCos);
152                 amd->prevCos = NULL;
153         }
154
155         if (!mesh) {
156                 BKE_id_free(NULL, mesh_src);
157         }
158 }
159
160 static void deformMatricesEM(
161         ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *em,
162         Mesh *mesh, float (*vertexCos)[3],
163         float (*defMats)[3][3], int numVerts)
164 {
165         ArmatureModifierData *amd = (ArmatureModifierData *) md;
166         Mesh *mesh_src = mesh;
167
168         if (!mesh) {
169                 mesh_src = BKE_bmesh_to_mesh(em->bm, &(struct BMeshToMeshParams){0});
170         }
171
172         armature_deform_verts(amd->object, ctx->object, mesh_src, vertexCos, defMats, numVerts,
173                               amd->deformflag, NULL, amd->defgrp_name);
174
175         if (!mesh) {
176                 BKE_id_free(NULL, mesh_src);
177         }
178 }
179
180 static void deformMatrices(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh,
181                            float (*vertexCos)[3], float (*defMats)[3][3], int numVerts)
182 {
183         ArmatureModifierData *amd = (ArmatureModifierData *) md;
184         Mesh *mesh_src = mesh ? mesh : ctx->object->data;
185
186         armature_deform_verts(amd->object, ctx->object, mesh_src, vertexCos, defMats, numVerts,
187                               amd->deformflag, NULL, amd->defgrp_name);
188 }
189
190 ModifierTypeInfo modifierType_Armature = {
191         /* name */              "Armature",
192         /* structName */        "ArmatureModifierData",
193         /* structSize */        sizeof(ArmatureModifierData),
194         /* type */              eModifierTypeType_OnlyDeform,
195         /* flags */             eModifierTypeFlag_AcceptsCVs |
196                                 eModifierTypeFlag_AcceptsLattice |
197                                 eModifierTypeFlag_SupportsEditmode,
198
199         /* copyData */          copyData,
200
201         /* deformVerts_DM */    NULL,
202         /* deformMatrices_DM */ NULL,
203         /* deformVertsEM_DM */  NULL,
204         /* deformMatricesEM_DM*/NULL,
205         /* applyModifier_DM */  NULL,
206         /* applyModifierEM_DM */NULL,
207
208         /* deformVerts */       deformVerts,
209         /* deformMatrices */    deformMatrices,
210         /* deformVertsEM */     deformVertsEM,
211         /* deformMatricesEM */  deformMatricesEM,
212         /* applyModifier */     NULL,
213         /* applyModifierEM */   NULL,
214
215         /* initData */          initData,
216         /* requiredDataMask */  requiredDataMask,
217         /* freeData */          NULL,
218         /* isDisabled */        isDisabled,
219         /* updateDepsgraph */   updateDepsgraph,
220         /* dependsOnTime */     NULL,
221         /* dependsOnNormals */  NULL,
222         /* foreachObjectLink */ foreachObjectLink,
223         /* foreachIDLink */     NULL,
224         /* foreachTexLink */    NULL,
225 };