Blender V5.3
MOD_fluid.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 <cstddef>
10
11#include "BLI_task_c.hh"
12
13#include "BLT_translation.hh"
14
15#include "DNA_fluid_types.h"
17#include "DNA_object_types.h"
18#include "DNA_screen_types.h"
19
20#include "BKE_fluid.h"
21#include "BKE_lib_query.hh"
22#include "BKE_modifier.hh"
23
24#include "RNA_access.hh"
25
27#include "UI_resources.hh"
28
29#include "RNA_prototypes.hh"
30
31#include "DEG_depsgraph.hh"
35
36#include "MOD_ui_common.hh"
37
38namespace blender {
39
40static void init_data(ModifierData *md)
41{
42 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
43
44 fmd->domain = nullptr;
45 fmd->flow = nullptr;
46 fmd->effector = nullptr;
47 fmd->type = FluidModifierType{};
48 fmd->time = -1;
49}
50
51static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
52{
53 const FluidModifierData *fmd = reinterpret_cast<const FluidModifierData *>(md);
54 FluidModifierData *tfmd = reinterpret_cast<FluidModifierData *>(target);
55
57 BKE_fluid_modifier_copy(fmd, tfmd, flag);
58}
59
60static void free_data(ModifierData *md)
61{
62 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
63
65}
66
67static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
68{
69 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
70
71 if (fmd && (fmd->type & MOD_FLUID_TYPE_FLOW) && fmd->flow) {
72 if (fmd->flow->source == FLUID_FLOW_SOURCE_MESH) {
73 /* vertex groups */
74 if (fmd->flow->vgroup_density) {
75 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
76 }
77 /* uv layer */
79 r_cddata_masks->fmask |= CD_MASK_MTFACE;
80 }
81 }
82 }
83}
84
93
94#ifdef WITH_FLUID
95static void fluid_modifier_do_isolated(void *userdata)
96{
97 FluidIsolationData *isolation_data = (FluidIsolationData *)userdata;
98
99 Scene *scene = DEG_get_evaluated_scene(isolation_data->depsgraph);
100
101 Mesh *result = BKE_fluid_modifier_do(isolation_data->fmd,
102 isolation_data->depsgraph,
103 scene,
104 isolation_data->object,
105 isolation_data->mesh);
106 isolation_data->result = result ? result : isolation_data->mesh;
107}
108#endif /* WITH_FLUID */
109
111{
112#ifndef WITH_FLUID
113 UNUSED_VARS(md, ctx);
114 return mesh;
115#else
117
118 if (ctx->flag & MOD_APPLY_ORCO) {
119 return mesh;
120 }
121
122 /* Isolate execution of Mantaflow when running from dependency graph. The reason for this is
123 * because Mantaflow uses TBB to parallel its own computation which without isolation will start
124 * stealing tasks from dependency graph. Stealing tasks from the dependency graph might cause
125 * a recursive lock when Python drivers are used (because Mantaflow is interfaced via Python as
126 * well). */
127 FluidIsolationData isolation_data;
128 isolation_data.depsgraph = ctx->depsgraph;
129 isolation_data.object = ctx->object;
130 isolation_data.mesh = mesh;
131 isolation_data.fmd = fmd;
132 BLI_task_isolate(fluid_modifier_do_isolated, &isolation_data);
133
134 return isolation_data.result;
135#endif /* WITH_FLUID */
136}
137
138static bool depends_on_time(Scene * /*scene*/, ModifierData * /*md*/)
139{
140 return true;
141}
142
143static bool is_flow_cb(Object * /*ob*/, ModifierData *md)
144{
145 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
146 return (fmd->type & MOD_FLUID_TYPE_FLOW) && fmd->flow;
147}
148
149static bool is_coll_cb(Object * /*ob*/, ModifierData *md)
150{
151 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
152 return (fmd->type & MOD_FLUID_TYPE_EFFEC) && fmd->effector;
153}
154
156{
157 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
158
159 if (fmd && (fmd->type & MOD_FLUID_TYPE_DOMAIN) && fmd->domain) {
161 ctx->object,
162 fmd->domain->fluid_group,
165 "Fluid Flow");
167 ctx->object,
171 "Fluid Effector");
173 ctx->object,
175 true,
177 "Fluid Force Field");
178
179 if (fmd->domain->guide_parent != nullptr) {
181 ctx->node, fmd->domain->guide_parent, DEG_OB_COMP_TRANSFORM, "Fluid Guiding Object");
183 ctx->node, fmd->domain->guide_parent, DEG_OB_COMP_GEOMETRY, "Fluid Guiding Object");
184 }
185 }
186}
187
188static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
189{
190 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
191
192 if (fmd->type == MOD_FLUID_TYPE_DOMAIN && fmd->domain) {
193 walk(user_data, ob, reinterpret_cast<ID **>(&fmd->domain->effector_group), IDWALK_CB_NOP);
194 walk(user_data, ob, reinterpret_cast<ID **>(&fmd->domain->fluid_group), IDWALK_CB_NOP);
195 walk(user_data, ob, reinterpret_cast<ID **>(&fmd->domain->force_group), IDWALK_CB_NOP);
196
197 if (fmd->domain->guide_parent) {
198 walk(user_data, ob, reinterpret_cast<ID **>(&fmd->domain->guide_parent), IDWALK_CB_NOP);
199 }
200
201 if (fmd->domain->effector_weights) {
202 walk(user_data,
203 ob,
204 reinterpret_cast<ID **>(&fmd->domain->effector_weights->group),
206 }
207 }
208
209 if (fmd->type == MOD_FLUID_TYPE_FLOW && fmd->flow) {
210 walk(user_data, ob, reinterpret_cast<ID **>(&fmd->flow->noise_texture), IDWALK_CB_USER);
211 }
212}
213
214static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
215{
216 FluidModifierData *fmd = reinterpret_cast<FluidModifierData *>(md);
217
218 if (fmd->type == MOD_FLUID_TYPE_FLOW && fmd->flow) {
219 PointerRNA ptr = RNA_pointer_create_discrete(&ob->id, RNA_FluidFlowSettings, fmd->flow);
220 PropertyRNA *prop = RNA_struct_find_property(&ptr, "noise_texture");
221
222 walk(user_data, ob, md, &ptr, prop);
223 }
224}
225
226static void panel_draw(const bContext * /*C*/, Panel *panel)
227{
228 ui::Layout &layout = *panel->layout;
229
231
232 layout.label(RPT_("Settings are inside the Physics tab"), ICON_NONE);
233
234 modifier_error_message_draw(layout, ptr);
235}
236
237static void panel_register(ARegionType *region_type)
238{
240}
241
243 /*idname*/ "Fluid",
244 /*name*/ N_("Fluid"),
245 /*struct_name*/ "FluidModifierData",
246 /*struct_size*/ sizeof(FluidModifierData),
247 /*srna*/ &RNA_FluidModifier,
250 /*icon*/ ICON_MOD_FLUIDSIM,
251
252 /*copy_data*/ copy_data,
253
254 /*deform_verts*/ nullptr,
255 /*deform_matrices*/ nullptr,
256 /*deform_verts_EM*/ nullptr,
257 /*deform_matrices_EM*/ nullptr,
258 /*modify_mesh*/ modify_mesh,
259 /*modify_geometry_set*/ nullptr,
260
261 /*init_data*/ init_data,
262 /*required_data_mask*/ required_data_mask,
263 /*free_data*/ free_data,
264 /*is_disabled*/ nullptr,
265 /*update_depsgraph*/ update_depsgraph,
266 /*depends_on_time*/ depends_on_time,
267 /*depends_on_normals*/ nullptr,
268 /*foreach_ID_link*/ foreach_ID_link,
269 /*foreach_tex_link*/ foreach_tex_link,
270 /*free_runtime_data*/ nullptr,
271 /*panel_register*/ panel_register,
272 /*blend_write*/ nullptr,
273 /*blend_read*/ nullptr,
274 /*foreach_cache*/ nullptr,
275 /*foreach_working_space_color*/ nullptr,
276};
277
278} // namespace blender
#define RPT_(msgid)
Object is a sort of wrapper for general info.
#define UNUSED_VARS(...)
#define CD_MASK_MDEFORMVERT
#define CD_MASK_MTFACE
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)
PropertyRNA * RNA_struct_find_property(PointerRNA *ptr, const char *identifier)
ModifierTypeInfo modifierType_Fluid
Definition MOD_fluid.cc:242
static bool depends_on_time(Scene *, ModifierData *)
Definition MOD_build.cc:46
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)
static bool is_flow_cb(Object *, ModifierData *md)
Definition MOD_fluid.cc:143
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void BKE_fluid_modifier_free(struct FluidModifierData *fmd)
Definition fluid.cc:4763
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
struct Mesh * BKE_fluid_modifier_do(struct FluidModifierData *fmd, struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, struct Mesh *mesh)
static void free_data(ModifierData *md)
Definition MOD_fluid.cc:60
static void panel_register(ARegionType *region_type)
void DEG_add_collision_relations(DepsNodeHandle *handle, Object *object, Collection *collection, unsigned int modifier_type, DEG_CollobjFilterFunction filter_function, const char *name)
PointerRNA RNA_pointer_create_discrete(ID *id, StructRNA *type, void *data)
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
@ eModifierTypeFlag_AcceptsMesh
@ eModifierTypeFlag_Single
static void foreach_tex_link(ModifierData *md, Object *ob, TexWalkFunc walk, void *user_data)
void BKE_fluid_modifier_copy(const struct FluidModifierData *fmd, struct FluidModifierData *tfmd, int flag)
void BLI_task_isolate(void(*func)(void *userdata), void *userdata)
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static void panel_draw(const bContext *, Panel *panel)
static bool is_coll_cb(Object *, ModifierData *md)
Definition MOD_fluid.cc:149
@ FLUID_FLOW_SOURCE_MESH
Scene * DEG_get_evaluated_scene(const Depsgraph *graph)
void(*)(void *user_data, Object *ob, ModifierData *md, const PointerRNA *ptr, PropertyRNA *texture_prop) TexWalkFunc
@ FLUID_FLOW_TEXTURE_MAP_UV
void DEG_add_forcefield_relations(DepsNodeHandle *handle, Object *object, EffectorWeights *eff, bool add_absorption, int skip_forcefield, const char *name)
struct EffectorWeights * effector_weights
struct Collection * effector_group
struct Collection * fluid_group
struct Collection * force_group
eFluidFlow_TextureType texture_type
FluidModifierData * fmd
Definition MOD_fluid.cc:89
struct FluidEffectorSettings * effector
struct FluidFlowSettings * flow
struct FluidDomainSettings * domain
ui::Layout * layout
void label(StringRef name, int icon)
#define N_(msgid)