Blender V5.3
MOD_dynamicpaint.cc
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstddef>
10#include <cstring>
11
12#include "BLI_listbase.hh"
13#include "BLI_utildefines.hh"
14
15#include "BLT_translation.hh"
16
19#include "DNA_object_types.h"
20#include "DNA_screen_types.h"
21
22#include "BKE_dynamicpaint.h"
23#include "BKE_lib_query.hh"
24#include "BKE_modifier.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 DynamicPaintModifierData *pmd = reinterpret_cast<DynamicPaintModifierData *>(md);
44}
45
46static void copy_data(const ModifierData *md, ModifierData *target, const int flag)
47{
48 const DynamicPaintModifierData *pmd = reinterpret_cast<const DynamicPaintModifierData *>(md);
49 DynamicPaintModifierData *tpmd = reinterpret_cast<DynamicPaintModifierData *>(target);
50
51 dynamicPaint_Modifier_copy(pmd, tpmd, flag);
52}
53
54static void free_runtime_data(void *runtime_data_v)
55{
56 if (runtime_data_v == nullptr) {
57 return;
58 }
59 DynamicPaintRuntime *runtime_data = static_cast<DynamicPaintRuntime *>(runtime_data_v);
61}
62
63static void free_data(ModifierData *md)
64{
65 DynamicPaintModifierData *pmd = reinterpret_cast<DynamicPaintModifierData *>(md);
67}
68
69static void required_data_mask(ModifierData *md, CustomData_MeshMasks *r_cddata_masks)
70{
71 DynamicPaintModifierData *pmd = reinterpret_cast<DynamicPaintModifierData *>(md);
72
73 if (pmd->canvas) {
74 DynamicPaintSurface *surface = pmd->canvas->surfaces.first();
75 for (; surface; surface = surface->next) {
76 /* UVs: #CD_PROP_FLOAT2. */
77 if (surface->format == MOD_DPAINT_SURFACE_F_IMAGESEQ ||
79 {
80 r_cddata_masks->lmask |= CD_MASK_PROP_FLOAT2;
81 }
82 /* Vertex Colors: #CD_PROP_BYTE_COLOR. */
83 if (surface->type == MOD_DPAINT_SURFACE_T_PAINT ||
85 {
86 r_cddata_masks->lmask |= CD_MASK_PROP_BYTE_COLOR;
87 }
88 /* Vertex Weights: #CD_MDEFORMVERT. */
89 if (surface->type == MOD_DPAINT_SURFACE_T_WEIGHT) {
90 r_cddata_masks->vmask |= CD_MASK_MDEFORMVERT;
91 }
92 }
93 }
94}
95
97{
98 DynamicPaintModifierData *pmd = reinterpret_cast<DynamicPaintModifierData *>(md);
99
100 /* Don't apply dynamic paint on ORCO mesh stack. */
101 if (!(ctx->flag & MOD_APPLY_ORCO)) {
103 return dynamicPaint_Modifier_do(pmd, ctx->depsgraph, scene, ctx->object, mesh);
104 }
105 return mesh;
106}
107
108static bool is_brush_cb(Object * /*ob*/, ModifierData *md)
109{
110 DynamicPaintModifierData *pmd = reinterpret_cast<DynamicPaintModifierData *>(md);
111 return (pmd->brush != nullptr && pmd->type == MOD_DYNAMICPAINT_TYPE_BRUSH);
112}
113
115{
116 DynamicPaintModifierData *pmd = reinterpret_cast<DynamicPaintModifierData *>(md);
117 /* Add relation from canvases to all brush objects. */
118 if (pmd->canvas != nullptr && pmd->type == MOD_DYNAMICPAINT_TYPE_CANVAS) {
119 for (DynamicPaintSurface &surface : pmd->canvas->surfaces) {
120 if (surface.effect & MOD_DPAINT_EFFECT_DO_DRIP) {
122 ctx->node, ctx->object, surface.effector_weights, true, 0, "Dynamic Paint Field");
123 }
124
125 /* Actual code uses custom loop over group/scene
126 * without layer checks in dynamicPaint_doStep. */
128 ctx->object,
129 surface.brush_group,
132 "Dynamic Paint Brush");
133 }
134 }
135}
136
137static bool depends_on_time(Scene * /*scene*/, ModifierData * /*md*/)
138{
139 return true;
140}
141
142static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
143{
144 DynamicPaintModifierData *pmd = reinterpret_cast<DynamicPaintModifierData *>(md);
145
146 if (pmd->canvas) {
147 DynamicPaintSurface *surface = pmd->canvas->surfaces.first();
148
149 for (; surface; surface = surface->next) {
150 walk(user_data, ob, reinterpret_cast<ID **>(&surface->brush_group), IDWALK_CB_NOP);
151 walk(user_data, ob, reinterpret_cast<ID **>(&surface->init_texture), IDWALK_CB_USER);
152 if (surface->effector_weights) {
153 walk(user_data,
154 ob,
155 reinterpret_cast<ID **>(&surface->effector_weights->group),
157 }
158 }
159 }
160}
161
162static void foreach_tex_link(ModifierData * /*md*/,
163 Object * /*ob*/,
164 TexWalkFunc /*walk*/,
165 void * /*user_data*/)
166{
167 // walk(user_data, ob, md, ""); /* re-enable when possible */
168}
169
170static void panel_draw(const bContext * /*C*/, Panel *panel)
171{
172 ui::Layout &layout = *panel->layout;
173
175
176 layout.label(RPT_("Settings are inside the Physics tab"), ICON_NONE);
177
178 modifier_error_message_draw(layout, ptr);
179}
180
181static void panel_register(ARegionType *region_type)
182{
184}
185
187 /*idname*/ "Dynamic Paint",
188 /*name*/ N_("Dynamic Paint"),
189 /*struct_name*/ "DynamicPaintModifierData",
190 /*struct_size*/ sizeof(DynamicPaintModifierData),
191 /*srna*/ &RNA_DynamicPaintModifier,
195 /*icon*/ ICON_MOD_DYNAMICPAINT,
196
197 /*copy_data*/ copy_data,
198
199 /*deform_verts*/ nullptr,
200 /*deform_matrices*/ nullptr,
201 /*deform_verts_EM*/ nullptr,
202 /*deform_matrices_EM*/ nullptr,
203 /*modify_mesh*/ modify_mesh,
204 /*modify_geometry_set*/ nullptr,
205
206 /*init_data*/ init_data,
207 /*required_data_mask*/ required_data_mask,
208 /*free_data*/ free_data,
209 /*is_disabled*/ nullptr,
210 /*update_depsgraph*/ update_depsgraph,
211 /*depends_on_time*/ depends_on_time,
212 /*depends_on_normals*/ nullptr,
213 /*foreach_ID_link*/ foreach_ID_link,
214 /*foreach_tex_link*/ foreach_tex_link,
215 /*free_runtime_data*/ free_runtime_data,
216 /*panel_register*/ panel_register,
217 /*blend_write*/ nullptr,
218 /*blend_read*/ nullptr,
219 /*foreach_cache*/ nullptr,
220 /*foreach_working_space_color*/ nullptr,
221};
222
223} // namespace blender
#define RPT_(msgid)
Object is a sort of wrapper for general info.
#define INIT_DEFAULT_STRUCT_AFTER(struct_dst, member)
#define CD_MASK_PROP_BYTE_COLOR
#define CD_MASK_MDEFORMVERT
#define CD_MASK_PROP_FLOAT2
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)
void dynamicPaint_Modifier_copy(const struct DynamicPaintModifierData *pmd, struct DynamicPaintModifierData *tpmd, int flag)
static bool depends_on_time(Scene *, ModifierData *)
Definition MOD_build.cc:46
void dynamicPaint_Modifier_free_runtime(struct DynamicPaintRuntime *runtime)
@ eModifierType_DynamicPaint
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)
static void required_data_mask(ModifierData *, CustomData_MeshMasks *r_cddata_masks)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
static void free_data(ModifierData *md)
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)
struct Mesh * dynamicPaint_Modifier_do(struct DynamicPaintModifierData *pmd, struct Depsgraph *depsgraph, struct Scene *scene, struct Object *ob, struct Mesh *mesh)
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
@ eModifierTypeFlag_SupportsMapping
@ eModifierTypeFlag_UsesPointCache
@ eModifierTypeFlag_AcceptsMesh
@ eModifierTypeFlag_Single
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 bool is_brush_cb(Object *, ModifierData *md)
static void panel_draw(const bContext *, Panel *panel)
static void free_runtime_data(void *runtime_data_v)
Scene * DEG_get_evaluated_scene(const Depsgraph *graph)
ModifierTypeInfo modifierType_DynamicPaint
void(*)(void *user_data, Object *ob, ModifierData *md, const PointerRNA *ptr, PropertyRNA *texture_prop) TexWalkFunc
void dynamicPaint_Modifier_free(struct DynamicPaintModifierData *pmd)
void DEG_add_forcefield_relations(DepsNodeHandle *handle, Object *object, EffectorWeights *eff, bool add_absorption, int skip_forcefield, const char *name)
ListBaseT< DynamicPaintSurface > surfaces
struct DynamicPaintBrushSettings * brush
struct DynamicPaintCanvasSettings * canvas
eDynamicPaint_EffectFlags effect
eDynamicPaint_SurfaceFormat format
struct EffectorWeights * effector_weights
eDynamicPaint_InitColorType init_color_type
struct DynamicPaintSurface * next
ui::Layout * layout
void label(StringRef name, int icon)
#define N_(msgid)