Blender V5.3
MOD_shrinkwrap.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_utildefines.hh"
12
13#include "BLT_translation.hh"
14
15#include "DNA_object_types.h"
16#include "DNA_screen_types.h"
17
18#include "BKE_lib_query.hh"
19#include "BKE_modifier.hh"
20#include "BKE_shrinkwrap.hh"
21
23#include "UI_resources.hh"
24
25#include "RNA_access.hh"
26#include "RNA_prototypes.hh"
27
29
30#include "MOD_ui_common.hh"
31#include "MOD_util.hh"
32
33namespace blender {
34
35static void init_data(ModifierData *md)
36{
37 ShrinkwrapModifierData *smd = reinterpret_cast<ShrinkwrapModifierData *>(md);
39}
40
41static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
42{
43 ShrinkwrapModifierData *smd = reinterpret_cast<ShrinkwrapModifierData *>(md);
44
45 /* Ask for vertex-groups if we need them. */
46 if (smd->vgroup_name[0] != '\0') {
47 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
48 }
49}
50
51static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
52{
53 ShrinkwrapModifierData *smd = reinterpret_cast<ShrinkwrapModifierData *>(md);
54
55 /* The object type check is only needed here in case we have a placeholder
56 * object assigned (because the library containing the mesh is missing).
57 *
58 * In other cases it should be impossible to have a type mismatch.
59 */
60 if (!smd->target || smd->target->type != OB_MESH) {
61 return true;
62 }
63 if (smd->auxTarget && smd->auxTarget->type != OB_MESH) {
64 return true;
65 }
66 return false;
67}
68
69static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
70{
71 ShrinkwrapModifierData *smd = reinterpret_cast<ShrinkwrapModifierData *>(md);
72
73 walk(user_data, ob, reinterpret_cast<ID **>(&smd->target), IDWALK_CB_NOP);
74 walk(user_data, ob, reinterpret_cast<ID **>(&smd->auxTarget), IDWALK_CB_NOP);
75}
76
77static void deform_verts(ModifierData *md,
78 const ModifierEvalContext *ctx,
79 Mesh *mesh,
80 MutableSpan<float3> positions)
81{
82 ShrinkwrapModifierData *swmd = reinterpret_cast<ShrinkwrapModifierData *>(md);
84
85 const MDeformVert *dvert = nullptr;
86 int defgrp_index = -1;
87 MOD_get_vgroup(ctx->object, mesh, swmd->vgroup_name, &dvert, &defgrp_index);
88
90 ctx,
91 scene,
92 ctx->object,
93 mesh,
94 dvert,
95 defgrp_index,
96 reinterpret_cast<float (*)[3]>(positions.data()),
97 positions.size());
98}
99
101{
102 ShrinkwrapModifierData *smd = reinterpret_cast<ShrinkwrapModifierData *>(md);
103 if (smd->target != nullptr) {
104 DEG_add_object_relation(ctx->node, smd->target, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
105 DEG_add_object_relation(ctx->node, smd->target, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
108 }
109 }
110 if (smd->auxTarget != nullptr) {
112 ctx->node, smd->auxTarget, DEG_OB_COMP_TRANSFORM, "Shrinkwrap Modifier");
114 ctx->node, smd->auxTarget, DEG_OB_COMP_GEOMETRY, "Shrinkwrap Modifier");
117 }
118 }
119 DEG_add_depends_on_transform_relation(ctx->node, "Shrinkwrap Modifier");
120}
121
122static void panel_draw(const bContext * /*C*/, Panel *panel)
123{
124 ui::Layout &layout = *panel->layout;
126
127 PointerRNA ob_ptr;
129
130 layout.use_property_split_set(true);
131
132 int wrap_method = RNA_enum_get(ptr, "wrap_method");
133
134 layout.prop(ptr, "wrap_method", UI_ITEM_NONE, std::nullopt, ICON_NONE);
135
136 if (ELEM(wrap_method,
140 {
141 layout.prop(ptr, "wrap_mode", UI_ITEM_NONE, std::nullopt, ICON_NONE);
142 }
143
144 if (wrap_method == MOD_SHRINKWRAP_PROJECT) {
145 layout.prop(ptr, "project_limit", UI_ITEM_NONE, IFACE_("Limit"), ICON_NONE);
146 layout.prop(ptr, "subsurf_levels", UI_ITEM_NONE, std::nullopt, ICON_NONE);
147
148 ui::Layout *col = &layout.column(false);
149 ui::Layout &row = col->row(true, IFACE_("Axis"));
150 row.prop(ptr, "use_project_x", toggles_flag, std::nullopt, ICON_NONE);
151 row.prop(ptr, "use_project_y", toggles_flag, std::nullopt, ICON_NONE);
152 row.prop(ptr, "use_project_z", toggles_flag, std::nullopt, ICON_NONE);
153
154 col->prop(ptr, "use_negative_direction", UI_ITEM_NONE, std::nullopt, ICON_NONE);
155 col->prop(ptr, "use_positive_direction", UI_ITEM_NONE, std::nullopt, ICON_NONE);
156
157 layout.prop(ptr, "cull_face", ui::ITEM_R_EXPAND, std::nullopt, ICON_NONE);
158 col = &layout.column(false);
159 col->active_set(RNA_boolean_get(ptr, "use_negative_direction") &&
160 RNA_enum_get(ptr, "cull_face") != 0);
161 col->prop(ptr, "use_invert_cull", UI_ITEM_NONE, std::nullopt, ICON_NONE);
162 }
163
164 layout.prop(ptr, "target", UI_ITEM_NONE, std::nullopt, ICON_NONE);
165 if (wrap_method == MOD_SHRINKWRAP_PROJECT) {
166 layout.prop(ptr, "auxiliary_target", UI_ITEM_NONE, std::nullopt, ICON_NONE);
167 }
168 layout.prop(ptr, "offset", UI_ITEM_NONE, std::nullopt, ICON_NONE);
169
170 modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
171
172 modifier_error_message_draw(layout, ptr);
173}
174
175static void panel_register(ARegionType *region_type)
176{
178}
179
181 /*idname*/ "Shrinkwrap",
182 /*name*/ N_("Shrinkwrap"),
183 /*struct_name*/ "ShrinkwrapModifierData",
184 /*struct_size*/ sizeof(ShrinkwrapModifierData),
185 /*srna*/ &RNA_ShrinkwrapModifier,
190 /*icon*/ ICON_MOD_SHRINKWRAP,
191
192 /*copy_data*/ BKE_modifier_copydata_generic,
193
194 /*deform_verts*/ deform_verts,
195 /*deform_matrices*/ nullptr,
196 /*deform_verts_EM*/ nullptr,
197 /*deform_matrices_EM*/ nullptr,
198 /*modify_mesh*/ nullptr,
199 /*modify_geometry_set*/ nullptr,
200
201 /*init_data*/ init_data,
202 /*required_data_mask*/ required_data_mask,
203 /*free_data*/ nullptr,
204 /*is_disabled*/ is_disabled,
205 /*update_depsgraph*/ update_depsgraph,
206 /*depends_on_time*/ nullptr,
207 /*depends_on_normals*/ nullptr,
208 /*foreach_ID_link*/ foreach_ID_link,
209 /*foreach_tex_link*/ nullptr,
210 /*free_runtime_data*/ nullptr,
211 /*panel_register*/ panel_register,
212 /*blend_write*/ nullptr,
213 /*blend_read*/ nullptr,
214 /*foreach_cache*/ nullptr,
215 /*foreach_working_space_color*/ nullptr,
216};
217
218} // namespace blender
#define IFACE_(msgid)
Object is a sort of wrapper for general info.
#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.
ModifierTypeInfo modifierType_Shrinkwrap
int RNA_enum_get(PointerRNA *ptr, const char *name)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
void DEG_add_special_eval_flag(DepsNodeHandle *handle, ID *id, uint32_t flag)
void MOD_get_vgroup(const Object *ob, const Mesh *mesh, const char *name, const MDeformVert **dvert, int *defgrp_index)
Definition MOD_util.cc:158
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_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 panel_register(ARegionType *region_type)
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
@ MOD_SHRINKWRAP_NEAREST_SURFACE
@ MOD_SHRINKWRAP_TARGET_PROJECT
@ eModifierTypeFlag_AcceptsCVs
@ eModifierTypeFlag_EnableInEditmode
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsMesh
@ eModifierTypeFlag_AcceptsVertexCosOnly
@ DAG_EVAL_NEED_SHRINKWRAP_BOUNDARY
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
void shrinkwrapModifier_deform(ShrinkwrapModifierData *smd, const ModifierEvalContext *ctx, Scene *scene, Object *ob, Mesh *mesh, const MDeformVert *dvert, int defgrp_index, float(*vertexCos)[3], int numVerts)
static void panel_draw(const bContext *, Panel *panel)
static void deform_verts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
static bool is_disabled(const Scene *, ModifierData *md, bool)
Scene * DEG_get_evaluated_scene(const Depsgraph *graph)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
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)
void active_set(bool active)
Layout & column(bool align)
Layout & row(bool align)
#define N_(msgid)