Blender V5.3
MOD_volume_to_mesh.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 "BKE_lib_query.hh"
10#include "BKE_mesh.hh"
11#include "BKE_modifier.hh"
12#include "BKE_volume.hh"
13#include "BKE_volume_grid.hh"
14#include "BKE_volume_to_mesh.hh"
15
16#include "BLT_translation.hh"
17
18#include "MOD_ui_common.hh"
19
20#include "DNA_modifier_types.h"
21#include "DNA_object_types.h"
22#include "DNA_screen_types.h"
23
25#include "UI_resources.hh"
26
27#include "RNA_prototypes.hh"
28#include "RNA_types.hh"
29
31#include "BLI_span.hh"
32#include "BLI_string.hh"
33
35
36#ifdef WITH_OPENVDB
37# include <openvdb/tools/GridTransformer.h>
38# include <openvdb/tools/VolumeToMesh.h>
39#endif
40
41namespace blender {
42
43static void init_data(ModifierData *md)
44{
45 VolumeToMeshModifierData *vmmd = reinterpret_cast<VolumeToMeshModifierData *>(md);
46 vmmd->object = nullptr;
47 vmmd->threshold = 0.1f;
48 STRNCPY(vmmd->grid_name, "density");
49 vmmd->adaptivity = 0.0f;
51 vmmd->voxel_amount = 32;
52 vmmd->voxel_size = 0.1f;
53 vmmd->flag = VolumeToMeshFlag{};
54}
55
57{
58 VolumeToMeshModifierData *vmmd = reinterpret_cast<VolumeToMeshModifierData *>(md);
59 DEG_add_depends_on_transform_relation(ctx->node, "Volume to Mesh Modifier");
60 if (vmmd->object) {
62 ctx->node, vmmd->object, DEG_OB_COMP_GEOMETRY, "Volume to Mesh Modifier");
64 ctx->node, vmmd->object, DEG_OB_COMP_TRANSFORM, "Volume to Mesh Modifier");
65 }
66}
67
68static void foreach_ID_link(ModifierData *md, Object *ob, IDWalkFunc walk, void *user_data)
69{
70 VolumeToMeshModifierData *vmmd = reinterpret_cast<VolumeToMeshModifierData *>(md);
71 walk(user_data, ob, reinterpret_cast<ID **>(&vmmd->object), IDWALK_CB_NOP);
72}
73
74static void panel_draw(const bContext * /*C*/, Panel *panel)
75{
76 ui::Layout &layout = *panel->layout;
77
79 VolumeToMeshModifierData *vmmd = static_cast<VolumeToMeshModifierData *>(ptr->data);
80
81 layout.use_property_split_set(true);
82
83 {
84 ui::Layout &col = layout.column(false);
85 col.prop(ptr, "object", UI_ITEM_NONE, std::nullopt, ICON_NONE);
86 col.prop(ptr, "grid_name", UI_ITEM_NONE, std::nullopt, ICON_NONE);
87 }
88
89 {
90 ui::Layout &col = layout.column(false);
91 col.prop(ptr, "resolution_mode", UI_ITEM_NONE, std::nullopt, ICON_NONE);
93 col.prop(ptr, "voxel_amount", UI_ITEM_NONE, std::nullopt, ICON_NONE);
94 }
96 col.prop(ptr, "voxel_size", UI_ITEM_NONE, std::nullopt, ICON_NONE);
97 }
98 }
99
100 {
101 ui::Layout &col = layout.column(false);
102 col.prop(ptr, "threshold", UI_ITEM_NONE, std::nullopt, ICON_NONE);
103 col.prop(ptr, "adaptivity", UI_ITEM_NONE, std::nullopt, ICON_NONE);
104 col.prop(ptr, "use_smooth_shade", UI_ITEM_NONE, std::nullopt, ICON_NONE);
105 }
106
107 modifier_error_message_draw(layout, ptr);
108}
109
110static void panel_register(ARegionType *region_type)
111{
113}
114
115static Mesh *create_empty_mesh(const Mesh *input_mesh)
116{
117 Mesh *new_mesh = BKE_mesh_new_nomain(0, 0, 0, 0);
118 BKE_mesh_copy_parameters_for_eval(new_mesh, input_mesh);
119 return new_mesh;
120}
121
122static Mesh *modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *input_mesh)
123{
124#ifdef WITH_OPENVDB
125 VolumeToMeshModifierData *vmmd = reinterpret_cast<VolumeToMeshModifierData *>(md);
126 if (vmmd->object == nullptr) {
127 return create_empty_mesh(input_mesh);
128 }
129 if (vmmd->object->type != OB_VOLUME) {
130 return create_empty_mesh(input_mesh);
131 }
133 vmmd->voxel_size == 0.0f)
134 {
135 return create_empty_mesh(input_mesh);
136 }
138 vmmd->voxel_amount == 0)
139 {
140 return create_empty_mesh(input_mesh);
141 }
142
143 const Volume *volume = id_cast<Volume *>(vmmd->object->data);
144
146 const bke::VolumeGridData *volume_grid = BKE_volume_grid_find(volume, vmmd->grid_name);
147 if (volume_grid == nullptr) {
148 BKE_modifier_set_error(ctx->object, md, "Cannot find '%s' grid", vmmd->grid_name);
149 return create_empty_mesh(input_mesh);
150 }
151
152 bke::VolumeTreeAccessToken tree_token;
153 const openvdb::GridBase &local_grid = volume_grid->grid(tree_token);
154
155 openvdb::math::Transform::Ptr transform = local_grid.transform().copy();
156 transform->postMult(openvdb::Mat4d(vmmd->object->object_to_world().base_ptr()));
157 openvdb::Mat4d imat = openvdb::Mat4d(ctx->object->world_to_object().base_ptr());
158 /* `imat` had floating point issues and wasn't affine. */
159 imat.setCol(3, openvdb::Vec4d(0, 0, 0, 1));
160 transform->postMult(imat);
161
162 /* Create a temporary transformed grid. The underlying tree is shared. */
163 openvdb::GridBase::ConstPtr transformed_grid = local_grid.copyGridReplacingTransform(transform);
164
168 resolution.settings.voxel_amount = vmmd->voxel_amount;
169 }
171 resolution.settings.voxel_size = vmmd->voxel_size;
172 }
173
174 Mesh *mesh = bke::volume_to_mesh(
175 *transformed_grid, resolution, vmmd->threshold, vmmd->adaptivity);
176 if (mesh == nullptr) {
177 BKE_modifier_set_error(ctx->object, md, "Could not generate mesh from grid");
178 return create_empty_mesh(input_mesh);
179 }
180
183 return mesh;
184#else
185 UNUSED_VARS(md);
186 BKE_modifier_set_error(ctx->object, md, "Compiled without OpenVDB");
187 return create_empty_mesh(input_mesh);
188#endif
189}
190
192 /*idname*/ "Volume to Mesh",
193 /*name*/ N_("Volume to Mesh"),
194 /*struct_name*/ "VolumeToMeshModifierData",
195 /*struct_size*/ sizeof(VolumeToMeshModifierData),
196 /*srna*/ &RNA_VolumeToMeshModifier,
199 /*icon*/ ICON_VOLUME_DATA, /* TODO: Use correct icon. */
200
201 /*copy_data*/ BKE_modifier_copydata_generic,
202
203 /*deform_verts*/ nullptr,
204 /*deform_matrices*/ nullptr,
205 /*deform_verts_EM*/ nullptr,
206 /*deform_matrices_EM*/ nullptr,
207 /*modify_mesh*/ modify_mesh,
208 /*modify_geometry_set*/ nullptr,
209
210 /*init_data*/ init_data,
211 /*required_data_mask*/ nullptr,
212 /*free_data*/ nullptr,
213 /*is_disabled*/ nullptr,
214 /*update_depsgraph*/ update_depsgraph,
215 /*depends_on_time*/ nullptr,
216 /*depends_on_normals*/ nullptr,
217 /*foreach_ID_link*/ foreach_ID_link,
218 /*foreach_tex_link*/ nullptr,
219 /*free_runtime_data*/ nullptr,
220 /*panel_register*/ panel_register,
221 /*blend_write*/ nullptr,
222 /*blend_read*/ nullptr,
223 /*foreach_cache*/ nullptr,
224 /*foreach_working_space_color*/ nullptr,
225};
226
227} // namespace blender
Volume data-block.
Object is a sort of wrapper for general info.
#define UI_ITEM_NONE
#define UNUSED_VARS(...)
void mesh_smooth_set(Mesh &mesh, bool use_smooth, bool keep_sharp_edges=false)
BMesh Iterators.
char * STRNCPY(char(&dst)[N], const char *src)
void BKE_modifier_set_error(const Object *ob, ModifierData *md, const char *format,...) ATTR_PRINTF_FORMAT(3
PointerRNA * modifier_panel_get_property_pointers(Panel *panel, PointerRNA *r_ob_ptr)
const bke::VolumeGridData * BKE_volume_grid_find(const Volume *volume, StringRef name)
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)
void modifier_error_message_draw(ui::Layout &layout, PointerRNA *ptr)
void BKE_mesh_copy_parameters_for_eval(Mesh *me_dst, const Mesh *me_src)
Main * DEG_get_bmain(const Depsgraph *graph)
@ VOLUME_TO_MESH_USE_SMOOTH_SHADE
static void panel_register(ARegionType *region_type)
Mesh * BKE_mesh_new_nomain(int verts_num, int edges_num, int faces_num, int corners_num)
bool BKE_volume_load(const Volume *volume, const Main *bmain)
ModifierTypeInfo modifierType_VolumeToMesh
static Mesh * modify_mesh(ModifierData *md, const ModifierEvalContext *ctx, Mesh *mesh)
Definition MOD_array.cc:873
@ eModifierTypeFlag_AcceptsMesh
@ VOLUME_TO_MESH_RESOLUTION_MODE_VOXEL_AMOUNT
@ VOLUME_TO_MESH_RESOLUTION_MODE_VOXEL_SIZE
@ VOLUME_TO_MESH_RESOLUTION_MODE_GRID
PanelType * modifier_panel_register(ARegionType *region_type, ModifierType type, PanelDrawFn draw)
static Mesh * create_empty_mesh(const Mesh *input_mesh)
static void panel_draw(const bContext *, Panel *panel)
void BKE_modifier_copydata_generic(const ModifierData *md, ModifierData *md_dst, int flag)
ui::Layout * layout
VolumeToMeshResolutionMode resolution_mode
union blender::bke::VolumeToMeshResolution::@031223152017106026267031022005313173146132011170 settings
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)
Layout & column(bool align)
#define N_(msgid)