Blender V5.3
MOD_wave.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
10#include "BLI_utildefines.hh"
11
12#include "BLT_translation.hh"
13
14#include "DNA_mesh_types.h"
15#include "DNA_meshdata_types.h"
16#include "DNA_object_types.h"
17#include "DNA_screen_types.h"
18#include "DNA_texture_types.h"
19
20#include "BKE_deform.hh"
21#include "BKE_editmesh.hh"
22#include "BKE_lib_query.hh"
23#include "BKE_texture.h"
24
25#include "UI_interface.hh"
27#include "UI_resources.hh"
28
29#include "RNA_access.hh"
30#include "RNA_prototypes.hh"
31
32#include "MEM_guardedalloc.h"
33
34#include "RE_texture.h"
35
36#include "MOD_modifiertypes.hh"
37#include "MOD_ui_common.hh"
38#include "MOD_util.hh"
39
40#include "DEG_depsgraph.hh"
42
43namespace blender {
44
45static void init_data(ModifierData *md)
46{
47 WaveModifierData *wmd = reinterpret_cast<WaveModifierData *>(md);
49}
50
51static bool depends_on_time(Scene * /*scene*/, ModifierData * /*md*/)
52{
53 return true;
54}
55
56static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
57{
58 WaveModifierData *wmd = reinterpret_cast<WaveModifierData *>(md);
59
60 walk(user_data, ob, reinterpret_cast<ID **>(&wmd->texture), IDWALK_CB_USER);
61 walk(user_data, ob, reinterpret_cast<ID **>(&wmd->objectcenter), IDWALK_CB_NOP);
62 walk(user_data, ob, reinterpret_cast<ID **>(&wmd->map_object), IDWALK_CB_NOP);
63}
64
65static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
66{
67 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_Modifier, md);
68 PropertyRNA *prop = RNA_struct_find_property(&ptr, "texture");
69 walk(user_data, ob, md, &ptr, prop);
70}
71
73{
74 WaveModifierData *wmd = reinterpret_cast<WaveModifierData *>(md);
75 bool need_transform_relation = false;
76
77 if (wmd->objectcenter != nullptr) {
79 need_transform_relation = true;
80 }
81
82 if (wmd->texture != nullptr) {
83 DEG_add_generic_id_relation(ctx->node, &wmd->texture->id, "Wave Modifier");
84
85 if ((wmd->texmapping == MOD_DISP_MAP_OBJECT) && wmd->map_object != nullptr) {
87 ctx->node, wmd->map_object, wmd->map_bone, "Wave Modifier");
88 need_transform_relation = true;
89 }
90 else if (wmd->texmapping == MOD_DISP_MAP_GLOBAL) {
91 need_transform_relation = true;
92 }
93 }
94
95 if (need_transform_relation) {
96 DEG_add_depends_on_transform_relation(ctx->node, "Wave Modifier");
97 }
98}
99
100static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
101{
102 WaveModifierData *wmd = reinterpret_cast<WaveModifierData *>(md);
103
104 /* ask for UV coordinates if we need them */
105 if (wmd->texture && wmd->texmapping == MOD_DISP_MAP_UV) {
106 r_cddata_masks->fmask |= CD_MASK_MTFACE;
107 }
108
109 /* Ask for vertex-groups if we need them. */
110 if (wmd->defgrp_name[0] != '\0') {
111 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
112 }
113}
114
116 const ModifierEvalContext *ctx,
117 Object *ob,
118 Mesh *mesh,
119 float (*vertexCos)[3],
120 int verts_num)
121{
122 const MDeformVert *dvert;
123 int defgrp_index;
124 float ctime = DEG_get_ctime(ctx->depsgraph);
125 float minfac = float(1.0 / exp(wmd->width * wmd->narrow * wmd->width * wmd->narrow));
126 float lifefac = wmd->height;
127 float (*tex_co)[3] = nullptr;
128 const int wmd_axis = wmd->flag & (MOD_WAVE_X | MOD_WAVE_Y);
129 const float falloff = wmd->falloff;
130 float falloff_fac = 1.0f; /* when falloff == 0.0f this stays at 1.0f */
131 const bool invert_group = (wmd->flag & MOD_WAVE_INVERT_VGROUP) != 0;
132
133 Span<float3> vert_normals;
134 if ((wmd->flag & MOD_WAVE_NORM) && (mesh != nullptr)) {
135 vert_normals = mesh->vert_normals();
136 }
137
138 if (wmd->objectcenter != nullptr) {
139 float mat[4][4];
140 /* get the control object's location in local coordinates */
141 invert_m4_m4(ob->runtime->world_to_object.ptr(), ob->object_to_world().ptr());
142 mul_m4_m4m4(mat, ob->world_to_object().ptr(), wmd->objectcenter->object_to_world().ptr());
143
144 wmd->startx = mat[3][0];
145 wmd->starty = mat[3][1];
146 }
147
148 /* get the index of the deform group */
149 MOD_get_vgroup(ob, mesh, wmd->defgrp_name, &dvert, &defgrp_index);
150
151 if (wmd->damp == 0.0f) {
152 wmd->damp = 10.0f;
153 }
154
155 if (wmd->lifetime != 0.0f) {
156 float x = ctime - wmd->timeoffs;
157
158 if (x > wmd->lifetime) {
159 lifefac = x - wmd->lifetime;
160
161 if (lifefac > wmd->damp) {
162 lifefac = 0.0;
163 }
164 else {
165 lifefac = (wmd->height * (1.0f - sqrtf(lifefac / wmd->damp)));
166 }
167 }
168 }
169
170 Tex *tex_target = wmd->texture;
171 if (mesh != nullptr && tex_target != nullptr) {
172 tex_co = MEM_new_array_zeroed<float[3]>(size_t(verts_num), __func__);
174 reinterpret_cast<MappingInfoModifierData *>(wmd), ctx, ob, mesh, vertexCos, tex_co);
175
176 MOD_init_texture(reinterpret_cast<MappingInfoModifierData *>(wmd), ctx);
177 }
178
179 if (lifefac != 0.0f) {
180 /* avoid divide by zero checks within the loop */
181 float falloff_inv = falloff != 0.0f ? 1.0f / falloff : 1.0f;
182 int i;
183
184 for (i = 0; i < verts_num; i++) {
185 float *co = vertexCos[i];
186 float x = co[0] - wmd->startx;
187 float y = co[1] - wmd->starty;
188 float amplit = 0.0f;
189 float def_weight = 1.0f;
190
191 /* get weights */
192 if (dvert) {
193 def_weight = invert_group ? 1.0f - BKE_defvert_find_weight(&dvert[i], defgrp_index) :
194 BKE_defvert_find_weight(&dvert[i], defgrp_index);
195
196 /* if this vert isn't in the vgroup, don't deform it */
197 if (def_weight == 0.0f) {
198 continue;
199 }
200 }
201
202 switch (wmd_axis) {
203 case MOD_WAVE_X | MOD_WAVE_Y:
204 amplit = sqrtf(x * x + y * y);
205 break;
206 case MOD_WAVE_X:
207 amplit = x;
208 break;
209 case MOD_WAVE_Y:
210 amplit = y;
211 break;
212 }
213
214 /* this way it makes nice circles */
215 amplit -= (ctime - wmd->timeoffs) * wmd->speed;
216
217 if (wmd->flag & MOD_WAVE_CYCL) {
218 amplit = fmodf(amplit - wmd->width, 2.0f * wmd->width) + wmd->width;
219 }
220
221 if (falloff != 0.0f) {
222 float dist = 0.0f;
223
224 switch (wmd_axis) {
225 case MOD_WAVE_X | MOD_WAVE_Y:
226 dist = sqrtf(x * x + y * y);
227 break;
228 case MOD_WAVE_X:
229 dist = fabsf(x);
230 break;
231 case MOD_WAVE_Y:
232 dist = fabsf(y);
233 break;
234 }
235
236 falloff_fac = (1.0f - (dist * falloff_inv));
237 CLAMP(falloff_fac, 0.0f, 1.0f);
238 }
239
240 /* GAUSSIAN */
241 if ((falloff_fac != 0.0f) && (amplit > -wmd->width) && (amplit < wmd->width)) {
242 amplit = amplit * wmd->narrow;
243 amplit = (1.0f / expf(amplit * amplit) - minfac);
244
245 /* Apply texture. */
246 if (tex_co) {
247 TexResult texres;
248 BKE_texture_get_value(tex_target, tex_co[i], &texres, false);
249 amplit *= texres.tin;
250 }
251
252 /* Apply weight & falloff. */
253 amplit *= def_weight * falloff_fac;
254
255 if (!vert_normals.is_empty()) {
256 /* move along normals */
257 if (wmd->flag & MOD_WAVE_NORM_X) {
258 co[0] += (lifefac * amplit) * vert_normals[i][0];
259 }
260 if (wmd->flag & MOD_WAVE_NORM_Y) {
261 co[1] += (lifefac * amplit) * vert_normals[i][1];
262 }
263 if (wmd->flag & MOD_WAVE_NORM_Z) {
264 co[2] += (lifefac * amplit) * vert_normals[i][2];
265 }
266 }
267 else {
268 /* move along local z axis */
269 co[2] += lifefac * amplit;
270 }
271 }
272 }
273 }
274
275 MEM_SAFE_DELETE(tex_co);
276}
277
279 const ModifierEvalContext *ctx,
280 Mesh *mesh,
281 MutableSpan<float3> positions)
282{
283 WaveModifierData *wmd = reinterpret_cast<WaveModifierData *>(md);
284 waveModifier_do(wmd,
285 ctx,
286 ctx->object,
287 mesh,
288 reinterpret_cast<float (*)[3]>(positions.data()),
289 positions.size());
290}
291
292static void panel_draw(const bContext * /*C*/, Panel *panel)
293{
294 ui::Layout &layout = *panel->layout;
295
296 PointerRNA ob_ptr;
298
299 layout.use_property_split_set(true);
300
301 ui::Layout *row = &layout.row(true, IFACE_("Motion"));
302 row->prop(
303 ptr, "use_x", ui::ITEM_R_TOGGLE | ui::ITEM_R_FORCE_BLANK_DECORATE, std::nullopt, ICON_NONE);
304 row->prop(
305 ptr, "use_y", ui::ITEM_R_TOGGLE | ui::ITEM_R_FORCE_BLANK_DECORATE, std::nullopt, ICON_NONE);
306
307 layout.prop(ptr, "use_cyclic", UI_ITEM_NONE, std::nullopt, ICON_NONE);
308
309 row = &layout.row(true, IFACE_("Along Normals"));
310 row->prop(ptr, "use_normal", UI_ITEM_NONE, "", ICON_NONE);
311 ui::Layout &sub = row->row(true);
312 sub.active_set(RNA_boolean_get(ptr, "use_normal"));
313 sub.prop(ptr, "use_normal_x", ui::ITEM_R_TOGGLE, IFACE_("X"), ICON_NONE);
314 sub.prop(ptr, "use_normal_y", ui::ITEM_R_TOGGLE, IFACE_("Y"), ICON_NONE);
315 sub.prop(ptr, "use_normal_z", ui::ITEM_R_TOGGLE, IFACE_("Z"), ICON_NONE);
316
317 ui::Layout &col = layout.column(false);
318 col.prop(ptr, "falloff_radius", UI_ITEM_NONE, IFACE_("Falloff"), ICON_NONE);
319 col.prop(ptr, "height", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
320 col.prop(ptr, "width", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
321 col.prop(ptr, "narrowness", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
322
323 modifier_vgroup_ui(layout, ptr, &ob_ptr, "vertex_group", "invert_vertex_group", std::nullopt);
324
325 modifier_error_message_draw(layout, ptr);
326}
327
328static void position_panel_draw(const bContext * /*C*/, Panel *panel)
329{
330 ui::Layout &layout = *panel->layout;
331
333
334 layout.use_property_split_set(true);
335
336 layout.prop(ptr, "start_position_object", UI_ITEM_NONE, IFACE_("Object"), ICON_NONE);
337
338 ui::Layout &col = layout.column(true);
339 col.prop(ptr, "start_position_x", UI_ITEM_NONE, IFACE_("Start Position X"), ICON_NONE);
340 col.prop(ptr, "start_position_y", UI_ITEM_NONE, IFACE_("Y"), ICON_NONE);
341}
342
343static void time_panel_draw(const bContext * /*C*/, Panel *panel)
344{
345 ui::Layout &layout = *panel->layout;
346
348
349 layout.use_property_split_set(true);
350
351 ui::Layout &col = layout.column(false);
352 col.prop(ptr, "time_offset", UI_ITEM_NONE, IFACE_("Offset"), ICON_NONE);
353 col.prop(ptr, "lifetime", UI_ITEM_NONE, IFACE_("Life"), ICON_NONE);
354 col.prop(ptr, "damping_time", UI_ITEM_NONE, IFACE_("Damping"), ICON_NONE);
355 col.prop(ptr, "speed", ui::ITEM_R_SLIDER, std::nullopt, ICON_NONE);
356}
357
358static void texture_panel_draw(const bContext *C, Panel *panel)
359{
360 ui::Layout &layout = *panel->layout;
361
362 PointerRNA ob_ptr;
364
365 int texture_coords = RNA_enum_get(ptr, "texture_coords");
366
367 template_id(&layout, C, ptr, "texture", "texture.new", nullptr, nullptr);
368
369 layout.use_property_split_set(true);
370
371 ui::Layout &col = layout.column(false);
372 col.prop(ptr, "texture_coords", UI_ITEM_NONE, IFACE_("Coordinates"), ICON_NONE);
373 if (texture_coords == MOD_DISP_MAP_OBJECT) {
374 col.prop(ptr, "texture_coords_object", UI_ITEM_NONE, IFACE_("Object"), ICON_NONE);
375 PointerRNA texture_coords_obj_ptr = RNA_pointer_get(ptr, "texture_coords_object");
376 if (texture_coords_obj_ptr && (RNA_enum_get(&texture_coords_obj_ptr, "type") == OB_ARMATURE)) {
377 PointerRNA texture_coords_obj_data_ptr = RNA_pointer_get(&texture_coords_obj_ptr, "data");
378 col.prop_search(ptr,
379 "texture_coords_bone",
380 &texture_coords_obj_data_ptr,
381 "bones",
382 IFACE_("Bone"),
383 ICON_NONE);
384 }
385 }
386 else if (texture_coords == MOD_DISP_MAP_UV && RNA_enum_get(&ob_ptr, "type") == OB_MESH) {
387 PointerRNA obj_data_ptr = RNA_pointer_get(&ob_ptr, "data");
388 col.prop_search(ptr, "uv_layer", &obj_data_ptr, "uv_layers", std::nullopt, ICON_GROUP_UVS);
389 }
390}
391
392static void panel_register(ARegionType *region_type)
393{
396 region_type, "position", "Start Position", nullptr, position_panel_draw, panel_type);
397 modifier_subpanel_register(region_type, "time", "Time", nullptr, time_panel_draw, panel_type);
399 region_type, "texture", "Texture", nullptr, texture_panel_draw, panel_type);
400}
401
403 /*idname*/ "Wave",
404 /*name*/ N_("Wave"),
405 /*struct_name*/ "WaveModifierData",
406 /*struct_size*/ sizeof(WaveModifierData),
407 /*srna*/ &RNA_WaveModifier,
411 /*icon*/ ICON_MOD_WAVE,
412
413 /*copy_data*/ BKE_modifier_copydata_generic,
414
415 /*deform_verts*/ deform_verts,
416 /*deform_matrices*/ nullptr,
417 /*deform_verts_EM*/ nullptr,
418 /*deform_matrices_EM*/ nullptr,
419 /*modify_mesh*/ nullptr,
420 /*modify_geometry_set*/ nullptr,
421
422 /*init_data*/ init_data,
423 /*required_data_mask*/ required_data_mask,
424 /*free_data*/ nullptr,
425 /*is_disabled*/ nullptr,
426 /*update_depsgraph*/ update_depsgraph,
427 /*depends_on_time*/ depends_on_time,
428 /*depends_on_normals*/ nullptr,
429 /*foreach_ID_link*/ foreach_ID_link,
430 /*foreach_tex_link*/ foreach_tex_link,
431 /*free_runtime_data*/ nullptr,
432 /*panel_register*/ panel_register,
433 /*blend_write*/ nullptr,
434 /*blend_read*/ nullptr,
435 /*foreach_cache*/ nullptr,
436 /*foreach_working_space_color*/ nullptr,
437};
438
439} // 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 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
constexpr bool is_empty() const
Definition BLI_span.hh:264
#define expf(x)
#define fmodf(x, y)
#define exp
BMesh Iterators.
int RNA_enum_get(PointerRNA *ptr, const char *name)
static void texture_panel_draw(const bContext *C, Panel *panel)
Definition MOD_warp.cc:398
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)
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
bool invert_m4_m4(float inverse[4][4], const float mat[4][4])
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 mul_m4_m4m4(float R[4][4], const float A[4][4], const float B[4][4])
void MOD_init_texture(MappingInfoModifierData *dmd, const ModifierEvalContext *ctx)
Definition MOD_util.cc:38
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)
float BKE_defvert_find_weight(const MDeformVert *dvert, int defgroup)
Definition deform.cc:779
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 position_panel_draw(const bContext *, Panel *panel)
Definition MOD_wave.cc:328
void MOD_depsgraph_update_object_bone_relation(DepsNodeHandle *node, Object *object, const char *bonename, const char *description)
Definition MOD_util.cc:188
static void panel_register(ARegionType *region_type)
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
ModifierTypeInfo modifierType_Wave
Definition MOD_wave.cc:402
static void waveModifier_do(WaveModifierData *wmd, const ModifierEvalContext *ctx, Object *ob, Mesh *mesh, float(*vertexCos)[3], int verts_num)
Definition MOD_wave.cc:115
bool RNA_boolean_get(PointerRNA *ptr, const char *name)
@ eModifierTypeFlag_AcceptsCVs
@ eModifierTypeFlag_SupportsEditmode
@ eModifierTypeFlag_AcceptsVertexCosOnly
PointerRNA RNA_pointer_get(PointerRNA *ptr, const char *name)
void BKE_texture_get_value(struct Tex *texture, const float *tex_co, struct TexResult *texres, bool use_color_management)
Definition texture.cc:640
static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static void time_panel_draw(const bContext *, Panel *panel)
static void panel_draw(const bContext *, Panel *panel)
PanelType * modifier_subpanel_register(ARegionType *region_type, const char *name, const char *label, PanelDrawFn draw_header, PanelDrawFn draw, PanelType *parent)
static void deform_verts(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh, MutableSpan< float3 > positions)
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
void(*)(void *user_data, Object *ob, ModifierData *md, const PointerRNA *ptr, PropertyRNA *texture_prop) TexWalkFunc
float DEG_get_ctime(const Depsgraph *graph)
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)
#define fabsf
#define sqrtf
KERNEL_FEATURE_LIGHT_PASSES KERNEL_FEATURE_PATH_GUIDING float
const c_style_mat & ptr() const
bke::ObjectRuntime * runtime
ui::Layout * layout
DisplaceModifierTexMapping texmapping
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)
Layout & row(bool align)
#define N_(msgid)