Blender  V3.3
MOD_armature.c
Go to the documentation of this file.
1 /* SPDX-License-Identifier: GPL-2.0-or-later
2  * Copyright 2005 Blender Foundation. All rights reserved. */
3 
8 #include <string.h>
9 
10 #include "BLI_listbase.h"
11 #include "BLI_utildefines.h"
12 
13 #include "BLT_translation.h"
14 
15 #include "DNA_armature_types.h"
16 #include "DNA_defaults.h"
17 #include "DNA_mesh_types.h"
18 #include "DNA_object_types.h"
19 #include "DNA_screen_types.h"
20 
21 #include "BKE_action.h"
22 #include "BKE_armature.h"
23 #include "BKE_context.h"
24 #include "BKE_deform.h"
25 #include "BKE_editmesh.h"
26 #include "BKE_lib_id.h"
27 #include "BKE_lib_query.h"
28 #include "BKE_mesh.h"
29 #include "BKE_mesh_wrapper.h"
30 #include "BKE_modifier.h"
31 #include "BKE_screen.h"
32 
33 #include "UI_interface.h"
34 #include "UI_resources.h"
35 
36 #include "RNA_access.h"
37 #include "RNA_prototypes.h"
38 
39 #include "BLO_read_write.h"
40 
41 #include "DEG_depsgraph_query.h"
42 
43 #include "bmesh.h"
44 #include "bmesh_tools.h"
45 
46 #include "MEM_guardedalloc.h"
47 
48 #include "MOD_ui_common.h"
49 #include "MOD_util.h"
50 
51 static void initData(ModifierData *md)
52 {
54 
56 
58 }
59 
60 static void copyData(const ModifierData *md, ModifierData *target, const int flag)
61 {
62 #if 0
63  const ArmatureModifierData *amd = (const ArmatureModifierData *)md;
64 #endif
66 
67  BKE_modifier_copydata_generic(md, target, flag);
68  tamd->vert_coords_prev = NULL;
69 }
70 
71 static void requiredDataMask(Object *UNUSED(ob),
72  ModifierData *UNUSED(md),
73  CustomData_MeshMasks *r_cddata_masks)
74 {
75  /* ask for vertexgroups */
76  r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
77 }
78 
79 static bool isDisabled(const struct Scene *UNUSED(scene),
80  ModifierData *md,
81  bool UNUSED(useRenderParams))
82 {
84 
85  /* The object type check is only needed here in case we have a placeholder
86  * object assigned (because the library containing the armature is missing).
87  *
88  * In other cases it should be impossible to have a type mismatch.
89  */
90  return !amd->object || amd->object->type != OB_ARMATURE;
91 }
92 
93 static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
94 {
96 
97  walk(userData, ob, (ID **)&amd->object, IDWALK_CB_NOP);
98 }
99 
101 {
103  if (amd->object != NULL) {
104  /* If not using envelopes,
105  * create relations to individual bones for more rigging flexibility. */
106  if ((amd->deformflag & ARM_DEF_ENVELOPE) == 0 && (amd->object->pose != NULL) &&
108  /* If neither vertex groups nor envelopes are used, the modifier has no bone dependencies. */
109  if ((amd->deformflag & ARM_DEF_VGROUP) != 0) {
110  /* Enumerate groups that match existing bones. */
111  const ListBase *defbase = BKE_object_defgroup_list(ctx->object);
112  LISTBASE_FOREACH (bDeformGroup *, dg, defbase) {
113  if (BKE_pose_channel_find_name(amd->object->pose, dg->name) != NULL) {
114  /* Can't check BONE_NO_DEFORM because it can be animated. */
116  ctx->node, amd->object, dg->name, DEG_OB_COMP_BONE, "Armature Modifier");
117  }
118  }
119  }
120  }
121  /* Otherwise require the whole pose to be complete. */
122  else {
123  DEG_add_object_relation(ctx->node, amd->object, DEG_OB_COMP_EVAL_POSE, "Armature Modifier");
124  }
125 
126  DEG_add_object_relation(ctx->node, amd->object, DEG_OB_COMP_TRANSFORM, "Armature Modifier");
127  }
128  DEG_add_modifier_to_transform_relation(ctx->node, "Armature Modifier");
129 }
130 
131 static void deformVerts(ModifierData *md,
132  const ModifierEvalContext *ctx,
133  Mesh *mesh,
134  float (*vertexCos)[3],
135  int verts_num)
136 {
138 
139  MOD_previous_vcos_store(md, vertexCos); /* if next modifier needs original vertices */
140 
142  ctx->object,
143  vertexCos,
144  NULL,
145  verts_num,
146  amd->deformflag,
147  amd->vert_coords_prev,
148  amd->defgrp_name,
149  mesh);
150 
151  /* free cache */
153 }
154 
155 static void deformVertsEM(ModifierData *md,
156  const ModifierEvalContext *ctx,
157  struct BMEditMesh *em,
158  Mesh *mesh,
159  float (*vertexCos)[3],
160  int verts_num)
161 {
162  if (mesh != NULL) {
163  deformVerts(md, ctx, mesh, vertexCos, verts_num);
164  return;
165  }
166 
168 
169  MOD_previous_vcos_store(md, vertexCos); /* if next modifier needs original vertices */
170 
172  ctx->object,
173  vertexCos,
174  NULL,
175  verts_num,
176  amd->deformflag,
177  amd->vert_coords_prev,
178  amd->defgrp_name,
179  em);
180 
181  /* free cache */
183 }
184 
186  const ModifierEvalContext *ctx,
187  struct BMEditMesh *em,
188  Mesh *UNUSED(mesh),
189  float (*vertexCos)[3],
190  float (*defMats)[3][3],
191  int verts_num)
192 {
194 
196  ctx->object,
197  vertexCos,
198  defMats,
199  verts_num,
200  amd->deformflag,
201  NULL,
202  amd->defgrp_name,
203  em);
204 }
205 
206 static void deformMatrices(ModifierData *md,
207  const ModifierEvalContext *ctx,
208  Mesh *mesh,
209  float (*vertexCos)[3],
210  float (*defMats)[3][3],
211  int verts_num)
212 {
214  Mesh *mesh_src = MOD_deform_mesh_eval_get(
215  ctx->object, NULL, mesh, NULL, verts_num, false, false);
216 
218  ctx->object,
219  vertexCos,
220  defMats,
221  verts_num,
222  amd->deformflag,
223  NULL,
224  amd->defgrp_name,
225  mesh_src);
226 
227  if (!ELEM(mesh_src, NULL, mesh)) {
228  BKE_id_free(NULL, mesh_src);
229  }
230 }
231 
232 static void panel_draw(const bContext *UNUSED(C), Panel *panel)
233 {
234  uiLayout *col;
235  uiLayout *layout = panel->layout;
236 
237  PointerRNA ob_ptr;
239 
240  uiLayoutSetPropSep(layout, true);
241 
242  uiItemR(layout, ptr, "object", 0, NULL, ICON_NONE);
243  modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", NULL);
244 
245  col = uiLayoutColumn(layout, true);
246  uiItemR(col, ptr, "use_deform_preserve_volume", 0, NULL, ICON_NONE);
247  uiItemR(col, ptr, "use_multi_modifier", 0, NULL, ICON_NONE);
248 
249  col = uiLayoutColumnWithHeading(layout, true, IFACE_("Bind To"));
250  uiItemR(col, ptr, "use_vertex_groups", 0, IFACE_("Vertex Groups"), ICON_NONE);
251  uiItemR(col, ptr, "use_bone_envelopes", 0, IFACE_("Bone Envelopes"), ICON_NONE);
252 
253  modifier_panel_end(layout, ptr);
254 }
255 
256 static void panelRegister(ARegionType *region_type)
257 {
259 }
260 
261 static void blendRead(BlendDataReader *UNUSED(reader), ModifierData *md)
262 {
264 
265  amd->vert_coords_prev = NULL;
266 }
267 
269  /* name */ N_("Armature"),
270  /* structName */ "ArmatureModifierData",
271  /* structSize */ sizeof(ArmatureModifierData),
272  /* srna */ &RNA_ArmatureModifier,
273  /* type */ eModifierTypeType_OnlyDeform,
276  /* icon */ ICON_MOD_ARMATURE,
277 
278  /* copyData */ copyData,
279 
280  /* deformVerts */ deformVerts,
281  /* deformMatrices */ deformMatrices,
282  /* deformVertsEM */ deformVertsEM,
283  /* deformMatricesEM */ deformMatricesEM,
284  /* modifyMesh */ NULL,
285  /* modifyGeometrySet */ NULL,
286 
287  /* initData */ initData,
288  /* requiredDataMask */ requiredDataMask,
289  /* freeData */ NULL,
290  /* isDisabled */ isDisabled,
291  /* updateDepsgraph */ updateDepsgraph,
292  /* dependsOnTime */ NULL,
293  /* dependsOnNormals */ NULL,
294  /* foreachIDLink */ foreachIDLink,
295  /* foreachTexLink */ NULL,
296  /* freeRuntimeData */ NULL,
297  /* panelRegister */ panelRegister,
298  /* blendWrite */ NULL,
299  /* blendRead */ blendRead,
300 };
Blender kernel action and pose functionality.
struct bPoseChannel * BKE_pose_channel_find_name(const struct bPose *pose, const char *name)
void BKE_armature_deform_coords_with_editmesh(const struct Object *ob_arm, const struct Object *ob_target, float(*vert_coords)[3], float(*vert_deform_mats)[3][3], int vert_coords_len, int deformflag, float(*vert_coords_prev)[3], const char *defgrp_name, struct BMEditMesh *em_target)
void BKE_armature_deform_coords_with_mesh(const struct Object *ob_arm, const struct Object *ob_target, float(*vert_coords)[3], float(*vert_deform_mats)[3][3], int vert_coords_len, int deformflag, float(*vert_coords_prev)[3], const char *defgrp_name, const struct Mesh *me_target)
support for deformation groups and hooks.
const struct ListBase * BKE_object_defgroup_list(const struct Object *ob)
void BKE_id_free(struct Main *bmain, void *idv)
@ IDWALK_CB_NOP
Definition: BKE_lib_query.h:33
void(* IDWalkFunc)(void *userData, struct Object *ob, struct ID **idpoin, int cb_flag)
Definition: BKE_modifier.h:107
@ eModifierTypeFlag_AcceptsCVs
Definition: BKE_modifier.h:67
@ eModifierTypeFlag_SupportsEditmode
Definition: BKE_modifier.h:69
@ eModifierTypeFlag_AcceptsVertexCosOnly
Definition: BKE_modifier.h:100
void BKE_modifier_copydata_generic(const struct ModifierData *md, struct ModifierData *md_dst, int flag)
@ eModifierTypeType_OnlyDeform
Definition: BKE_modifier.h:44
#define BLI_assert(a)
Definition: BLI_assert.h:46
#define LISTBASE_FOREACH(type, var, list)
Definition: BLI_listbase.h:336
#define UNUSED(x)
#define ELEM(...)
#define MEMCMP_STRUCT_AFTER_IS_ZERO(struct_var, member)
#define MEMCPY_STRUCT_AFTER(struct_dst, struct_src, member)
#define IFACE_(msgid)
void DEG_add_object_relation(struct DepsNodeHandle *node_handle, struct Object *object, eDepsObjectComponentType component, const char *description)
void DEG_add_modifier_to_transform_relation(struct DepsNodeHandle *node_handle, const char *description)
@ DEG_OB_COMP_EVAL_POSE
@ DEG_OB_COMP_TRANSFORM
@ DEG_OB_COMP_BONE
void DEG_add_bone_relation(struct DepsNodeHandle *handle, struct Object *object, const char *bone_name, eDepsObjectComponentType component, const char *description)
@ ARM_DEF_VGROUP
@ ARM_DEF_ENVELOPE
#define CD_MASK_MDEFORMVERT
#define DNA_struct_default_get(struct_name)
Definition: DNA_defaults.h:29
@ eModifierType_Armature
struct ArmatureModifierData ArmatureModifierData
Object is a sort of wrapper for general info.
@ OB_LATTICE
@ OB_ARMATURE
@ OB_MESH
@ OB_GPENCIL
Read Guarded memory(de)allocation.
#define MEM_SAFE_FREE(v)
static void blendRead(BlendDataReader *UNUSED(reader), ModifierData *md)
Definition: MOD_armature.c:261
static void copyData(const ModifierData *md, ModifierData *target, const int flag)
Definition: MOD_armature.c:60
static void deformVerts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, float(*vertexCos)[3], int verts_num)
Definition: MOD_armature.c:131
static void deformVertsEM(ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *em, Mesh *mesh, float(*vertexCos)[3], int verts_num)
Definition: MOD_armature.c:155
static void updateDepsgraph(ModifierData *md, const ModifierUpdateDepsgraphContext *ctx)
Definition: MOD_armature.c:100
static bool isDisabled(const struct Scene *UNUSED(scene), ModifierData *md, bool UNUSED(useRenderParams))
Definition: MOD_armature.c:79
static void requiredDataMask(Object *UNUSED(ob), ModifierData *UNUSED(md), CustomData_MeshMasks *r_cddata_masks)
Definition: MOD_armature.c:71
static void foreachIDLink(ModifierData *md, Object *ob, IDWalkFunc walk, void *userData)
Definition: MOD_armature.c:93
static void deformMatrices(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, float(*vertexCos)[3], float(*defMats)[3][3], int verts_num)
Definition: MOD_armature.c:206
static void panel_draw(const bContext *UNUSED(C), Panel *panel)
Definition: MOD_armature.c:232
static void initData(ModifierData *md)
Definition: MOD_armature.c:51
static void panelRegister(ARegionType *region_type)
Definition: MOD_armature.c:256
ModifierTypeInfo modifierType_Armature
Definition: MOD_armature.c:268
static void deformMatricesEM(ModifierData *md, const ModifierEvalContext *ctx, struct BMEditMesh *em, Mesh *UNUSED(mesh), float(*vertexCos)[3], float(*defMats)[3][3], int verts_num)
Definition: MOD_armature.c:185
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void modifier_panel_end(uiLayout *layout, PointerRNA *ptr)
Definition: MOD_ui_common.c:91
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
void modifier_vgroup_ui(uiLayout *layout, PointerRNA *ptr, PointerRNA *ob_ptr, const char *vgroup_prop, const char *invert_vgroup_prop, const char *text)
Mesh * MOD_deform_mesh_eval_get(Object *ob, struct BMEditMesh *em, Mesh *mesh, const float(*vertexCos)[3], const int verts_num, const bool use_normals, const bool use_orco)
Definition: MOD_util.c:167
void MOD_previous_vcos_store(ModifierData *md, const float(*vert_coords)[3])
Definition: MOD_util.c:153
#define C
Definition: RandGen.cpp:25
uiLayout * uiLayoutColumnWithHeading(uiLayout *layout, bool align, const char *heading)
uiLayout * uiLayoutColumn(uiLayout *layout, bool align)
void uiLayoutSetPropSep(uiLayout *layout, bool is_sep)
void uiItemR(uiLayout *layout, struct PointerRNA *ptr, const char *propname, int flag, const char *name, int icon)
Scene scene
uint col
Definition: DNA_ID.h:368
struct Object * object
Definition: BKE_modifier.h:141
struct DepsNodeHandle * node
Definition: BKE_modifier.h:134
ustring name
Definition: graph/node.h:174
struct bPose * pose
struct uiLayout * layout
#define N_(msgid)
PointerRNA * ptr
Definition: wm_files.c:3480