Blender V5.3
MOD_armature.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2005 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstring>
10
11#include "BLI_listbase.hh"
12#include "BLI_utildefines.hh"
13
14#include "BLT_translation.hh"
15
16#include "DNA_armature_types.h"
17#include "DNA_mesh_types.h"
18#include "DNA_object_types.h"
19#include "DNA_screen_types.h"
20
21#include "BKE_action.hh"
22#include "BKE_armature.hh"
23#include "BKE_deform.hh"
24#include "BKE_editmesh.hh"
25#include "BKE_lib_query.hh"
26#include "BKE_mesh.hh"
27#include "BKE_modifier.hh"
28
30#include "UI_resources.hh"
31
32#include "RNA_prototypes.hh"
33#include "RNA_types.hh"
34
35#include "MEM_guardedalloc.h"
36
37#include "MOD_ui_common.hh"
38#include "MOD_util.hh"
39
40namespace blender {
41
42static void init_data(ModifierData *md)
43{
44 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
46}
47
48static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
49{
50#if 0
51 const ArmatureModifierData *amd = (const ArmatureModifierData *)md;
52#endif
53 ArmatureModifierData *tamd = reinterpret_cast<ArmatureModifierData *>(target);
54
55 BKE_modifier_copydata_generic(md, target, flag);
56 tamd->vert_coords_prev = nullptr;
57}
58
59static void required_data_mask(ModifierData * /*md*/, CustomData_MeshMasks *r_cddata_masks)
60{
61 /* Ask for vertex-groups. */
62 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
63}
64
65static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
66{
67 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
68
69 /* The object type check is only needed here in case we have a placeholder
70 * object assigned (because the library containing the armature is missing).
71 *
72 * In other cases it should be impossible to have a type mismatch.
73 */
74 return !amd->object || amd->object->type != OB_ARMATURE;
75}
76
77static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
78{
79 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
80
81 walk(user_data, ob, reinterpret_cast<ID **>(&amd->object), IDWALK_CB_NOP);
82}
83
85{
86 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
87 if (amd->object != nullptr) {
88 /* If not using envelopes,
89 * create relations to individual bones for more rigging flexibility. */
90 if ((amd->deformflag & ARM_DEF_ENVELOPE) == 0 && (amd->object->pose != nullptr) &&
92 {
93 /* If neither vertex groups nor envelopes are used, the modifier has no bone dependencies. */
94 if ((amd->deformflag & ARM_DEF_VGROUP) != 0) {
95 /* Enumerate groups that match existing bones. */
96 const ListBaseT<bDeformGroup> *defbase = BKE_object_defgroup_list(ctx->object);
97 for (bDeformGroup &dg : *defbase) {
98 if (BKE_pose_channel_find_name(amd->object->pose, dg.name) != nullptr) {
99 /* Can't check BONE_NO_DEFORM because it can be animated. */
101 ctx->node, amd->object, dg.name, DEG_OB_COMP_BONE, "Armature Modifier");
102 }
103 }
104 }
105 }
106 /* Otherwise require the whole pose to be complete. */
107 else {
108 DEG_add_object_relation(ctx->node, amd->object, DEG_OB_COMP_EVAL_POSE, "Armature Modifier");
109 }
110
111 DEG_add_object_relation(ctx->node, amd->object, DEG_OB_COMP_TRANSFORM, "Armature Modifier");
112 }
113 DEG_add_depends_on_transform_relation(ctx->node, "Armature Modifier");
114}
115
117 const ModifierEvalContext *ctx,
118 Mesh *mesh,
119 MutableSpan<float3> positions)
120{
121 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
122 std::optional<Span<float3>> vert_coords_prev;
123 if (amd->vert_coords_prev) {
124 vert_coords_prev = {reinterpret_cast<float3 *>(amd->vert_coords_prev), positions.size()};
125 }
126
127 /* if next modifier needs original vertices */
128 MOD_previous_vcos_store(md, reinterpret_cast<float (*)[3]>(positions.data()));
129
131 *ctx->object,
132 positions,
133 vert_coords_prev,
134 std::nullopt,
135 amd->deformflag,
136 amd->defgrp_name,
137 mesh);
138
139 /* free cache */
140 MEM_SAFE_DELETE(amd->vert_coords_prev);
141}
142
144 const ModifierEvalContext *ctx,
145 Mesh *mesh,
146 MutableSpan<float3> positions)
147{
148 if (mesh->runtime->wrapper_type == ME_WRAPPER_TYPE_MDATA) {
149 deform_verts(md, ctx, mesh, positions);
150 return;
151 }
152
153 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
154 std::optional<Span<float3>> vert_coords_prev;
155 if (amd->vert_coords_prev) {
156 vert_coords_prev = {reinterpret_cast<float3 *>(amd->vert_coords_prev), positions.size()};
157 }
158
159 /* if next modifier needs original vertices */
160 MOD_previous_vcos_store(md, reinterpret_cast<float (*)[3]>(positions.data()));
161
163 *ctx->object,
164 positions,
165 vert_coords_prev,
166 std::nullopt,
167 amd->deformflag,
168 amd->defgrp_name,
170
171 /* free cache */
172 MEM_SAFE_DELETE(amd->vert_coords_prev);
173}
174
176 const ModifierEvalContext *ctx,
177 Mesh *mesh,
178 MutableSpan<float3> positions,
179 MutableSpan<float3x3> matrices)
180{
181 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
183 *ctx->object,
184 positions,
185 std::nullopt,
186 matrices,
187 amd->deformflag,
188 amd->defgrp_name,
190}
191
193 const ModifierEvalContext *ctx,
194 Mesh *mesh,
195 MutableSpan<float3> positions,
196 MutableSpan<float3x3> matrices)
197{
198 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
200 *ctx->object,
201 positions,
202 std::nullopt,
203 matrices,
204 amd->deformflag,
205 amd->defgrp_name,
206 mesh);
207}
208
209static void panel_draw(const bContext * /*C*/, Panel *panel)
210{
211 ui::Layout &layout = *panel->layout;
212
213 PointerRNA ob_ptr;
215
216 layout.use_property_split_set(true);
217
218 layout.prop(ptr, "object", UI_ITEM_NONE, std::nullopt, ICON_NONE);
219 modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
220
221 ui::Layout *col = &layout.column(true);
222 col->prop(ptr, "use_deform_preserve_volume", UI_ITEM_NONE, std::nullopt, ICON_NONE);
223 col->prop(ptr, "use_multi_modifier", UI_ITEM_NONE, std::nullopt, ICON_NONE);
224
225 col = &layout.column(true, IFACE_("Bind To"));
226 col->prop(ptr, "use_vertex_groups", UI_ITEM_NONE, IFACE_("Vertex Groups"), ICON_NONE);
227 col->prop(ptr, "use_bone_envelopes", UI_ITEM_NONE, IFACE_("Bone Envelopes"), ICON_NONE);
228
229 modifier_error_message_draw(layout, ptr);
230}
231
232static void panel_register(ARegionType *region_type)
233{
235}
236
237static void blend_read(BlendDataReader * /*reader*/, ModifierData *md)
238{
239 ArmatureModifierData *amd = reinterpret_cast<ArmatureModifierData *>(md);
240
241 amd->vert_coords_prev = nullptr;
242}
243
245 /*idname*/ "Armature",
246 /*name*/ N_("Armature"),
247 /*struct_name*/ "ArmatureModifierData",
248 /*struct_size*/ sizeof(ArmatureModifierData),
249 /*srna*/ &RNA_ArmatureModifier,
253 /*icon*/ ICON_MOD_ARMATURE,
254
255 /*copy_data*/ copy_data,
256
257 /*deform_verts*/ deform_verts,
258 /*deform_matrices*/ deform_matrices,
259 /*deform_verts_EM*/ deform_verts_EM,
260 /*deform_matrices_EM*/ deform_matrices_EM,
261 /*modify_mesh*/ nullptr,
262 /*modify_geometry_set*/ nullptr,
263
264 /*init_data*/ init_data,
265 /*required_data_mask*/ required_data_mask,
266 /*free_data*/ nullptr,
267 /*is_disabled*/ is_disabled,
268 /*update_depsgraph*/ update_depsgraph,
269 /*depends_on_time*/ nullptr,
270 /*depends_on_normals*/ nullptr,
271 /*foreach_ID_link*/ foreach_ID_link,
272 /*foreach_tex_link*/ nullptr,
273 /*free_runtime_data*/ nullptr,
274 /*panel_register*/ panel_register,
275 /*blend_write*/ nullptr,
276 /*blend_read*/ blend_read,
277 /*foreach_cache*/ nullptr,
278 /*foreach_working_space_color*/ nullptr,
279};
280
281} // namespace blender
Blender kernel action and pose functionality.
support for deformation groups and hooks.
#define IFACE_(msgid)
Object is a sort of wrapper for general info.
Read Blender memory allocation and freeing.
#define UI_ITEM_NONE
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define ELEM(...)
#define CD_MASK_MDEFORMVERT
constexpr int64_t size() const
Definition BLI_span.hh:499
constexpr T * data() const
Definition BLI_span.hh:545
BMesh Iterators.
static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
const ListBaseT< bDeformGroup > * BKE_object_defgroup_list(const Object *ob)
Definition deform.cc:591
static void init_data(ModifierData *md)
void(*)(void *user_data, Object *ob, ID **idpoin, LibraryForeachIDCallbackFlag cb_flag) IDWalkFunc
static void update_depsgraph(tGraphSliderOp *gso)
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
void DEG_add_object_relation(DepsNodeHandle *node_handle, Object *object, eDepsObjectComponentType component, const char *description)
void DEG_add_bone_relation(DepsNodeHandle *handle, Object *object, const char *bone_name, eDepsObjectComponentType component, const char *description)
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
void modifier_vgroup_ui(ui::Layout &layout, PointerRNA *ptr, PointerRNA *ob_ptr, const StringRefNull vgroup_prop, const std::optional< StringRefNull > invert_vgroup_prop, const std::optional< StringRefNull > text)
static void deform_verts_EM(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
static void panel_register(ARegionType *region_type)
static void deform_matrices(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions, MutableSpan< float3x3 > matrices)
void BKE_armature_deform_coords_with_mesh(const Object &ob_arm, const Object &ob_target, MutableSpan< float3 > vert_coords, std::optional< Span< float3 > > vert_coords_prev, std::optional< MutableSpan< float3x3 > > vert_deform_mats, int deformflag, StringRefNull defgrp_name, const Mesh *me_target)
@ eModifierTypeFlag_AcceptsCVs
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsVertexCosOnly
static void blend_read(BlendDataReader *, ModifierData *md)
static void deform_matrices_EM(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions, MutableSpan< float3x3 > matrices)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
void BKE_armature_deform_coords_with_editmesh(const Object &ob_arm, const Object &ob_target, MutableSpan< float3 > vert_coords, std::optional< Span< float3 > > vert_coords_prev, std::optional< MutableSpan< float3x3 > > vert_deform_mats, int deformflag, StringRefNull defgrp_name, const BMesh &bm_target)
void MOD_previous_vcos_store(ModifierData *md, const float(*vert_coords)[3])
Definition MOD_util.cc:144
const BMesh * BKE_editmesh_bmesh_get(const Object *ob)
Definition editmesh.cc:65
static void panel_draw(const bContext *, Panel *panel)
static void deform_verts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
VecBase< float, 3 > float3
@ ME_WRAPPER_TYPE_MDATA
static bool is_disabled(const Scene *, ModifierData *md, bool)
ModifierTypeInfo modifierType_Armature
bPoseChannel * BKE_pose_channel_find_name(const bPose *pose, const char *name)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
struct bPose * pose
ui::Layout * layout
void use_property_split_set(bool is_sep)
void prop(PointerRNA *ptr, PropertyRNA *prop, int index, int value, eUI_Item_Flag flag, std::optional< StringRef > name_opt, int icon, std::optional< StringRef > placeholder=std::nullopt)
Layout & column(bool align)
#define N_(msgid)