Blender V5.3
MOD_displace.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 "BLI_utildefines.hh"
10
11#include "BLI_math_matrix_c.hh"
12#include "BLI_math_vector_c.hh"
13#include "BLI_task_c.hh"
14
15#include "BLT_translation.hh"
16
17#include "DNA_mesh_types.h"
18#include "DNA_meshdata_types.h"
19#include "DNA_object_types.h"
20#include "DNA_screen_types.h"
21#include "DNA_texture_types.h"
22
23#include "BKE_deform.hh"
24#include "BKE_image.hh"
25#include "BKE_lib_query.hh"
26#include "BKE_mesh.hh"
27#include "BKE_modifier.hh"
28#include "BKE_texture.h"
29
30#include "UI_interface.hh"
32#include "UI_resources.hh"
33
34#include "RNA_access.hh"
35#include "RNA_prototypes.hh"
36
37#include "DEG_depsgraph.hh"
39
40#include "MEM_guardedalloc.h"
41
42#include "MOD_ui_common.hh"
43#include "MOD_util.hh"
44
45#include "RE_texture.h"
46
47namespace blender {
48
49/* Displace */
50
51static void init_data(ModifierData *md)
52{
53 DisplaceModifierData *dmd = reinterpret_cast<DisplaceModifierData *>(md);
55}
56
57static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
58{
59 DisplaceModifierData *dmd = reinterpret_cast<DisplaceModifierData *>(md);
60
61 /* Ask for vertex-groups if we need them. */
62 if (dmd->defgrp_name[0] != '\0') {
63 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
64 }
65
66 /* ask for UV coordinates if we need them */
67 if (dmd->texmapping == MOD_DISP_MAP_UV) {
68 r_cddata_masks->fmask |= CD_MASK_MTFACE;
69 }
70}
71
72static bool depends_on_time(Scene * /*scene*/, ModifierData *md)
73{
74 DisplaceModifierData *dmd = reinterpret_cast<DisplaceModifierData *>(md);
75
76 if (dmd->texture) {
78 }
79
80 return false;
81}
82
83static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
84{
85 DisplaceModifierData *dmd = reinterpret_cast<DisplaceModifierData *>(md);
86
87 walk(user_data, ob, reinterpret_cast<ID **>(&dmd->texture), IDWALK_CB_USER);
88 walk(user_data, ob, reinterpret_cast<ID **>(&dmd->map_object), IDWALK_CB_NOP);
89}
90
91static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
92{
93 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_Modifier, md);
94 PropertyRNA *prop = RNA_struct_find_property(&ptr, "texture");
95 walk(user_data, ob, md, &ptr, prop);
96}
97
98static bool is_disabled(const Scene * /*scene*/, ModifierData *md, bool /*use_render_params*/)
99{
100 DisplaceModifierData *dmd = reinterpret_cast<DisplaceModifierData *>(md);
101 return ((!dmd->texture && dmd->direction == MOD_DISP_DIR_RGB_XYZ) || dmd->strength == 0.0f);
102}
103
105{
106 DisplaceModifierData *dmd = reinterpret_cast<DisplaceModifierData *>(md);
107 bool need_transform_relation = false;
108
109 if (dmd->space == MOD_DISP_SPACE_GLOBAL &&
111 {
112 need_transform_relation = true;
113 }
114
115 if (dmd->texture != nullptr) {
116 DEG_add_generic_id_relation(ctx->node, &dmd->texture->id, "Displace Modifier");
117
118 if (dmd->map_object != nullptr && dmd->texmapping == MOD_DISP_MAP_OBJECT) {
120 ctx->node, dmd->map_object, dmd->map_bone, "Displace Modifier");
121 need_transform_relation = true;
122 }
123 if (dmd->texmapping == MOD_DISP_MAP_GLOBAL) {
124 need_transform_relation = true;
125 }
126 }
127
128 if (need_transform_relation) {
129 DEG_add_depends_on_transform_relation(ctx->node, "Displace Modifier");
130 }
131}
132
148
149static void displaceModifier_do_task(void *__restrict userdata,
150 const int iter,
151 const TaskParallelTLS *__restrict /*tls*/)
152{
153 DisplaceUserdata *data = static_cast<DisplaceUserdata *>(userdata);
154 DisplaceModifierData *dmd = data->dmd;
155 const MDeformVert *dvert = data->dvert;
156 const bool invert_vgroup = (dmd->flag & MOD_DISP_INVERT_VGROUP) != 0;
157 float weight = data->weight;
158 int defgrp_index = data->defgrp_index;
159 int direction = data->direction;
160 bool use_global_direction = data->use_global_direction;
161 float (*tex_co)[3] = data->tex_co;
162 MutableSpan<float3> positions = data->positions;
163
164 /* When no texture is used, we fall back to white. */
165 const float delta_fixed = 1.0f - dmd->midlevel;
166
167 TexResult texres;
168 float strength = dmd->strength;
169 float delta;
170 float local_vec[3];
171
172 if (dvert) {
173 weight = invert_vgroup ? 1.0f - BKE_defvert_find_weight(dvert + iter, defgrp_index) :
174 BKE_defvert_find_weight(dvert + iter, defgrp_index);
175 if (weight == 0.0f) {
176 return;
177 }
178 }
179
180 if (data->tex_target) {
181 BKE_texture_get_value_ex(data->tex_target, tex_co[iter], &texres, data->pool, false);
182 delta = texres.tin - dmd->midlevel;
183 }
184 else {
185 delta = delta_fixed; /* (1.0f - dmd->midlevel) */ /* never changes */
186 }
187
188 if (dvert) {
189 strength *= weight;
190 }
191
192 delta *= strength;
193 CLAMP(delta, -10000, 10000);
194
195 switch (direction) {
196 case MOD_DISP_DIR_X:
197 if (use_global_direction) {
198 positions[iter][0] += delta * data->local_mat[0][0];
199 positions[iter][1] += delta * data->local_mat[1][0];
200 positions[iter][2] += delta * data->local_mat[2][0];
201 }
202 else {
203 positions[iter][0] += delta;
204 }
205 break;
206 case MOD_DISP_DIR_Y:
207 if (use_global_direction) {
208 positions[iter][0] += delta * data->local_mat[0][1];
209 positions[iter][1] += delta * data->local_mat[1][1];
210 positions[iter][2] += delta * data->local_mat[2][1];
211 }
212 else {
213 positions[iter][1] += delta;
214 }
215 break;
216 case MOD_DISP_DIR_Z:
217 if (use_global_direction) {
218 positions[iter][0] += delta * data->local_mat[0][2];
219 positions[iter][1] += delta * data->local_mat[1][2];
220 positions[iter][2] += delta * data->local_mat[2][2];
221 }
222 else {
223 positions[iter][2] += delta;
224 }
225 break;
227 local_vec[0] = texres.trgba[0] - dmd->midlevel;
228 local_vec[1] = texres.trgba[1] - dmd->midlevel;
229 local_vec[2] = texres.trgba[2] - dmd->midlevel;
230 if (use_global_direction) {
231 mul_transposed_mat3_m4_v3(data->local_mat, local_vec);
232 }
233 mul_v3_fl(local_vec, strength);
234 add_v3_v3(positions[iter], local_vec);
235 break;
236 case MOD_DISP_DIR_NOR:
238 madd_v3_v3fl(positions[iter], data->vert_normals[iter], delta);
239 break;
240 }
241}
242
244 const ModifierEvalContext *ctx,
245 Mesh *mesh,
246 MutableSpan<float3> positions)
247{
248 Object *ob = ctx->object;
249 const MDeformVert *dvert;
250 int direction = dmd->direction;
251 int defgrp_index;
252 float (*tex_co)[3];
253 float weight = 1.0f; /* init value unused but some compilers may complain */
254 const bool use_global_direction = dmd->space == MOD_DISP_SPACE_GLOBAL;
255
256 if (dmd->texture == nullptr && dmd->direction == MOD_DISP_DIR_RGB_XYZ) {
257 return;
258 }
259 if (dmd->strength == 0.0f) {
260 return;
261 }
262
263 MOD_get_vgroup(ob, mesh, dmd->defgrp_name, &dvert, &defgrp_index);
264
265 if (defgrp_index >= 0 && dvert == nullptr) {
266 /* There is a vertex group, but it has no vertices. */
267 return;
268 }
269
270 Tex *tex_target = dmd->texture;
271 if (tex_target != nullptr) {
272 tex_co = MEM_new_array_zeroed<float[3]>(positions.size(), "displaceModifier_do tex_co");
273 MOD_get_texture_coords(reinterpret_cast<MappingInfoModifierData *>(dmd),
274 ctx,
275 ob,
276 mesh,
277 reinterpret_cast<float (*)[3]>(positions.data()),
278 tex_co);
279
280 MOD_init_texture(reinterpret_cast<MappingInfoModifierData *>(dmd), ctx);
281 }
282 else {
283 tex_co = nullptr;
284 }
285
286 DisplaceUserdata data = {nullptr};
288 data.dmd = dmd;
289 data.dvert = dvert;
290 data.weight = weight;
291 data.defgrp_index = defgrp_index;
292 data.direction = direction;
293 data.use_global_direction = use_global_direction;
294 data.tex_target = tex_target;
295 data.tex_co = tex_co;
296 data.positions = positions;
297 if (direction == MOD_DISP_DIR_NOR) {
298 data.vert_normals = mesh->vert_normals_true();
299 }
300 else if (direction == MOD_DISP_DIR_CLNOR) {
301 data.vert_normals = mesh->vert_normals();
302 }
304 use_global_direction)
305 {
306 copy_m4_m4(data.local_mat, ob->object_to_world().ptr());
307 }
308 if (tex_target != nullptr) {
309 data.pool = BKE_image_pool_new();
310 BKE_texture_fetch_images_for_pool(tex_target, data.pool);
311 }
312 TaskParallelSettings settings;
314 settings.use_threading = (positions.size() > 512);
315 BLI_task_parallel_range(0, positions.size(), &data, displaceModifier_do_task, &settings);
316
317 if (data.pool != nullptr) {
319 }
320
321 if (tex_co) {
322 MEM_delete(tex_co);
323 }
324}
325
327 const ModifierEvalContext *ctx,
328 Mesh *mesh,
329 MutableSpan<float3> positions)
330{
331 displaceModifier_do(reinterpret_cast<DisplaceModifierData *>(md), ctx, mesh, positions);
332}
333
334static void panel_draw(const bContext *C, Panel *panel)
335{
336 ui::Layout &layout = *panel->layout;
337
338 PointerRNA ob_ptr;
340
341 PointerRNA obj_data_ptr = RNA_pointer_get(&ob_ptr, "data");
342
343 PointerRNA texture_ptr = RNA_pointer_get(ptr, "texture");
344 bool has_texture = texture_ptr.has_data();
345 int texture_coords = RNA_enum_get(ptr, "texture_coords");
346
347 layout.use_property_split_set(true);
348
349 template_id(&layout, C, ptr, "texture", "texture.new", nullptr, nullptr);
350
351 ui::Layout *col = &layout.column(false);
352 col->active_set(has_texture);
353 col->prop(ptr, "texture_coords", UI_ITEM_NONE, IFACE_("Coordinates"), ICON_NONE);
354 if (texture_coords == MOD_DISP_MAP_OBJECT) {
355 col->prop(ptr, "texture_coords_object", UI_ITEM_NONE, IFACE_("Object"), ICON_NONE);
356 PointerRNA texture_coords_obj_ptr = RNA_pointer_get(ptr, "texture_coords_object");
357 if (texture_coords_obj_ptr && (RNA_enum_get(&texture_coords_obj_ptr, "type") == OB_ARMATURE)) {
358 PointerRNA texture_coords_obj_data_ptr = RNA_pointer_get(&texture_coords_obj_ptr, "data");
359 col->prop_search(ptr,
360 "texture_coords_bone",
361 &texture_coords_obj_data_ptr,
362 "bones",
363 IFACE_("Bone"),
364 ICON_NONE);
365 }
366 }
367 else if (texture_coords == MOD_DISP_MAP_UV && RNA_enum_get(&ob_ptr, "type") == OB_MESH) {
368 col->prop_search(ptr, "uv_layer", &obj_data_ptr, "uv_layers", std::nullopt, ICON_GROUP_UVS);
369 }
370
371 layout.separator();
372
373 col = &layout.column(false);
374 col->prop(ptr, "direction", UI_ITEM_NONE, std::nullopt, ICON_NONE);
375 if (ELEM(RNA_enum_get(ptr, "direction"),
380 {
381 col->prop(ptr, "space", UI_ITEM_NONE, std::nullopt, ICON_NONE);
382 }
383
384 layout.separator();
385
386 col = &layout.column(false);
387 col->prop(ptr, "strength", UI_ITEM_NONE, std::nullopt, ICON_NONE);
388 col->prop(ptr, "mid_level", UI_ITEM_NONE, std::nullopt, ICON_NONE);
389
390 modifier_vgroup_ui(*col, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
391
392 modifier_error_message_draw(layout, ptr);
393}
394
395static void panel_register(ARegionType *region_type)
396{
398}
399
401 /*idname*/ "Displace",
402 /*name*/ N_("Displace"),
403 /*struct_name*/ "DisplaceModifierData",
404 /*struct_size*/ sizeof(DisplaceModifierData),
405 /*srna*/ &RNA_DisplaceModifier,
408 /*icon*/ ICON_MOD_DISPLACE,
409
410 /*copy_data*/ BKE_modifier_copydata_generic,
411
412 /*deform_verts*/ deform_verts,
413 /*deform_matrices*/ nullptr,
414 /*deform_verts_EM*/ nullptr,
415 /*deform_matrices_EM*/ nullptr,
416 /*modify_mesh*/ nullptr,
417 /*modify_geometry_set*/ nullptr,
418
419 /*init_data*/ init_data,
420 /*required_data_mask*/ required_data_mask,
421 /*free_data*/ nullptr,
422 /*is_disabled*/ is_disabled,
423 /*update_depsgraph*/ update_depsgraph,
424 /*depends_on_time*/ depends_on_time,
425 /*depends_on_normals*/ nullptr,
426 /*foreach_ID_link*/ foreach_ID_link,
427 /*foreach_tex_link*/ foreach_tex_link,
428 /*free_runtime_data*/ nullptr,
429 /*panel_register*/ panel_register,
430 /*blend_write*/ nullptr,
431 /*blend_read*/ nullptr,
432 /*foreach_cache*/ nullptr,
433 /*foreach_working_space_color*/ nullptr,
434};
435
436} // namespace blender
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 C
Definition RandGen.cpp:29
#define UI_ITEM_NONE
#define CLAMP(a, b, c)
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define ELEM(...)
#define CD_MASK_MDEFORMVERT
#define CD_MASK_MTFACE
constexpr int64_t size() const
Definition BLI_span.hh:499
constexpr T * data() const
Definition BLI_span.hh:545
BMesh Iterators.
int RNA_enum_get(PointerRNA *ptr, const char *name)
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
PropertyRNA * RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
void DEG_add_generic_id_relation(DepsNodeHandle *node_handle, ID *id, const char *description)
BLI_INLINE void BLI_parallel_range_settings_defaults(TaskParallelSettings *settings)
static bool depends_on_time(Scene *, ModifierData *)
Definition MOD_build.cc:46
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)
void BKE_texture_get_value_ex(struct Tex *texture, const float *tex_co, struct TexResult *texres, struct ImagePool *pool, bool use_color_management)
Definition texture.cc:618
static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
void MOD_init_texture(MappingInfoModifierData *dmd, const ModifierEvalContext *ctx)
Definition MOD_util.cc:38
void BLI_task_parallel_range(int start, int stop, void *userdata, TaskParallelRangeFunc func, const TaskParallelSettings *settings)
void BKE_texture_fetch_images_for_pool(struct Tex *texture, struct ImagePool *pool)
Definition texture.cc:663
void DEG_add_depends_on_transform_relation(DepsNodeHandle *node_handle, const char *description)
MINLINE void mul_v3_fl(float r[3], float f)
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
MINLINE void madd_v3_v3fl(float r[3], const float a[3], float f)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
float BKE_defvert_find_weight(const MDeformVert *dvert, int defgroup)
Definition deform.cc:779
static void displaceModifier_do(DisplaceModifierData *dmd, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
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)
void MOD_depsgraph_update_object_bone_relation(DepsNodeHandle *node, Object *object, const char *bonename, const char *description)
Definition MOD_util.cc:188
BMesh const char void * data
static void panel_register(ARegionType *region_type)
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
void BKE_image_pool_free(ImagePool *pool)
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsMesh
PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
MINLINE void add_v3_v3(float r[3], const float a[3])
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
ModifierTypeInfo modifierType_Displace
static void panel_draw(const bContext *, Panel *panel)
static void deform_verts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
static void displaceModifier_do_task(void *__restrict userdata, const int iter, const TaskParallelTLS *__restrict)
void copy_m4_m4(float m1[4][4], const float m2[4][4])
void MOD_get_texture_coords(MappingInfoModifierData *dmd, const ModifierEvalContext *, Object *ob, Mesh *mesh, float(*cos)[3], float(*r_texco)[3])
Definition MOD_util.cc:51
static bool is_disabled(const Scene *, ModifierData *md, bool)
bool BKE_texture_dependsOnTime(const struct Tex *texture)
Scene * DEG_get_evaluated_scene(const Depsgraph *graph)
void(*)(void *user_data, Object *ob, ModifierData *md, const PointerRNA *ptr, PropertyRNA *texture_prop) TexWalkFunc
void * MEM_new_array_zeroed(size_t len, size_t size, const char *str) ATTR_WARN_UNUSED_RESULT ATTR_ALLOC_SIZE(1
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
void mul_transposed_mat3_m4_v3(const float M[4][4], float r[3])
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
DisplaceModifierTexMapping texmapping
DisplaceModifierDirection direction
DisplaceModifierData * dmd
const MDeformVert * dvert
MutableSpan< float3 > positions
ui::Layout * layout
bool has_data() const
Definition RNA_types.hh:169
void prop_search(PointerRNA *ptr, PropertyRNA *prop, PointerRNA *searchptr, PropertyRNA *searchprop, PropertyRNA *item_searchpropname, std::optional< StringRefNull > name, int icon, bool results_are_suggestions)
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)
void separator(float factor=1.0f, LayoutSeparatorType type=LayoutSeparatorType::Auto)
#define N_(msgid)